az network application-gateway advanced-routing-set

Manage advanced routing condition sets of an application gateway.

Commands

Name	Description	Type	Status
az network application-gateway advanced-routing-set condition	Manage routing conditions of an advanced routing condition set.	Core	GA
az network application-gateway advanced-routing-set condition create	Create a routing condition.	Core	GA
az network application-gateway advanced-routing-set condition delete	Delete a routing condition.	Core	GA
az network application-gateway advanced-routing-set condition list	List routing conditions.	Core	GA
az network application-gateway advanced-routing-set condition show	Get the details of a routing condition.	Core	GA
az network application-gateway advanced-routing-set condition update	Update a routing condition.	Core	GA
az network application-gateway advanced-routing-set condition wait	Place the CLI in a waiting state until a condition is met.	Core	GA
az network application-gateway advanced-routing-set create	Create an advanced routing condition set.	Core	GA
az network application-gateway advanced-routing-set delete	Delete an advanced routing condition set.	Core	GA
az network application-gateway advanced-routing-set list	List advanced routing condition sets.	Core	GA
az network application-gateway advanced-routing-set show	Get the details of an advanced routing condition set.	Core	GA
az network application-gateway advanced-routing-set update	Update an advanced routing condition set.	Core	GA
az network application-gateway advanced-routing-set wait	Place the CLI in a waiting state until a condition is met.	Core	GA

az network application-gateway advanced-routing-set create

Create an advanced routing condition set.

The condition set must contain at least one routing condition. All conditions must be satisfied for a referencing advanced routing rule to match.

az network application-gateway advanced-routing-set create --gateway-name
                                                           --name
                                                           --resource-group
                                                           --routing-conditions
                                                           [--acquire-policy-token]
                                                           [--change-reference]
                                                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

Examples

Create an advanced routing condition set that matches requests with a header value.

az network application-gateway advanced-routing-set create -g MyResourceGroup --gateway-name MyAppGateway -n MyConditionSet --routing-conditions "[{condition-type:Header,property-name:x-env,property-values:[canary]}]"

Create an advanced routing condition set that matches requests by path pattern and query string.

az network application-gateway advanced-routing-set create -g MyResourceGroup --gateway-name MyAppGateway -n MyConditionSet2 --routing-conditions "[{condition-type:Path,property-value-matcher:{pattern:'/api/*'}},{condition-type:QueryString,property-name:version,property-values:[v2]}]"

Required Parameters

--gateway-name

Name of the application gateway.

--name -n

Name of the advanced routing condition set that is unique within an Application Gateway.

--resource-group -g

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

--routing-conditions

Routing conditions of the condition set. All conditions must be satisfied for the referencing advanced routing rule to match. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

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 advanced-routing-set delete

Delete an advanced routing condition set.

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

Examples

Delete an advanced routing condition set.

az network application-gateway advanced-routing-set delete -g MyResourceGroup --gateway-name MyAppGateway -n MyConditionSet

Required Parameters

--gateway-name

Name of the application gateway.

--name -n

Name of the advanced routing condition set that is unique within an Application Gateway.

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

--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 advanced-routing-set list

List advanced routing condition sets.

az network application-gateway advanced-routing-set list --gateway-name
                                                         --resource-group

Examples

List advanced routing condition sets.

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

Get the details of an advanced routing condition set.

az network application-gateway advanced-routing-set show --gateway-name
                                                         --name
                                                         --resource-group

Examples

Get the details of an advanced routing condition set.

az network application-gateway advanced-routing-set show -g MyResourceGroup --gateway-name MyAppGateway -n MyConditionSet

Required Parameters

--gateway-name

Name of the application gateway.

--name -n

Name of the advanced routing condition set that is unique within an 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 advanced-routing-set update

Update an advanced routing condition set.

az network application-gateway advanced-routing-set update --gateway-name
                                                           --name
                                                           --resource-group
                                                           [--acquire-policy-token]
                                                           [--add]
                                                           [--change-reference]
                                                           [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                           [--remove]
                                                           [--routing-conditions]
                                                           [--set]

Examples

Replace the routing conditions of an advanced routing condition set.

az network application-gateway advanced-routing-set update -g MyResourceGroup --gateway-name MyAppGateway -n MyConditionSet --routing-conditions "[{condition-type:Header,property-name:x-env,property-values:[canary,beta]}]"

Required Parameters

--gateway-name

Name of the application gateway.

--name -n

Name of the advanced routing condition set that is unique within an Application Gateway.

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

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

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

--routing-conditions

Routing conditions of the condition set. All conditions must be satisfied for the referencing advanced routing rule to match. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties 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 advanced-routing-set wait

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

az network application-gateway advanced-routing-set 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