Share via

az network lb address-pool

  • Reference

Manage address pools of a load balancer.

Commands

Name Description Type Status
az network lb address-pool address

Manage backend addresses of the cross-region load balance backend address pool.

 Core GA
az network lb address-pool address add

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

 Core GA
az network lb address-pool address list

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

 Core GA
az network lb address-pool address remove

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

 Core GA
az network lb address-pool address show

Show the backend address from the load balance backend address pool.

 Core GA
az network lb address-pool address update

Update the backend address into the load balance backend address pool.

 Core GA
az network lb address-pool address wait

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

 Core GA
az network lb address-pool create

Create load balancer backend address pool.

 Core GA
az network lb address-pool delete

Delete the specified load balancer backend address pool.

 Core GA
az network lb address-pool list

List address pools.

 Core GA
az network lb address-pool show

Get the details of an address pool.

 Core GA
az network lb address-pool tunnel-interface

Manage tunnel interfaces of a load balancer.

 Core Preview
az network lb address-pool tunnel-interface add

Add one tunnel interface into the load balance tunnel interface pool.

 Core Preview
az network lb address-pool tunnel-interface list

List all tunnel interfacees of the load balance tunnel interface pool.

 Core Preview
az network lb address-pool tunnel-interface remove

Remove one tunnel interface from the load balance tunnel interface pool.

 Core Preview
az network lb address-pool tunnel-interface show

Get one tunnel interface of load balance tunnel interface pool.

 Core Preview
az network lb address-pool tunnel-interface update

Update one tunnel interface of load balance tunnel interface pool.

 Core Preview
az network lb address-pool tunnel-interface wait

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

 Core Preview
az network lb address-pool update

Update an address pool.

 Core GA
az network lb address-pool wait

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

 Core GA

az network lb address-pool create

Edit

Create load balancer backend address pool.

az network lb address-pool create --address-pool-name
                                  --lb-name
                                  --resource-group
                                  [--admin-state {Down, None, Up}]
                                  [--backend-address]
                                  [--drain-period]
                                  [--location]
                                  [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                  [--sync-mode {Automatic, Manual}]
                                  [--tunnel-interfaces]
                                  [--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 shorthand syntax arguments.

az network lb address-pool create -g MyResourceGroup --lb-name MyLb -n MyAddressPool --vnet MyVnetResource --backend-addresses "[{name:addr1,ip-address:10.0.0.1},{name:addr2,ip-address:10.0.0.2,subnet:subnetName}]"

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

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

az network lb address-pool create -g MyResourceGroup --lb-name MyLb -n MyAddressPool --backend-address name=addr1 ip-address=10.0.0.1 subnet=/subscriptions/000/resourceGroups/MyRg/providers/Microsoft.Network/virtualNetworks/vnet/subnets/subnet1

Required Parameters

--address-pool-name --name -n

The name of the backend address pool.

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

--admin-state

Default administrative state to backend addresses in --backend-addresses.

Accepted values: Down, None, Up
--backend-address --backend-addresses

An array of backend addresses. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. Singular flags: --backend-address.

--drain-period --drain-period-in-seconds

Amount of seconds Load Balancer waits for before sending RESET to client and backend address.

--location

The location of the backend address pool.

--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--sync-mode
Preview

Backend address synchronous mode for the backend pool.

Accepted values: Automatic, Manual
--tunnel-interfaces

An array of gateway load balancer tunnel interfaces. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--vnet

Name or Id of the default virtual network applied to backend addresses in --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.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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

Edit

Delete the specified load balancer backend address pool.

az network lb address-pool delete --address-pool-name
                                  --lb-name
                                  --resource-group
                                  [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

Examples

Delete an address pool.

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

Required Parameters

--address-pool-name --name -n

The name of the backend address pool.

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

--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
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.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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

Edit

List address pools.

az network lb address-pool list --lb-name
                                --resource-group
                                [--max-items]
                                [--next-token]

Examples

List address pools.

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

Required Parameters

--lb-name

The name of the load balancer.

--resource-group -g

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

Optional Parameters

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

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.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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

Edit

Get the details of an address pool.

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

Examples

Get the details of an address pool.

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

Optional Parameters

--address-pool-name --name -n

The name of the backend address pool.

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

--lb-name

The name of the load balancer.

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

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.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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

Edit

Update an address pool.

az network lb address-pool update [--add]
                                  [--address-pool-name]
                                  [--admin-state {Down, None, Up}]
                                  [--backend-address]
                                  [--drain-period]
                                  [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                  [--ids]
                                  [--lb-name]
                                  [--location]
                                  [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                  [--remove]
                                  [--resource-group]
                                  [--set]
                                  [--subscription]
                                  [--sync-mode {Automatic, Manual}]
                                  [--tunnel-interfaces]
                                  [--vnet]

Examples

Update all backend addresses in the address pool using shorthand syntax

az network lb address-pool update -g MyResourceGroup --lb-name MyLb -n MyAddressPool --vnet MyVnetResource --backend-addresses "[{name:addr1,ip-address:10.0.0.1},{name:addr2,ip-address:10.0.0.2,subnet:subnetName}]"

Update the subnet of the first backend address in the address pool using shorthand syntax

az network lb address-pool update -g MyResourceGroup --lb-name MyLb -n MyAddressPool --backend-addresses [0].subnet=/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyRg/providers/Microsoft.Network/virtualNetworks/vnet/subnets/subnet1

Remove the first backend address in the address pool using shorthand syntax

az network lb address-pool update -g MyResourceGroup --lb-name MyLb -n MyAddressPool --backend-addresses [0]=null

Remove all the backend addresses in the address pool

az network lb address-pool update -g MyResourceGroup --lb-name MyLb -n MyAddressPool --backend-addresses null

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

--address-pool-name --name -n

The name of the backend address pool.

--admin-state

Default administrative state to backend addresses in --backend-addresses.

Accepted values: Down, None, Up
--backend-address --backend-addresses

An array of backend addresses. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. Singular flags: --backend-address.

--drain-period --drain-period-in-seconds

Amount of seconds Load Balancer waits for before sending RESET to client and backend address.

--force-string

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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.

--lb-name

The name of the load balancer.

--location

The location of the backend address pool.

--no-wait

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

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.

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

--subscription

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

--sync-mode
Preview

Backend address synchronous mode for the backend pool.

Accepted values: Automatic, Manual
--tunnel-interfaces

An array of gateway load balancer tunnel interfaces. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--vnet

Name or Id of the default virtual network applied to backend addresses in --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.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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 wait

Edit

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

az network lb address-pool wait [--address-pool-name]
                                [--created]
                                [--custom]
                                [--deleted]
                                [--exists]
                                [--ids]
                                [--interval]
                                [--lb-name]
                                [--resource-group]
                                [--subscription]
                                [--timeout]
                                [--updated]

Optional Parameters

--address-pool-name --name -n

The name of the backend address pool.

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Default value: False
--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wait until deleted.

Default value: False
--exists

Wait until the resource exists.

Default value: False
--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.

--interval

Polling interval in seconds.

Default value: 30
--lb-name

The name of the load balancer.

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

--timeout

Maximum wait in seconds.

Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Default value: False
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.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.