az network application-gateway advanced-routing-map

Manage advanced routing maps of an application gateway.

Commands

Name	Description	Type	Status
az network application-gateway advanced-routing-map create	Create an advanced routing map.	Core	GA
az network application-gateway advanced-routing-map delete	Delete an advanced routing map.	Core	GA
az network application-gateway advanced-routing-map list	List advanced routing maps.	Core	GA
az network application-gateway advanced-routing-map rule	Manage advanced routing rules of an advanced routing map.	Core	GA
az network application-gateway advanced-routing-map rule create	Create an advanced routing rule.	Core	GA
az network application-gateway advanced-routing-map rule delete	Delete an advanced routing rule.	Core	GA
az network application-gateway advanced-routing-map rule list	List advanced routing rules.	Core	GA
az network application-gateway advanced-routing-map rule show	Get the details of an advanced routing rule.	Core	GA
az network application-gateway advanced-routing-map rule update	Update an advanced routing rule.	Core	GA
az network application-gateway advanced-routing-map rule wait	Place the CLI in a waiting state until a condition is met.	Core	GA
az network application-gateway advanced-routing-map show	Get the details of an advanced routing map.	Core	GA
az network application-gateway advanced-routing-map update	Update an advanced routing map.	Core	GA
az network application-gateway advanced-routing-map wait	Place the CLI in a waiting state until a condition is met.	Core	GA

az network application-gateway advanced-routing-map create

Edit

Create an advanced routing map.

The map must be created with at least one rule. This command creates the first rule at the time the map is created.

az network application-gateway advanced-routing-map create --condition-set
                                                           --gateway-name
                                                           --name
                                                           --priority
                                                           --resource-group
                                                           [--acquire-policy-token]
                                                           [--address-pool]
                                                           [--change-reference]
                                                           [--default-address-pool]
                                                           [--default-auth-configs]
                                                           [--default-http-settings]
                                                           [--default-redirect-config]
                                                           [--default-rewrite-rule-set]
                                                           [--http-settings]
                                                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                           [--redirect-config]
                                                           [--rewrite-rule-set]
                                                           [--rule-name]

Examples

Create an advanced routing map whose first rule routes requests matching a condition set to a backend address pool.

az network application-gateway advanced-routing-map create -g MyResourceGroup --gateway-name MyAppGateway -n MyAdvancedRoutingMap --default-address-pool MyAddressPool --default-http-settings MyHttpSettings --rule-name MyAdvancedRoutingRule --priority 10 --condition-set MyConditionSet --address-pool MyCanaryAddressPool --http-settings MyHttpSettings

Required Parameters

--condition-set

Name or ID of the advanced routing condition set of the first rule.

Property	Value
Parameter group:	First Rule Arguments

--gateway-name

Name of the application gateway.

--name -n

Name of the advanced routing map that is unique within an Application Gateway.

--priority

Priority of the first advanced routing rule. Rules are evaluated in ascending priority order.

Property	Value
Parameter group:	First Rule Arguments

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--address-pool

Name or ID of the backend address pool of the first rule.

Property	Value
Parameter group:	First Rule Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--default-address-pool

Name or ID of the default backend address pool. Required unless --default-redirect-config is specified.

Property	Value
Parameter group:	Properties Arguments

--default-auth-configs

Default authentication configuration bindings of the advanced routing map. Only one authentication configuration is supported. Authentication configuration names must be unique across the Application Gateway, and an Application Gateway can reference at most 100 distinct authentication policies. Authentication policies can only be bound to Application Gateways using the Standard_v2 or WAF_v2 SKU. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--default-http-settings

Name or ID of the default HTTP settings. Required unless --default-redirect-config is specified.

Property	Value
Parameter group:	Properties Arguments

--default-redirect-config

Name or ID of the default redirect configuration.

Property	Value
Parameter group:	Properties Arguments

--default-rewrite-rule-set

Name or ID of the default rewrite rule set.

Property	Value
Parameter group:	Properties Arguments

--http-settings

Name or ID of the HTTP settings of the first rule.

Property	Value
Parameter group:	First Rule Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--redirect-config

Name or ID of the redirect configuration of the first rule.

Property	Value
Parameter group:	First Rule Arguments

--rewrite-rule-set

Name or ID of the rewrite rule set of the first rule.

Property	Value
Parameter group:	First Rule Arguments

--rule-name

Name of the first advanced routing rule.

Property	Value
Parameter group:	First Rule Arguments
Default value:	rule1

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az network application-gateway advanced-routing-map delete

Edit

Delete an advanced routing map.

az network application-gateway advanced-routing-map delete --gateway-name
                                                           --name
                                                           --resource-group
                                                           [--acquire-policy-token]
                                                           [--change-reference]
                                                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

Examples

Delete an advanced routing map.

az network application-gateway advanced-routing-map delete -g MyResourceGroup --gateway-name MyAppGateway -n MyAdvancedRoutingMap

Required Parameters

--gateway-name

Name of the application gateway.

--name -n

Name of the advanced routing map that is unique within an Application Gateway.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az network application-gateway advanced-routing-map list

Edit

List advanced routing maps.

az network application-gateway advanced-routing-map list --gateway-name
                                                         --resource-group

Examples

List advanced routing maps.

az network application-gateway advanced-routing-map list -g MyResourceGroup --gateway-name MyAppGateway

Required Parameters

--gateway-name

Name of the application gateway.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az network application-gateway advanced-routing-map show

Edit

Get the details of an advanced routing map.

az network application-gateway advanced-routing-map show --gateway-name
                                                         --name
                                                         --resource-group

Examples

Get the details of an advanced routing map.

az network application-gateway advanced-routing-map show -g MyResourceGroup --gateway-name MyAppGateway -n MyAdvancedRoutingMap

Required Parameters

--gateway-name

Name of the application gateway.

--name -n

Name of the advanced routing map that is unique within an Application Gateway.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az network application-gateway advanced-routing-map update

Edit

Update an advanced routing map.

az network application-gateway advanced-routing-map update --gateway-name
                                                           --name
                                                           --resource-group
                                                           [--acquire-policy-token]
                                                           [--add]
                                                           [--advanced-routing-rules]
                                                           [--change-reference]
                                                           [--default-address-pool]
                                                           [--default-auth-configs]
                                                           [--default-http-settings]
                                                           [--default-redirect-config]
                                                           [--default-rewrite-rule-set]
                                                           [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                           [--remove]
                                                           [--set]

Examples

Update the default backend address pool of an advanced routing map.

az network application-gateway advanced-routing-map update -g MyResourceGroup --gateway-name MyAppGateway -n MyAdvancedRoutingMap --default-address-pool MyNewAddressPool

Required Parameters

--gateway-name

Name of the application gateway.

--name -n

Name of the advanced routing map that is unique within an Application Gateway.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

Property	Value
Parameter group:	Generic Update Arguments

--advanced-routing-rules

Advanced routing rules of the advanced routing map. Each rule must specify a priority that is unique within the map. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--default-address-pool

Name or ID of the default backend address pool. Required unless --default-redirect-config is specified.

Property	Value
Parameter group:	Properties Arguments

--default-auth-configs

Property	Value
Parameter group:	Properties Arguments

--default-http-settings

Name or ID of the default HTTP settings. Required unless --default-redirect-config is specified.

Property	Value
Parameter group:	Properties Arguments

--default-redirect-config

Name or ID of the default redirect configuration.

Property	Value
Parameter group:	Properties Arguments

--default-rewrite-rule-set

Name or ID of the default rewrite rule set.

Property	Value
Parameter group:	Properties Arguments

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Property	Value
Parameter group:	Generic Update Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Property	Value
Parameter group:	Generic Update Arguments

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

Property	Value
Parameter group:	Generic Update Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az network application-gateway advanced-routing-map wait

Edit

Place the CLI in a waiting state until a condition is met.

az network application-gateway advanced-routing-map wait [--acquire-policy-token]
                                                         [--change-reference]
                                                         [--created]
                                                         [--custom]
                                                         [--deleted]
                                                         [--exists]
                                                         [--gateway-name]
                                                         [--ids]
                                                         [--interval]
                                                         [--resource-group]
                                                         [--subscription]
                                                         [--timeout]
                                                         [--updated]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Property	Value
Parameter group:	Wait Condition Arguments

--deleted

Wait until deleted.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--exists

Wait until the resource exists.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--gateway-name

Name of the application gateway.

Property	Value
Parameter group:	Resource Id Arguments

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	30

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

--timeout

Maximum wait in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

Feedback

Was this page helpful?