Share via

az network application-gateway url-path-map

Manage URL path maps of an application gateway.

Commands

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

Create a URL path map.

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

Delete a URL path map.

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

List URL path maps.

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

Manage the rules of a URL path map.

 Core GA
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 wait

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

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

Get the details of a URL path map.

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

Update a URL path map.

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

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

 Core GA

az network application-gateway url-path-map create

Edit

Create a URL path map.

The map must be created with at least one rule. This command requires the creation of the first rule at the time the map is created. To learn more visit https://learn.microsoft.com/en-us/azure/application-gateway/tutorial-url-route-cli.

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

Examples

Create a URL path map with a rule.

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

Required Parameters

--gateway-name

Name of the application gateway.

--name -n

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.

Property Value
Parameter group: First Rule Arguments
--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.

--address-pool

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

Property Value
Parameter group: First Rule Arguments
--default-address-pool

Name or ID of the default backend address pool. It is mandatory unless target type is redirection.

--default-http-settings

Name or ID of the default HTTP settings. It is mandatory unless target type is redirection.

--default-redirect-config

Name or ID of the default redirect configuration.

--default-rewrite-rule-set

Name or ID of the default rewrite rule set.

--http-settings

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

Property Value
Parameter group: First Rule 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: First Rule 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: First Rule Arguments
--rule-name

Name of the rule for a URL path map.

Property Value
Parameter group: First Rule Arguments
Default value: default
--rules

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

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

Name or ID of a web application firewall policy resource.

Property Value
Parameter group: First Rule 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 delete

Edit

Delete a URL path map.

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

Examples

Delete a URL path map.

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

Required Parameters

--gateway-name

Name of the application gateway.

--name -n

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.

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

Edit

List URL path maps.

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

Examples

List URL path maps.

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

Edit

Get the details of a URL path map.

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

Examples

Get the details of a URL path map.

az network application-gateway url-path-map show -g MyResourceGroup --gateway-name MyAppGateway -n MyUrlPathMap

Required Parameters

--gateway-name

Name of the application gateway.

--name -n

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 update

Edit

Update a URL path map.

az network application-gateway url-path-map update --gateway-name
                                                   --name
                                                   --resource-group
                                                   [--add]
                                                   [--default-address-pool]
                                                   [--default-http-settings]
                                                   [--default-redirect-config]
                                                   [--default-rewrite-rule-set]
                                                   [--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]
                                                   [--rules]
                                                   [--set]

Examples

Update a URL path map to use new default HTTP settings.

az network application-gateway url-path-map update -g MyResourceGroup --gateway-name MyAppGateway -n MyUrlPathMap --default-http-settings MyNewHttpSettings

Required Parameters

--gateway-name

Name of the application gateway.

--name -n

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.

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

Name or ID of the default backend address pool.

--default-http-settings

Name or ID of the default HTTP settings.

--default-redirect-config

Name or ID of the default redirect configuration.

--default-rewrite-rule-set

Name or ID of the default rewrite rule set.

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

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

Edit

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

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