Share via

az network application-gateway rewrite-rule

Manage rewrite rules of an application gateway.

Commands

Name Description Type Status
az network application-gateway rewrite-rule condition

Manage rewrite rule conditions of an application gateway.

 Core GA
az network application-gateway rewrite-rule condition create

Create a rewrite rule condition.

 Core GA
az network application-gateway rewrite-rule condition delete

Delete a rewrite rule condition.

 Core GA
az network application-gateway rewrite-rule condition list

List rewrite rule conditions.

 Core GA
az network application-gateway rewrite-rule condition list-server-variables

List all available server variables.

 Core GA
az network application-gateway rewrite-rule condition show

Get the details of a rewrite rule condition.

 Core GA
az network application-gateway rewrite-rule condition update

Update a rewrite rule condition.

 Core GA
az network application-gateway rewrite-rule condition wait

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

 Core GA
az network application-gateway rewrite-rule create

Create a rewrite rule.

 Core GA
az network application-gateway rewrite-rule delete

Delete a rewrite rule.

 Core GA
az network application-gateway rewrite-rule list

List rewrite rules.

 Core GA
az network application-gateway rewrite-rule list-request-headers

List all available request headers.

 Core GA
az network application-gateway rewrite-rule list-response-headers

List all available response headers.

 Core GA
az network application-gateway rewrite-rule set

Manage rewrite rule sets of an application gateway.

 Core GA
az network application-gateway rewrite-rule set create

Create a rewrite rule set.

 Core GA
az network application-gateway rewrite-rule set delete

Delete a rewrite rule set.

 Core GA
az network application-gateway rewrite-rule set list

List rewrite rule sets.

 Core GA
az network application-gateway rewrite-rule set show

Get the details of a rewrite rule set.

 Core GA
az network application-gateway rewrite-rule set update

Update a rewrite rule set.

 Core GA
az network application-gateway rewrite-rule set wait

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

 Core GA
az network application-gateway rewrite-rule show

Get the details of a rewrite rule.

 Core GA
az network application-gateway rewrite-rule update

Update a rewrite rule.

 Core GA
az network application-gateway rewrite-rule wait

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

 Core GA

az network application-gateway rewrite-rule create

Edit

Create a rewrite rule.

az network application-gateway rewrite-rule create --gateway-name
                                                   --name
                                                   --resource-group
                                                   --rule-set-name
                                                   [--conditions]
                                                   [--enable-reroute {0, 1, f, false, n, no, t, true, y, yes}]
                                                   [--modified-path]
                                                   [--modified-query-string]
                                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                   [--request-header-configurations]
                                                   [--request-headers]
                                                   [--response-header-configurations]
                                                   [--response-headers]
                                                   [--sequence]

Examples

Create a rewrite rule.

az network application-gateway rewrite-rule create -g MyResourceGroup --gateway-name MyGateway --rule-set-name MyRuleSet -n MyRule --sequence 123 --request-headers foo=bar --response-headers cat=hat

Required Parameters

--gateway-name

Name of the application gateway.

--name -n

Name of the rewrite rule.

--resource-group -g

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

--rule-set-name

Name of the rewrite rule set.

Optional Parameters

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

--conditions

Conditions based on which the action set execution will be evaluated. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--enable-reroute

If set as true, it will re-evaluate the url path map provided in path based request routing rules using modified path.

Property Value
Parameter group: URL Configuration Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--modified-path

URL path for url rewrite.

Property Value
Parameter group: URL Configuration Arguments
--modified-query-string

Query string for url rewrite.

Property Value
Parameter group: URL Configuration 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
--request-header-configurations

Request Header Actions in the Action Set. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--request-headers

Space-separated list of HEADER=VALUE pairs. Values from: az network application-gateway rewrite-rule list-request-headers. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--response-header-configurations

Response Header Actions in the Action Set. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--response-headers

Space-separated list of HEADER=VALUE pairs. Values from: az network application-gateway rewrite-rule list-response-headers. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--sequence

Determine the execution order of the rule in the rule set.

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

Edit

Delete a rewrite rule.

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

Examples

Delete a rewrite rule.

az network application-gateway rewrite-rule delete --gateway-name MyGateway --name MyRewriteRule --resource-group MyResourceGroup --rule-set-name MyRuleSet

Required Parameters

--gateway-name

Name of the application gateway.

--name -n

Name of the rewrite rule.

--resource-group -g

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

--rule-set-name

Name of the rewrite rule set.

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

Edit

List rewrite rules.

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

Examples

List rewrite rules.

az network application-gateway rewrite-rule list --gateway-name MyGateway --resource-group MyResourceGroup --rule-set-name MyRuleSet

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

--rule-set-name

Name of the rewrite rule set.

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 rewrite-rule list-request-headers

Edit

List all available request headers.

az network application-gateway rewrite-rule list-request-headers

Examples

List all available request headers.

az network application-gateway rewrite-rule list-request-headers
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 rewrite-rule list-response-headers

Edit

List all available response headers.

az network application-gateway rewrite-rule list-response-headers

Examples

List all available response headers.

az network application-gateway rewrite-rule list-response-headers
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 rewrite-rule show

Edit

Get the details of a rewrite rule.

az network application-gateway rewrite-rule show --gateway-name
                                                 --name
                                                 --resource-group
                                                 --rule-set-name

Examples

Get the details of a rewrite rule.

az network application-gateway rewrite-rule show --gateway-name MyGateway --name MyRewriteRule --resource-group MyResourceGroup --rule-set-name MyRuleSet

Required Parameters

--gateway-name

Name of the application gateway.

--name -n

Name of the rewrite rule.

--resource-group -g

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

--rule-set-name

Name of the rewrite rule set.

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

Edit

Update a rewrite rule.

az network application-gateway rewrite-rule update --gateway-name
                                                   --name
                                                   --resource-group
                                                   --rule-set-name
                                                   [--add]
                                                   [--conditions]
                                                   [--enable-reroute {0, 1, f, false, n, no, t, true, y, yes}]
                                                   [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                                   [--modified-path]
                                                   [--modified-query-string]
                                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                   [--remove]
                                                   [--request-header-configurations]
                                                   [--request-headers]
                                                   [--response-header-configurations]
                                                   [--response-headers]
                                                   [--sequence]
                                                   [--set]

Examples

Update a rewrite rule.

az network application-gateway rewrite-rule update --gateway-name MyGateway --name MyRewriteRule --remove tags.foo --resource-group MyResourceGroup --rule-set-name MyRuleSet

Required Parameters

--gateway-name

Name of the application gateway.

--name -n

Name of the rewrite rule.

--resource-group -g

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

--rule-set-name

Name of the rewrite rule set.

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

Conditions based on which the action set execution will be evaluated. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--enable-reroute

If set as true, it will re-evaluate the url path map provided in path based request routing rules using modified path.

Property Value
Parameter group: URL Configuration Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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
--modified-path

URL path for url rewrite.

Property Value
Parameter group: URL Configuration Arguments
--modified-query-string

Query string for url rewrite.

Property Value
Parameter group: URL Configuration 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
--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
--request-header-configurations

Request Header Actions in the Action Set. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--request-headers

Space-separated list of HEADER=VALUE pairs. Values from: az network application-gateway rewrite-rule list-request-headers. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--response-header-configurations

Response Header Actions in the Action Set. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--response-headers

Space-separated list of HEADER=VALUE pairs. Values from: az network application-gateway rewrite-rule list-response-headers. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--sequence

Determine the execution order of the rule in the rule set.

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

Edit

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

az network application-gateway rewrite-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