Del via

az stack-hci-vm network lb backend-pool

Note

This reference is part of the stack-hci-vm extension for the Azure CLI (version 2.15.0 or higher). The extension will automatically install the first time you run an az stack-hci-vm network lb backend-pool command. Learn more about extensions.

Manage backend address pools on a load balancer.

Commands

Name Description Type Status
az stack-hci-vm network lb backend-pool add

Add a backend address pool and its NIC targets.

 Extension GA
az stack-hci-vm network lb backend-pool delete

Delete a backend address pool.

 Extension GA
az stack-hci-vm network lb backend-pool list

List backend pools defined on a load balancer.

 Extension GA
az stack-hci-vm network lb backend-pool show

Show backend pool properties, including member NICs.

 Extension GA
az stack-hci-vm network lb backend-pool update

Update a backend pool's network scope or replace all addresses.

 Extension GA

az stack-hci-vm network lb backend-pool add

Add a backend address pool and its NIC targets.

az stack-hci-vm network lb backend-pool add --address
                                            --lb-name
                                            --name
                                            --resource-group
                                            [--lnet-id]
                                            [--vnet-id]

Examples

Add Backend Pool With Two NICs

az stack-hci-vm network lb backend-pool add --resource-group "test-rg" --lb-name "test-lb" --name "web-pool" --vnet-id /subscriptions/xxxx/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/virtualNetworks/test-vnet --address name=web-1 nic-ip-config=/subscriptions/xxxx/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/networkInterfaces/vm1-nic/ipConfigurations/ipconfig --address name=web-2 nic-ip-config=/subscriptions/xxxx/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/networkInterfaces/vm2-nic/ipConfigurations/ipconfig

Required Parameters

--address

Repeatable key/value describing NIC IP configurations.

--lb-name

Name of the load balancer that owns the backend pool.

--name -n

Name of the backend address pool to create.

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

--lnet-id

Resource ID of the logical network associated with these addresses.

--vnet-id

Virtual network resource ID backing the pool.

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 stack-hci-vm network lb backend-pool delete

Delete a backend address pool.

az stack-hci-vm network lb backend-pool delete --lb-name
                                               --name
                                               --resource-group
                                               [--yes]

Examples

Delete Backend Pool

az stack-hci-vm network lb backend-pool delete --resource-group "test-rg" --lb-name "test-lb" --name "web-pool" --yes

Required Parameters

--lb-name

Name of the load balancer that owns the backend pool.

--name -n

Name of the backend address pool to delete.

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

--yes -y

Do not prompt for confirmation.

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

--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 stack-hci-vm network lb backend-pool list

List backend pools defined on a load balancer.

az stack-hci-vm network lb backend-pool list --lb-name
                                             --resource-group

Examples

List Backend Pools

az stack-hci-vm network lb backend-pool list --resource-group "test-rg" --lb-name "test-lb"

Required Parameters

--lb-name

Name of the load balancer that owns the backend 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 stack-hci-vm network lb backend-pool show

Show backend pool properties, including member NICs.

az stack-hci-vm network lb backend-pool show --lb-name
                                             --name
                                             --resource-group

Examples

Show Backend Pool

az stack-hci-vm network lb backend-pool show --resource-group "test-rg" --lb-name "test-lb" --name "pool-base"

Required Parameters

--lb-name

Name of the load balancer that owns the backend pool.

--name -n

Name of the backend address pool to show.

--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 stack-hci-vm network lb backend-pool update

Update a backend pool's network scope or replace all addresses.

WARNING: The --address parameter uses replacement semantics, not additive. Supplying any --address values will REPLACE ALL existing addresses in the pool. To add new addresses, make sure to include all existing addresses in the command.

az stack-hci-vm network lb backend-pool update --lb-name
                                               --name
                                               --resource-group
                                               [--address]
                                               [--lnet-id]
                                               [--vnet-id]

Examples

Update backend addresses (WARNING removes any addresses not listed)

az stack-hci-vm network lb backend-pool update --resource-group "test-rg" --lb-name "test-lb" --name "web-pool" --address name=api-1 nic-ip-config=/subscriptions/xxxx/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/networkInterfaces/api-nic/ipConfigurations/ipconfig

Required Parameters

--lb-name

Name of the load balancer that owns the backend pool.

--name -n

Name of the backend address pool to update.

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

--address

REPLACES all backend addresses with provided addresses. Uses the same key=value schema as add. WARNING: This is not additive - any existing addresses not included as separate --address args will be removed.

--lnet-id

Updated logical network resource ID. Provide empty string to clear.

--vnet-id

Updated virtual network resource ID. Provide empty string to clear.

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