az network lb address-pool

Manage address pools of a load balancer.

Commands

az network lb address-pool address

Manage backend addresses of the load balance backend address pool.

az network lb address-pool address add

Add one backend address into the load balance backend address pool.

az network lb address-pool address list

List all backend addresses of the load balance backend address pool.

az network lb address-pool address remove

Remove one backend address from the load balance backend address pool.

az network lb address-pool create

Create an address pool.

az network lb address-pool delete

Delete an address pool.

az network lb address-pool list

List address pools.

az network lb address-pool show

Get the details of an address pool.

az network lb address-pool create

Create an address pool.

az network lb address-pool create --lb-name
                                  --name
                                  --resource-group
                                  [--backend-address]
                                  [--backend-addresses-config-file]
                                  [--subscription]
                                  [--vnet]

Examples

Create an address pool.

az network lb address-pool create -g MyResourceGroup --lb-name MyLb -n MyAddressPool

Create an address pool with several backend addresses using key-value arguments.

az network lb address-pool create -g MyResourceGroup --lb-name MyLb -n MyAddressPool --vnet {VnetResourceId} --backend-address name=addr1 ip-address=10.0.0.1 --backend-address name=addr2 ip-address=10.0.0.3

Create an address pool with several backend addresses using config file

az network lb address-pool create -g MyResourceGroup --lb-name MyLb -n MyAddressPool --backend-addresses-config-file @config_file.json

Required Parameters

--lb-name

The load balancer name.

--name -n

The name of the backend address pool. If only one exists, omit to use as default.

--resource-group -g

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

Optional Parameters

--backend-address

Backend addresses information for backend address pool. If it's used, --vnet is also required.

--backend-addresses-config-file

A config file used to set backend addresses. This argument is for experienced users. You may encounter parse errors if the json file is invalid.

--subscription

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

--vnet

Name or Id of the virtual network applied to all backend addresses.

az network lb address-pool delete

Delete an address pool.

az network lb address-pool delete --lb-name
                                  --name
                                  --resource-group
                                  [--subscription]

Examples

Delete an address pool.

az network lb address-pool delete -g MyResourceGroup --lb-name MyLb -n MyAddressPool

Required Parameters

--lb-name

The load balancer name.

--name -n

The name of the backend address pool. If only one exists, omit to use as default.

--resource-group -g

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

Optional Parameters

--subscription

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

az network lb address-pool list

List address pools.

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

Examples

List address pools.

az network lb address-pool list -g MyResourceGroup --lb-name MyLb -o table

Required Parameters

--lb-name

The load balancer name.

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

Get the details of an address pool.

az network lb address-pool show --lb-name
                                --name
                                --resource-group
                                [--query-examples]
                                [--subscription]

Examples

Get the details of an address pool.

az network lb address-pool show -g MyResourceGroup --lb-name MyLb -n MyAddressPool

Required Parameters

--lb-name

The load balancer name.

--name -n

The name of the backend address pool. If only one exists, omit to use as default.

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