Share via

az network lb address-pool address

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

Commands

Name Description Type Status
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 address add

Edit

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

az network lb address-pool address add --ip-address
                                       --lb-name
                                       --name
                                       --pool-name
                                       --resource-group
                                       [--admin-state {Down, None, Up}]
                                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--subnet]
                                       [--virtual-network --vnet]

Examples

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

az network lb address-pool address add -g MyResourceGroup --lb-name MyLb --pool-name MyAddressPool -n MyAddress --vnet MyVnet --ip-address 10.0.0.1

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

az network lb address-pool address add -g MyResourceGroup --lb-name MyLb --pool-name MyAddressPool -n MyAddress --subnet /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyRg/providers/Microsoft.Network/virtualNetworks/vnet/subnets/subnet1 --ip-address 10.0.0.1

Required Parameters

--ip-address

IP Address belonging to the referenced virtual network.

Property Value
Parameter group: Properties Arguments
--lb-name

The name of the load balancer.

--name -n

Name of the backend address.

--pool-name

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--admin-state

A list of administrative states which once set can override health probe so that Load Balancer will always forward new connections to backend, or deny new connections and reset existing connections.

Property Value
Parameter group: Properties Arguments
Accepted values: Down, None, Up
--no-wait

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

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--subnet

Name or Id of the subnet. (If name is provided, vnet is also required; If id, vnet is not required).

Property Value
Parameter group: Properties Arguments
--virtual-network --vnet

Name or Id of the virtual network.

Property Value
Parameter group: Properties Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

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

Property Value
Default value: False

az network lb address-pool address list

Edit

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

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

Examples

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

az network lb address-pool address list -g MyResourceGroup --lb-name MyLb --pool-name MyAddressPool

Required Parameters

--lb-name

The name of the load balancer.

--pool-name

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

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

Property Value
Default value: False

az network lb address-pool address remove

Edit

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

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

Examples

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

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

Required Parameters

--lb-name

The name of the load balancer.

--name -n

Name of the backend address.

--pool-name

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--no-wait

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

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

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

Property Value
Default value: False

az network lb address-pool address show

Edit

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

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

Examples

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

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

Required Parameters

--lb-name

The name of the load balancer.

--name -n

Name of the backend address.

--pool-name

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

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

Property Value
Default value: False

az network lb address-pool address update

Edit

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

az network lb address-pool address update --lb-name
                                          --name
                                          --pool-name
                                          --resource-group
                                          [--add]
                                          [--admin-state {Down, None, Up}]
                                          [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                          [--ip-address]
                                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                          [--remove]
                                          [--set]
                                          [--subnet]
                                          [--virtual-network --vnet]

Examples

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

az network lb address-pool address update -g MyResourceGroup --lb-name MyLb --pool-name MyAddressPool -n MyAddress --subnet /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyRg/providers/Microsoft.Network/virtualNetworks/vnet/subnets/subnet2

Required Parameters

--lb-name

The name of the load balancer.

--name -n

Name of the backend address.

--pool-name

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property Value
Parameter group: Generic Update Arguments
--admin-state

A list of administrative states which once set can override health probe so that Load Balancer will always forward new connections to backend, or deny new connections and reset existing connections.

Property Value
Parameter group: Properties Arguments
Accepted values: Down, None, Up
--force-string

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

Property Value
Parameter group: Generic Update Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--ip-address

IP Address belonging to the referenced virtual network.

Property Value
Parameter group: Properties Arguments
--no-wait

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

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

Property Value
Parameter group: Generic Update Arguments
--set

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

Property Value
Parameter group: Generic Update Arguments
--subnet

Name or Id of the subnet. (If name is provided, vnet is also required; If id, vnet is not required).

Property Value
Parameter group: Properties Arguments
--virtual-network --vnet

Name or Id of the virtual network.

Property Value
Parameter group: Properties Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

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

Property Value
Default value: False

az network lb address-pool address wait

Edit

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

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--created

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

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--custom

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

Property Value
Parameter group: Wait Condition Arguments
--deleted

Wait until deleted.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--exists

Wait until the resource exists.

Property Value
Parameter group: Wait Condition Arguments
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.

Property Value
Parameter group: Resource Id Arguments
--interval

Polling interval in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 30
--lb-name

The name of the load balancer.

Property Value
Parameter group: Resource Id Arguments
--pool-name

The name of the backend address pool.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
--timeout

Maximum wait in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False