az network application-gateway advanced-routing-map rule

Manage advanced routing rules of an advanced routing map.

Commands

Name	Description	Type	Status
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 rule create

Create an advanced routing rule.

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

Examples

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

az network application-gateway advanced-routing-map rule create -g MyResourceGroup --gateway-name MyAppGateway --map-name MyAdvancedRoutingMap -n MyAdvancedRoutingRule2 --priority 20 --condition-set MyConditionSet2 --address-pool MyAddressPool --http-settings MyHttpSettings

Create an advanced routing rule that redirects requests matching a condition set.

az network application-gateway advanced-routing-map rule create -g MyResourceGroup --gateway-name MyAppGateway --map-name MyAdvancedRoutingMap -n MyRedirectRule --priority 30 --condition-set MyConditionSet3 --redirect-config MyRedirectConfig

Required Parameters

--condition-set

Name or ID of the advanced routing condition set.

Property	Value
Parameter group:	Properties Arguments

--gateway-name

Name of the application gateway.

--map-name

Name of the advanced routing map.

--name -n

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

--priority

Priority of the advanced routing rule. Must be unique within the containing advanced routing map. Rules are evaluated in ascending priority order.

Property	Value
Parameter group:	Properties 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.

Property	Value
Parameter group:	Properties Arguments

--auth-configs

Authentication configuration bindings of the advanced routing rule. 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

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--http-settings

Name or ID of the HTTP settings.

Property	Value
Parameter group:	Properties 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.

Property	Value
Parameter group:	Properties Arguments

--rewrite-rule-set

Name or ID of the rewrite rule set.

Property	Value
Parameter group:	Properties 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 rule delete

Delete an advanced routing rule.

az network application-gateway advanced-routing-map rule delete --gateway-name
                                                                --map-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 rule.

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

Required Parameters

--gateway-name

Name of the application gateway.

--map-name

Name of the advanced routing map.

--name -n

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

--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 rule list

List advanced routing rules.

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

Examples

List advanced routing rules.

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

Required Parameters

--gateway-name

Name of the application gateway.

--map-name

Name of the advanced routing map.

--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 rule show

Get the details of an advanced routing rule.

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

Examples

Get the details of an advanced routing rule.

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

Required Parameters

--gateway-name

Name of the application gateway.

--map-name

Name of the advanced routing map.

--name -n

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

--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 rule update

Update an advanced routing rule.

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

Examples

Update the priority of an advanced routing rule.

az network application-gateway advanced-routing-map rule update -g MyResourceGroup --gateway-name MyAppGateway --map-name MyAdvancedRoutingMap -n MyAdvancedRoutingRule2 --priority 40

Required Parameters

--gateway-name

Name of the application gateway.

--map-name

Name of the advanced routing map.

--name -n

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

--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

--address-pool

Name or ID of the backend address pool.

Property	Value
Parameter group:	Properties Arguments

--auth-configs

Authentication configuration bindings of the advanced routing rule. 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

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--condition-set

Name or ID of the advanced routing condition 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

--http-settings

Name or ID of the HTTP settings.

Property	Value
Parameter group:	Properties 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

--priority

Priority of the advanced routing rule. Must be unique within the containing advanced routing map. Rules are evaluated in ascending priority order.

Property	Value
Parameter group:	Properties Arguments

--redirect-config

Name or ID of the redirect configuration.

Property	Value
Parameter group:	Properties Arguments

--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

--rewrite-rule-set

Name or ID of the rewrite rule set.

Property	Value
Parameter group:	Properties 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 rule wait

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

az network application-gateway advanced-routing-map rule 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