az network lb address-pool address

  • Preview
  • Reference

This command group is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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

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

 Core Preview
az network lb address-pool address remove

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

 Core Preview
az network lb address-pool address show

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

 Core Preview
az network lb address-pool address update

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

 Core Preview
az network lb address-pool address wait

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

 Core Preview

az network lb address-pool address add

Edit
Preview

Command group 'az network lb address-pool address' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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]

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.

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

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

accepted values: Down, None, Up
--no-wait

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

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

--virtual-network --vnet

Name or Id of the virtual network.

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

Edit
Preview

Command group 'az network lb address-pool address' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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.

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

Edit
Preview

Command group 'az network lb address-pool address' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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

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

Edit
Preview

Command group 'az network lb address-pool address' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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.

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

Edit
Preview

Command group 'az network lb address-pool address' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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]

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

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

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

accepted values: Down, None, Up
--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
--ip-address

IP Address belonging to the referenced virtual network.

--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 OR --remove propertyToRemove.

--set

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

--subnet

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

--virtual-network --vnet

Name or Id of the virtual network.

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

Edit
Preview

Command group 'az network lb address-pool address' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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

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

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

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