az network application-gateway rewrite-rule condition

Manage rewrite rule conditions of an application gateway.

Commands

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

Edit

Create a rewrite rule condition.

az network application-gateway rewrite-rule condition create --gateway-name
                                                             --resource-group
                                                             --rule-name
                                                             --rule-set-name
                                                             --variable
                                                             [--acquire-policy-token]
                                                             [--change-reference]
                                                             [--ignore-case {0, 1, f, false, n, no, t, true, y, yes}]
                                                             [--negate {0, 1, f, false, n, no, t, true, y, yes}]
                                                             [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                             [--pattern]

Examples

Create a rewrite rule.

az network application-gateway rewrite-rule condition create -g MyResourceGroup --gateway-name MyGateway --rule-set-name MyRuleSet --rule-name MyRule --variable MyVariable --pattern "^Bearer" --ignore-case false --negate

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

Name of the rewrite rule that is unique within an Application Gateway.

--rule-set-name

Name of the rewrite rule set.

--variable

Variable whose value is being evaluated. Values from: az network application-gateway rewrite-rule condition list-server-variables (prefix headers needed).

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

--ignore-case

Make comparison case-insensitive.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--negate

Check the negation of the condition.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

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

--pattern

Pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition.

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

Edit

Delete a rewrite rule condition.

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

Examples

Delete a rewrite rule condition.

az network application-gateway rewrite-rule condition delete -g MyResourceGroup --gateway-name MyGateway --rule-set-name MyRuleSet --rule-name MyRule --variable MyVariable

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

Name of the rewrite rule that is unique within an Application Gateway.

--rule-set-name

Name of the rewrite rule set.

--variable

The condition parameter of the RewriteRuleCondition.

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

Edit

List rewrite rule conditions.

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

Examples

List rewrite rule conditions.

az network application-gateway rewrite-rule condition list --gateway-name MyGateway --resource-group MyResourceGroup --rule-name MyRule --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-name

Name of the rewrite rule that is unique within an Application Gateway.

--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 condition list-server-variables

Edit

List all available server variables.

az network application-gateway rewrite-rule condition list-server-variables [--acquire-policy-token]
                                                                            [--change-reference]

Examples

List all available server variables.

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

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

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

Edit

Get the details of a rewrite rule condition.

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

Examples

Get the details of a rewrite rule condition.

az network application-gateway rewrite-rule condition show -g MyResourceGroup --gateway-name MyGateway --rule-set-name MyRuleSet --rule-name MyRule --variable MyVariable

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

Name of the rewrite rule that is unique within an Application Gateway.

--rule-set-name

Name of the rewrite rule set.

--variable

The condition parameter of the RewriteRuleCondition.

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

Edit

Update a rewrite rule condition.

az network application-gateway rewrite-rule condition update --gateway-name
                                                             --resource-group
                                                             --rule-name
                                                             --rule-set-name
                                                             --variable
                                                             [--acquire-policy-token]
                                                             [--add]
                                                             [--change-reference]
                                                             [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                                             [--ignore-case {0, 1, f, false, n, no, t, true, y, yes}]
                                                             [--negate {0, 1, f, false, n, no, t, true, y, yes}]
                                                             [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                             [--pattern]
                                                             [--remove]
                                                             [--set]

Examples

Update a rewrite rule condition.

az network application-gateway rewrite-rule condition update -g MyResourceGroup --gateway-name MyGateway --rule-set-name MyRuleSet --rule-name MyRule --variable MyVariable --pattern "^Bearers"

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

Name of the rewrite rule that is unique within an Application Gateway.

--rule-set-name

Name of the rewrite rule set.

--variable

Variable whose value is being evaluated. Values from: az network application-gateway rewrite-rule condition list-server-variables (prefix headers needed).

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

--change-reference

The related change reference ID for this resource operation.

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

--ignore-case

Make comparison case-insensitive.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--negate

Check the negation of the condition.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

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

--pattern

Pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition.

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

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

Edit

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

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

Feedback

Was this page helpful?