Del via

az stack-hci-vm network lb

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 command. Learn more about extensions.

Manage load balancers with stack-hci-vm.

Commands

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

Manage backend address pools on a load balancer.

 Extension GA
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 create

Create a load balancer.

 Extension GA
az stack-hci-vm network lb delete

Delete a load balancer.

 Extension GA
az stack-hci-vm network lb frontend-ip

Manage frontend IP configurations on a load balancer.

 Extension GA
az stack-hci-vm network lb frontend-ip add

Add a frontend IP configuration to an existing load balancer.

 Extension GA
az stack-hci-vm network lb frontend-ip delete

Remove a frontend IP configuration from a load balancer.

 Extension GA
az stack-hci-vm network lb frontend-ip list

List frontend IP configurations on a load balancer.

 Extension GA
az stack-hci-vm network lb frontend-ip show

Show the details of a frontend IP configuration.

 Extension GA
az stack-hci-vm network lb lb-rule

Manage load-balancing rules on a load balancer.

 Extension GA
az stack-hci-vm network lb lb-rule add

Create a load-balancing rule that binds a frontend, backend pool, and optional probe.

 Extension GA
az stack-hci-vm network lb lb-rule delete

Delete a load-balancing rule.

 Extension GA
az stack-hci-vm network lb lb-rule list

List load-balancing rules.

 Extension GA
az stack-hci-vm network lb lb-rule show

Show a load-balancing rule definition.

 Extension GA
az stack-hci-vm network lb lb-rule update

Update ports, protocols, or probe bindings on an existing rule.

 Extension GA
az stack-hci-vm network lb list

List all load balancers.

 Extension GA
az stack-hci-vm network lb probe

Manage health probes attached to load balancers.

 Extension GA
az stack-hci-vm network lb probe add

Add a TCP or HTTP health probe.

 Extension GA
az stack-hci-vm network lb probe delete

Delete a probe.

 Extension GA
az stack-hci-vm network lb probe list

List probes configured on a load balancer.

 Extension GA
az stack-hci-vm network lb probe show

Show details for a probe configuration.

 Extension GA
az stack-hci-vm network lb probe update

Update probe settings such as interval or threshold.

 Extension GA
az stack-hci-vm network lb show

Get the details of a load balancer.

 Extension GA
az stack-hci-vm network lb update

Update a load balancer.

 Extension GA

az stack-hci-vm network lb create

Create a load balancer.

az stack-hci-vm network lb create --custom-location
                                  --name
                                  --resource-group
                                  [--backend-pool]
                                  [--frontend-ip]
                                  [--lb-rule]
                                  [--location]
                                  [--probe]
                                  [--tags]

Examples

Create load balancer with dynamic frontend IP

az stack-hci-vm network lb create --resource-group "test-rg" --name "web-lb" --location "eastus" --custom-location "/subscriptions/xxxx/resourceGroups/test-rg/providers/Microsoft.ExtendedLocation/customLocations/test-location" --frontend-ip name=web-fe allocation-method=Dynamic subnet-id="/subscriptions/xxxx/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1"

Create load balancer with static frontend IP, backend pool, rule, and probe

az stack-hci-vm network lb create --resource-group "test-rg" --name "complex-lb" --location "eastus" --custom-location "/subscriptions/xxxx/customLocations/test-location" --frontend-ip name=static-fe allocation-method=Static private-ip=10.0.0.5 subnet-id="/subscriptions/xxxx/vnet/subnet1" --backend-pool name=web-pool vnet-id="/subscriptions/xxxx/vnet1" addresses="/subscriptions/xxxx/nic1/ipconfigurations/ipconfig1","/subscriptions/xxxx/nic2/ipconfigurations/ipconfig1" --lb-rule name=http-rule frontend-ip-name=static-fe backend-pool-name=web-pool protocol=Tcp frontend-port=80 backend-port=8080 --probe name=health-probe protocol=Tcp port=80

Create load balancer with multiple frontend IPs

az stack-hci-vm network lb create --resource-group "test-rg" --name "multi-fe-lb" --location "eastus" --custom-location "/subscriptions/xxxx/customLocations/test-location" --frontend-ip name=dynamic-fe allocation-method=Dynamic subnet-id="/sub/sn1" --frontend-ip name=static-fe1 allocation-method=Static private-ip=10.0.0.5 subnet-id="/sub/sn2" --frontend-ip name=static-fe2 allocation-method=Static private-ip=10.0.0.6 subnet-id="/sub/sn2"

Required Parameters

--custom-location

The ID of the custom location.

--name -n

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

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

--backend-pool

Backend address pool (repeatable). Required: name and addresses=<nic-ip-config-id>[,<nic-ip-config-id>...]. Optional: vnet-id=<id> or lnet-id=<id> (exactly one when provided). Example: --backend-pool name=pool1 vnet-id=/sub/vnet1 addresses=/sub/.../nic1/ipConfigurations/ipconfig1,/sub/.../nic2/ipConfigurations/ipconfig2.

--frontend-ip

Frontend IP configuration (repeatable). Required: name and at least one of subnet-id or public-ip-id. Optional: allocation-method=<Static|Dynamic> (defaults to Dynamic) and private-ip=<ip> (Static only). Example: --frontend-ip name=fe1 subnet-id=/sub/vnet/sn1.

--lb-rule

Load balancing rule (repeatable). Format: name=<name> frontend-ip=<fe-name> backend-pool=<pool-name> protocol=<Tcp|Udp> frontend-port=<port> backend-port=<port> [probe=<probe-name>] [load-distribution=<policy>]. Example: --lb-rule name=http frontend-ip=fe1 backend-pool=pool1 protocol=Tcp frontend-port=80 backend-port=8080.

--location -l

If location is not specified, the location of the resource group is used.

--probe

Health probe. Can be specified multiple times. Format: name=<name> protocol=<Tcp|Http> port=<port> [path=<path>] [interval=<secs>] [threshold=<count>]. Note: HTTP probes require path parameter. Example: --probe name=health protocol=Tcp port=80.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

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 delete

Delete a load balancer.

az stack-hci-vm network lb delete --name
                                  --resource-group
                                  [--polling-interval]
                                  [--yes]

Examples

DeleteLB

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

Required Parameters

--name -n

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

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

--polling-interval

ARM polling interval for long running operations.

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

List all load balancers.

az stack-hci-vm network lb list [--resource-group]

Examples

ListLBs

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

Optional Parameters

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

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

Get the details of a load balancer.

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

Examples

ShowLB

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

Required Parameters

--name -n

Name of the load balancer.

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

Update a load balancer.

az stack-hci-vm network lb update --name
                                  --resource-group
                                  [--tags]

Examples

UpdateLB

az stack-hci-vm network lb update --resource-group "test-rg" --name "test-lb" --tags env=prod updated=yes

Required Parameters

--name -n

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

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

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

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