az network application-gateway url-path-map rule

Manage the rules of a URL path map.

Commands

Name Description Type Status
az network application-gateway url-path-map rule create

Create a rule for a URL path map.

 Core GA
az network application-gateway url-path-map rule delete

Delete a rule for a URL path map.

 Core GA
az network application-gateway url-path-map rule list

Application-gateway url-path-map rule list.

 Core GA
az network application-gateway url-path-map rule show

Application-gateway url-path-map rule show.

 Core GA
az network application-gateway url-path-map rule update

Update a rule of a URL path map.

 Core GA
az network application-gateway url-path-map rule wait

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

 Core GA

az network application-gateway url-path-map rule create

Edit

Create a rule for a URL path map.

az network application-gateway url-path-map rule create --gateway-name
                                                        --name
                                                        --path-map-name
                                                        --paths
                                                        --resource-group
                                                        [--acquire-policy-token]
                                                        [--address-pool]
                                                        [--change-reference]
                                                        [--http-settings]
                                                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                        [--redirect-config]
                                                        [--rewrite-rule-set]
                                                        [--waf-policy]

Examples

Create a rule for a URL path map.

az network application-gateway url-path-map rule create -g MyResourceGroup --gateway-name MyAppGateway -n MyUrlPathMapRule2 --path-map-name MyUrlPathMap --paths /mypath2/* --address-pool MyAddressPool --http-settings MyHttpSettings

Required Parameters

--gateway-name

Name of the application gateway.

--name -n

Name of the rule for a URL path map.

--path-map-name

Name of the URL path map.

--paths

Space-separated list of paths to associate with the rule. Valid paths start and end with "/", e.g, "/bar/". Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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

Name or ID of the backend address pool to use with the created rule.

Property Value
Parameter group: Properties Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--http-settings

Name or ID of the HTTP settings to use with the created rule.

Property Value
Parameter group: Properties 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
--redirect-config

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

Property Value
Parameter group: Properties Arguments
--rewrite-rule-set

Name or ID of the rewrite rule set. If not specified, the default for the map will be used.

Property Value
Parameter group: Properties Arguments
--waf-policy

Name or ID of a web application firewall policy resource.

Property Value
Parameter group: Properties 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 url-path-map rule delete

Edit

Delete a rule for a URL path map.

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

Examples

Delete a rule of a URL path map.

az network application-gateway url-path-map rule delete -g MyResourceGroup --gateway-name MyAppGateway --path-map-name MyUrlPathMap -n MyUrlPathMapRule2

Required Parameters

--gateway-name

Name of the application gateway.

--name -n

Name of the rule for a URL path map.

--path-map-name

Name of the URL path map.

--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 url-path-map rule list

Edit

Application-gateway url-path-map rule list.

az network application-gateway url-path-map rule list --gateway-name
                                                      --path-map-name
                                                      --resource-group

Required Parameters

--gateway-name

Name of the application gateway.

--path-map-name

Name of the URL path map.

--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 url-path-map rule show

Edit

Application-gateway url-path-map rule show.

az network application-gateway url-path-map rule show --gateway-name
                                                      --name
                                                      --path-map-name
                                                      --resource-group

Required Parameters

--gateway-name

Name of the application gateway.

--name -n

Name of the rule for a URL path map.

--path-map-name

Name of the URL path map.

--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 url-path-map rule update

Edit

Update a rule of a URL path map.

az network application-gateway url-path-map rule update --gateway-name
                                                        --name
                                                        --path-map-name
                                                        --resource-group
                                                        [--acquire-policy-token]
                                                        [--add]
                                                        [--backend-address-pool]
                                                        [--backend-http-settings]
                                                        [--change-reference]
                                                        [--firewall-policy]
                                                        [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                                        [--load-distribution-policy --load-policy]
                                                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                        [--paths]
                                                        [--redirect-configuration]
                                                        [--remove]
                                                        [--rewrite-rule-set]
                                                        [--set]

Examples

Update the paths for a URL path map rule.

az network application-gateway url-path-map rule update -g MyResourceGroup --gateway-name MyAppGateway --path-map-name MyUrlPathMap -n MyUrlPathMapRule --paths /mypath/*

Required Parameters

--gateway-name

Name of the application gateway.

--name -n

Name of the rule for a URL path map.

--path-map-name

Name of the URL path map.

--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
--backend-address-pool

Backend address pool resource of URL path map path rule. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--backend-http-settings

Backend http settings resource of URL path map path rule. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--firewall-policy

Reference to the FirewallPolicy resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties 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
--load-distribution-policy --load-policy

Load Distribution Policy resource of URL path map path rule. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties 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
--paths

Path rules of URL path map. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--redirect-configuration

Redirect configuration resource of URL path map path rule. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--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
--rewrite-rule-set

Rewrite rule set resource of URL path map path rule. 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 url-path-map rule wait

Edit

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

az network application-gateway url-path-map rule 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