az network application-gateway url-path-map

Manage URL path maps of an application gateway.

Commands

az network application-gateway url-path-map create

Create a URL path map.
az network application-gateway url-path-map delete

Delete a URL path map.
az network application-gateway url-path-map list

List URL path maps.
az network application-gateway url-path-map rule

Manage the rules of a URL path map.
az network application-gateway url-path-map rule create

Create a rule for a URL path map.
az network application-gateway url-path-map rule delete

Delete a rule of a URL path map.
az network application-gateway url-path-map show

Get the details of a URL path map.
az network application-gateway url-path-map update

Update a URL path map.

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://docs.microsoft.com/azure/application-gateway/application-gateway-create-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]
                                                   [--redirect-config]
                                                   [--rewrite-rule-set]
                                                   [--rule-name]
                                                   [--subscription]
                                                   [--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

The name of the URL path map.

--paths

Space-separated list of paths to associate with the rule. Valid paths start and end with "/" (ex: "/bar/").

--resource-group -g

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

Optional Parameters

--address-pool

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

--default-address-pool

The name or ID of the default backend address pool, if different from --address-pool.

--default-http-settings

The name or ID of the default HTTP settings, if different from --http-settings.

--default-redirect-config

The name or ID of the default redirect configuration.

--default-rewrite-rule-set

The name or ID of the default rewrite rule set, if different from --rewrite-rule-set.

--http-settings

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

--no-wait

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

--redirect-config

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

--rewrite-rule-set

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

--rule-name

The name of the url-path-map rule.

default value: default
--subscription

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

--waf-policy

Name or ID of a Firewall Policy resource.

az network application-gateway url-path-map delete

Edit

Delete a URL path map.

az network application-gateway url-path-map delete [--gateway-name]
                                                   [--ids]
                                                   [--name]
                                                   [--no-wait]
                                                   [--resource-group]
                                                   [--subscription]

Examples

Delete a URL path map.

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

Optional Parameters

--gateway-name

The 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

The name of the URL path map.

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

--subscription

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

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

Examples

List URL path maps.

az network application-gateway url-path-map list -g MyResourceGroup --gateway-name MyAppGateway

Required Parameters

--gateway-name

The name of the application gateway.

--resource-group -g

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

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

Edit

Get the details of a URL path map.

az network application-gateway url-path-map show [--gateway-name]
                                                 [--ids]
                                                 [--name]
                                                 [--query-examples]
                                                 [--resource-group]
                                                 [--subscription]

Examples

Get the details of a URL path map.

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

Optional Parameters

--gateway-name

The 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

The name of the URL path map.

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

--subscription

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

az network application-gateway url-path-map update

Edit

Update a URL path map.

az network application-gateway url-path-map update [--add]
                                                   [--default-address-pool]
                                                   [--default-http-settings]
                                                   [--default-redirect-config]
                                                   [--default-rewrite-rule-set]
                                                   [--force-string]
                                                   [--gateway-name]
                                                   [--ids]
                                                   [--name]
                                                   [--no-wait]
                                                   [--remove]
                                                   [--resource-group]
                                                   [--set]
                                                   [--subscription]

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

Update a URL path map. (autogenerated)

az network application-gateway url-path-map update --default-address-pool MyAddressPool --default-http-settings MyNewHttpSettings --gateway-name MyAppGateway --name MyUrlPathMap --resource-group MyResourceGroup

Update a URL path map. (autogenerated)

az network application-gateway url-path-map update --gateway-name MyAppGateway --name MyUrlPathMap --resource-group MyResourceGroup --set useRemoteGateways=true

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

--default-address-pool

The name or ID of the default backend address pool.

--default-http-settings

The name or ID of the default HTTP settings.

--default-redirect-config

The name or ID of the default redirect configuration.

--default-rewrite-rule-set

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

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

The name of the URL path map.

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

--resource-group -g

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

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