az network application-gateway rewrite-rule

Manage rewrite rules of an application gateway.

Commands

az network application-gateway rewrite-rule condition

Manage rewrite rule conditions of an application gateway.
az network application-gateway rewrite-rule condition create

Create a rewrite rule condition.
az network application-gateway rewrite-rule condition delete

Delete a rewrite rule condition.
az network application-gateway rewrite-rule condition list

List rewrite rule conditions.
az network application-gateway rewrite-rule condition list-server-variables

Lists all available server variables.
az network application-gateway rewrite-rule condition show

Get the details of a rewrite rule condition.
az network application-gateway rewrite-rule condition update

Update a rewrite rule condition.
az network application-gateway rewrite-rule create

Create a rewrite rule.
az network application-gateway rewrite-rule delete

Delete a rewrite rule.
az network application-gateway rewrite-rule list

List rewrite rules.
az network application-gateway rewrite-rule list-request-headers

Lists all available request headers.
az network application-gateway rewrite-rule list-response-headers

Lists all available response headers.
az network application-gateway rewrite-rule set

Manage rewrite rule sets of an application gateway.
az network application-gateway rewrite-rule set create

Create a rewrite rule set.
az network application-gateway rewrite-rule set delete

Delete a rewrite rule set.
az network application-gateway rewrite-rule set list

List rewrite rule sets.
az network application-gateway rewrite-rule set show

Get the details of a rewrite rule set.
az network application-gateway rewrite-rule set update

Update a rewrite rule set.
az network application-gateway rewrite-rule show

Get the details of a rewrite rule.
az network application-gateway rewrite-rule update

Update a rewrite rule.

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
                                                   [--enable-reroute {false, true}]
                                                   [--modified-path]
                                                   [--modified-query-string]
                                                   [--no-wait]
                                                   [--request-headers]
                                                   [--response-headers]
                                                   [--sequence]
                                                   [--subscription]

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

--enable-reroute

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

accepted values: false, true
--modified-path

Url path for url rewrite.

--modified-query-string

Query string for url rewrite.

--no-wait

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

--request-headers

Space-separated list of HEADER=VALUE pairs.

value from: az network application-gateway rewrite-rule list-request-headers
--response-headers

Space-separated list of HEADER=VALUE pairs.

value from: az network application-gateway rewrite-rule list-response-headers
--sequence

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

--subscription

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

az network application-gateway rewrite-rule delete

Edit

Delete a rewrite rule.

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

Examples

Delete a rewrite rule. (autogenerated)

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

Optional Parameters

--gateway-name

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

Name of the rewrite 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>.

--rule-set-name

Name of the rewrite rule set.

--subscription

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

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
                                                 [--query-examples]
                                                 [--subscription]

Examples

List rewrite rules. (autogenerated)

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.

Optional Parameters

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--subscription

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

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

Edit

Lists all available request headers.

az network application-gateway rewrite-rule list-request-headers [--subscription]

Optional Parameters

--subscription

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

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

Edit

Lists all available response headers.

az network application-gateway rewrite-rule list-response-headers [--subscription]

Optional Parameters

--subscription

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

az network application-gateway rewrite-rule show

Edit

Get the details of a rewrite rule.

az network application-gateway rewrite-rule show [--gateway-name]
                                                 [--ids]
                                                 [--name]
                                                 [--query-examples]
                                                 [--resource-group]
                                                 [--rule-set-name]
                                                 [--subscription]

Examples

Get the details of a rewrite rule. (autogenerated)

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

Optional Parameters

--gateway-name

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

Name of the rewrite rule.

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

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

--subscription

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

az network application-gateway rewrite-rule update

Edit

Update a rewrite rule.

az network application-gateway rewrite-rule update [--add]
                                                   [--enable-reroute {false, true}]
                                                   [--force-string]
                                                   [--gateway-name]
                                                   [--ids]
                                                   [--modified-path]
                                                   [--modified-query-string]
                                                   [--name]
                                                   [--no-wait]
                                                   [--remove]
                                                   [--request-headers]
                                                   [--resource-group]
                                                   [--response-headers]
                                                   [--rule-set-name]
                                                   [--sequence]
                                                   [--set]
                                                   [--subscription]

Examples

Update a rewrite rule. (autogenerated)

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

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

--enable-reroute

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

accepted values: false, true
--force-string

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

--gateway-name

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.

--modified-path

Url path for url rewrite.

--modified-query-string

Query string for url rewrite.

--name -n

Name of the rewrite rule.

--no-wait

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

--remove

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

--request-headers

Space-separated list of HEADER=VALUE pairs.

value from: az network application-gateway rewrite-rule list-request-headers
--resource-group -g

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

--response-headers

Space-separated list of HEADER=VALUE pairs.

value from: az network application-gateway rewrite-rule list-response-headers
--rule-set-name

Name of the rewrite rule set.

--sequence

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

--subscription

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