az network application-gateway rule

Is this page helpful?

Any additional feedback?

Feedback will be sent to Microsoft: By pressing the submit button, your feedback will be used to improve Microsoft products and services. Privacy policy.

Evaluate probe information and define routing rules.

For more information, visit, https://docs.microsoft.com/azure/application-gateway/application-gateway-customize-waf-rules-cli.

Commands

az network application-gateway rule create	Create a rule.
az network application-gateway rule delete	Delete a rule.
az network application-gateway rule list	List rules.
az network application-gateway rule show	Get the details of a rule.
az network application-gateway rule update	Update a rule.

az network application-gateway rule create

Create a rule.

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

az network application-gateway rule create --gateway-name
                                           --name
                                           --resource-group
                                           [--address-pool]
                                           [--http-listener]
                                           [--http-settings]
                                           [--no-wait]
                                           [--priority]
                                           [--redirect-config]
                                           [--rewrite-rule-set]
                                           [--rule-type]
                                           [--url-path-map]

Examples

Create a basic rule.

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

Required Parameters

--gateway-name

Name of the application gateway.

--name -n

The name of the request routing rule.

--resource-group -g

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

Optional Parameters

--address-pool

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

--http-listener

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

--http-settings

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

--no-wait

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

--priority

Priority of the request routing rule. Range from 1 to 2000.

--redirect-config

The name or ID of the redirect configuration to use with the created rule.

--rewrite-rule-set

The name or ID of the rewrite rule set.

--rule-type

The rule type (Basic, PathBasedRouting).

default value: Basic

--url-path-map

The name or ID of the URL path map.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

az network application-gateway rule delete

Delete a rule.

az network application-gateway rule delete [--gateway-name]
                                           [--ids]
                                           [--name]
                                           [--no-wait]
                                           [--resource-group]

Examples

Delete a rule.

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

Optional Parameters

--gateway-name

The name of the application gateway.

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

--name -n

The name of the request routing rule.

--no-wait

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

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

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

az network application-gateway rule list

List rules.

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

Examples

List rules.

az network application-gateway rule list -g MyResourceGroup --gateway-name MyAppGateway

Required Parameters

--gateway-name

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

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

az network application-gateway rule show

Get the details of a rule.

az network application-gateway rule show [--gateway-name]
                                         [--ids]
                                         [--name]
                                         [--resource-group]

Examples

Get the details of a rule.

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

Optional Parameters

--gateway-name

The name of the application gateway.

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

--name -n

The name of the request 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.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

az network application-gateway rule update

Update a rule.

az network application-gateway rule update [--add]
                                           [--address-pool]
                                           [--force-string]
                                           [--gateway-name]
                                           [--http-listener]
                                           [--http-settings]
                                           [--ids]
                                           [--name]
                                           [--no-wait]
                                           [--priority]
                                           [--redirect-config]
                                           [--remove]
                                           [--resource-group]
                                           [--rewrite-rule-set]
                                           [--rule-type]
                                           [--set]
                                           [--url-path-map]

Examples

Update a rule use a new HTTP listener.

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

Update a rule. (autogenerated)

az network application-gateway rule update --address-pool MyAddressPool --gateway-name MyAppGateway --name MyRule --resource-group MyResourceGroup

Optional Parameters

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

--address-pool

The name or ID of the backend address pool.

--force-string

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

--gateway-name

Name of the application gateway.

--http-listener

The name or ID of the HTTP listener.

--http-settings

The name or ID of the backend HTTP settings.

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

--name -n

The name of the request routing rule.

--no-wait

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

--priority

Priority of the request routing rule. Range from 1 to 2000.

--redirect-config

The name or ID of the redirect configuration to use with the created rule.

--remove

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

--resource-group -g

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

--rewrite-rule-set

The name or ID of the rewrite rule set.

--rule-type

The rule type (Basic, PathBasedRouting).

--set

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

--url-path-map

The name or ID of the URL path map.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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