Del via

az stack-hci-vm network lb lb-rule

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

Manage load-balancing rules on a load balancer.

Commands

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

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

az stack-hci-vm network lb lb-rule add --backend-pool-name
                                       --backend-port
                                       --frontend-ip-name
                                       --frontend-port
                                       --lb-name
                                       --name
                                       --protocol {Tcp, Udp}
                                       --resource-group
                                       [--load-distribution]
                                       [--probe]

Examples

Add HTTPS Rule

az stack-hci-vm network lb lb-rule add --resource-group "test-rg" --lb-name "test-lb" --name "https-rule" --frontend-ip-name "fe-static" --backend-pool-name "web-pool" --protocol Tcp --frontend-port 443 --backend-port 8443 --probe "healthz"

Required Parameters

--backend-pool-name

Name of the backend address pool referenced by this rule.

--backend-port

Backend port to forward traffic to.

--frontend-ip-name

Name of the frontend IP configuration referenced by this rule.

--frontend-port

Frontend port to listen on.

--lb-name

Name of the load balancer that owns the rule.

--name -n

Name of the load balancing rule to create.

--protocol

Protocol handled by the rule.

Property Value
Accepted values: Tcp, Udp
--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.

--load-distribution

Load distribution policy to apply.

--probe

Name of the health probe to associate with this rule.

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 lb-rule delete

Delete a load-balancing rule.

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

Examples

Delete Rule

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

Required Parameters

--lb-name

Name of the load balancer that owns the rule.

--name -n

Name of the load balancing rule 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 lb-rule list

List load-balancing rules.

az stack-hci-vm network lb lb-rule list --lb-name
                                        --resource-group

Examples

List Rules

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

Required Parameters

--lb-name

Name of the load balancer that owns the rule.

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

Show a load-balancing rule definition.

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

Examples

Show Rule

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

Required Parameters

--lb-name

Name of the load balancer that owns the rule.

--name -n

Name of the load balancing rule 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 lb-rule update

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

az stack-hci-vm network lb lb-rule update --lb-name
                                          --name
                                          --resource-group
                                          [--backend-pool-name]
                                          [--backend-port]
                                          [--frontend-ip-name]
                                          [--frontend-port]
                                          [--load-distribution]
                                          [--probe]
                                          [--protocol {Tcp, Udp}]

Examples

Change Backend Port

az stack-hci-vm network lb lb-rule update --resource-group "test-rg" --lb-name "test-lb" --name "https-rule" --backend-port 9443

Required Parameters

--lb-name

Name of the load balancer that owns the rule.

--name -n

Name of the load balancing rule 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.

--backend-pool-name

Updated backend pool reference.

--backend-port

Updated backend port.

--frontend-ip-name

Updated frontend IP configuration reference.

--frontend-port

Updated frontend port.

--load-distribution

Updated load distribution policy. Provide empty string to clear.

--probe

Updated probe reference. Provide empty string to clear.

--protocol

Updated protocol.

Property Value
Accepted values: Tcp, Udp
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