az network application-gateway address-pool

Manage address pools of an application gateway.

Commands

az network application-gateway address-pool create

Create an address pool.

az network application-gateway address-pool delete

Delete an address pool.

az network application-gateway address-pool list

List address pools.

az network application-gateway address-pool show

Get the details of an address pool.

az network application-gateway address-pool update

Update an address pool.

az network application-gateway address-pool create

Create an address pool.

az network application-gateway address-pool create --gateway-name
                                                   --name
                                                   --resource-group
                                                   [--no-wait]
                                                   [--servers]
                                                   [--subscription]

Examples

Create an address pool with two endpoints.

az network application-gateway address-pool create -g MyResourceGroup \
    --gateway-name MyAppGateway -n MyAddressPool --servers 10.0.0.4 10.0.0.5

Required Parameters

--gateway-name

Name of the application gateway.

--name -n

The name of the backend address pool.

--resource-group -g

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

Optional Parameters

--no-wait

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

--servers

Space-separated list of IP addresses or DNS names corresponding to backend servers.

--subscription

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

az network application-gateway address-pool delete

Delete an address pool.

az network application-gateway address-pool delete [--gateway-name]
                                                   [--ids]
                                                   [--name]
                                                   [--no-wait]
                                                   [--resource-group]
                                                   [--subscription]

Examples

Delete an address pool.

az network application-gateway address-pool delete -g MyResourceGroup --gateway-name MyAppGateway -n MyAddressPool

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

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

List address pools.

az network application-gateway address-pool list --gateway-name
                                                 --resource-group
                                                 [--query-examples]
                                                 [--subscription]

Examples

List address pools.

az network application-gateway address-pool 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 address-pool show

Get the details of an address pool.

az network application-gateway address-pool show [--gateway-name]
                                                 [--ids]
                                                 [--name]
                                                 [--query-examples]
                                                 [--resource-group]
                                                 [--subscription]

Examples

Get the details of an address pool.

az network application-gateway address-pool show -g MyResourceGroup --gateway-name MyAppGateway -n MyAddressPool

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

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

Update an address pool.

az network application-gateway address-pool update [--add]
                                                   [--force-string]
                                                   [--gateway-name]
                                                   [--ids]
                                                   [--name]
                                                   [--no-wait]
                                                   [--remove]
                                                   [--resource-group]
                                                   [--servers]
                                                   [--set]
                                                   [--subscription]

Examples

Update backend address pool.

az network application-gateway address-pool update -g MyResourceGroup --gateway-name MyAppGateway \ -n MyAddressPool --servers 10.0.0.4 10.0.0.5 10.0.0.6

Add to the backend address pool by using backend server IP address.

az network application-gateway address-pool update -g MyResourceGroup --gateway-name MyAppGateway -n MyAddressPool \
    --add backendAddresses "{ "ip_address": "{10.0.0.13}" }"

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

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

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

--servers

Space-separated list of IP addresses or DNS names corresponding to backend servers.

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