az network lb address-pool

Is this page helpful?

Any additional feedback?

Feedback will be sent to Microsoft: By pressing the submit button, your feedback will be used to improve Microsoft products and services. Privacy policy.

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 tunnel-interface	Manage tunnel interfaces of a load balancer.
az network lb address-pool tunnel-interface add	Add one tunnel interface into the load balance tunnel interface pool.
az network lb address-pool tunnel-interface list	List all tunnel interfacees of the load balance tunnel interface pool.
az network lb address-pool tunnel-interface remove	Remove one tunnel interface from the load balance tunnel interface pool.
az network lb address-pool tunnel-interface update	Update one tunnel interface of load balance tunnel interface pool.
az network lb address-pool update	Update 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]
                                  [--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 required or subnet is 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.

--vnet

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

az network lb address-pool delete

Delete an address pool.

az network lb address-pool delete --lb-name
                                  --name
                                  --resource-group

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

az network lb address-pool list

List address pools.

az network lb address-pool list --lb-name
                                --resource-group

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

az network lb address-pool show

Get the details of an address pool.

az network lb address-pool show --lb-name
                                --name
                                --resource-group

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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

az network lb address-pool update

Update an address pool.

az network lb address-pool update --lb-name
                                  --name
                                  --resource-group
                                  [--add]
                                  [--backend-address]
                                  [--backend-addresses-config-file]
                                  [--force-string]
                                  [--remove]
                                  [--set]
                                  [--vnet]

Examples

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

az network lb address-pool update -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

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

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

--backend-address

Backend addresses information for backend address pool. If it's used, --vnet is required or subnet is 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.

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

--remove

Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=.

--vnet

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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