Share via

az network application-gateway routing-rule

Evaluate probe information and define TCP/TLS routing rules.

Commands

Name Description Type Status
az network application-gateway routing-rule create

Create a rule.

 Core GA
az network application-gateway routing-rule delete

Delete a rule.

 Core GA
az network application-gateway routing-rule list

List rules.

 Core GA
az network application-gateway routing-rule show

Get the details of a rule.

 Core GA
az network application-gateway routing-rule update

Update a rule.

 Core GA
az network application-gateway routing-rule wait

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

 Core GA

az network application-gateway routing-rule create

Edit

Create a rule.

Rules are executed in the order in which they are created.

az network application-gateway routing-rule create --gateway-name
                                                   --name
                                                   --resource-group
                                                   [--address-pool]
                                                   [--listener]
                                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                   [--priority]
                                                   [--rule-type {Basic, PathBasedRouting}]
                                                   [--settings]

Examples

Create a basic rule.

az network application-gateway routing-rule create -g MyResourceGroup --gateway-name MyAppGateway -n MyRule --listener MyBackendListener --rule-type Basic --address-pool MyAddressPool --settings MySettings

Required Parameters

--gateway-name

Name of the application gateway.

--name -n

Name of the routing rule.

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

--address-pool

Name or ID of the backend address pool. If only one exists, omit to use as default.

Property Value
Parameter group: Properties Arguments
--listener

Name or ID of the listener. If only one exists, omit to use as default.

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 routing rule. Supported SKU tiers are Standard_v2, WAF_v2.

--rule-type

Type of the routing rule.

Property Value
Default value: Basic
Accepted values: Basic, PathBasedRouting
--settings

Name or ID of the settings. If only one exists, omit to use as default.

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 routing-rule delete

Edit

Delete a rule.

az network application-gateway routing-rule delete --gateway-name
                                                   --name
                                                   --resource-group
                                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

Examples

Delete a rule.

az network application-gateway routing-rule delete -g MyResourceGroup --gateway-name MyAppGateway -n MyRule

Required Parameters

--gateway-name

Name of the application gateway.

--name -n

Name of the routing rule.

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

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

Edit

List rules.

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

Examples

List rules.

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

Edit

Get the details of a rule.

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

Examples

Get the details of a rule.

az network application-gateway routing-rule show -g MyResourceGroup --gateway-name MyAppGateway -n MyRule

Required Parameters

--gateway-name

Name of the application gateway.

--name -n

Name of the routing rule.

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

Edit

Update a rule.

az network application-gateway routing-rule update --gateway-name
                                                   --name
                                                   --resource-group
                                                   [--add]
                                                   [--address-pool]
                                                   [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                                   [--listener]
                                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                   [--priority]
                                                   [--remove]
                                                   [--rule-type {Basic, PathBasedRouting}]
                                                   [--set]
                                                   [--settings]

Examples

Update a rule use a new listener.

az network application-gateway routing-rule update -g MyResourceGroup --gateway-name MyAppGateway -n MyRule --listener MyNewBackendListener

Required Parameters

--gateway-name

Name of the application gateway.

--name -n

Name of the routing rule.

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

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

Name or ID of the listener.

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 routing rule. Supported SKU tiers are Standard_v2, WAF_v2.

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

Type of the routing rule.

Property Value
Accepted values: Basic, PathBasedRouting
--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
--settings

Name or ID of the settings.

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 routing-rule wait

Edit

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

az network application-gateway routing-rule wait [--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.

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