Share via

az network lb rule

  • Reference

Manage load balancing rules.

Commands

Name Description Type Status
az network lb rule create

Create a load balancing rule.

 Core GA
az network lb rule delete

Delete a load balancing rule.

 Core GA
az network lb rule list

List load balancing rules.

 Core GA
az network lb rule show

Get the details of a load balancing rule.

 Core GA
az network lb rule update

Update a load balancing rule.

 Core GA
az network lb rule wait

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

 Core GA

az network lb rule create

Edit

Create a load balancing rule.

az network lb rule create --backend-port
                          --frontend-port
                          --lb-name
                          --name
                          --protocol {All, Tcp, Udp}
                          --resource-group
                          [--backend-pool-name]
                          [--disable-outbound-snat {0, 1, f, false, n, no, t, true, y, yes}]
                          [--enable-floating-ip {0, 1, f, false, n, no, t, true, y, yes}]
                          [--enable-tcp-reset {0, 1, f, false, n, no, t, true, y, yes}]
                          [--frontend-ip]
                          [--idle-timeout]
                          [--load-distribution {Default, SourceIP, SourceIPProtocol}]
                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                          [--probe]

Examples

Create a load balancing rule that assigns a front-facing IP configuration and port to an address pool and port.

az network lb rule create -g MyResourceGroup --lb-name MyLb -n MyLbRule --protocol Tcp --frontend-ip MyFrontEndIp --frontend-port 80 --backend-pool-name MyAddressPool --backend-port 80

Create a load balancing rule that assigns a front-facing IP configuration and port to an address pool and port with the floating ip feature.

az network lb rule create -g MyResourceGroup --lb-name MyLb -n MyLbRule --protocol Tcp --frontend-ip MyFrontEndIp --backend-pool-name MyAddressPool --floating-ip true --frontend-port 80 --backend-port 80

Create an HA ports load balancing rule that assigns a frontend IP and port to use all available backend IPs in a pool on the same port.

az network lb rule create -g MyResourceGroup --lb-name MyLb -n MyHAPortsRule --protocol All --frontend-port 0 --backend-port 0 --frontend-ip MyFrontendIp --backend-pool-name MyAddressPool

Required Parameters

--backend-port

The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port".

--frontend-port

The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 0 and 65534. Note that value 0 enables "Any Port".

--lb-name

The load balancer name.

--name -n

The name of the load balancing rule.

--protocol

The reference to the transport protocol used by the load balancing rule.

Accepted values: All, Tcp, Udp
--resource-group -g

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

Optional Parameters

--backend-pool-name --backend-pools-name

List of ID or name of the backend address pools. Multiple pools are only supported by Gateway SKU load balancer. If only one exists, omit to use as default. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--disable-outbound-snat

Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--enable-floating-ip --floating-ip

Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--enable-tcp-reset

Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--frontend-ip --frontend-ip-name

The name of ID of the frontend IP configuration.

--idle-timeout --idle-timeout-in-minutes

The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.

--load-distribution

The load distribution policy for this rule.

Accepted values: Default, SourceIP, SourceIPProtocol
Default value: Default
--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--probe --probe-name

The ID or Name of an existing probe to associate with this rule.

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

Edit

Delete a load balancing rule.

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

Examples

Delete a load balancing rule.

az network lb rule delete -g MyResourceGroup --lb-name MyLb -n MyLbRule

Required Parameters

--lb-name

The load balancer name.

--name -n

The name of the load balancing rule.

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

Edit

List load balancing rules.

az network lb rule list --lb-name
                        --resource-group

Examples

List load balancing rules.

az network lb rule list -g MyResourceGroup --lb-name MyLb -o table

Required Parameters

--lb-name

The load balancer name.

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

Edit

Get the details of a load balancing rule.

az network lb rule show --lb-name
                        --name
                        --resource-group

Examples

Get the details of a load balancing rule.

az network lb rule show -g MyResourceGroup --lb-name MyLb -n MyLbRule

Required Parameters

--lb-name

The load balancer name.

--name -n

The name of the load balancing 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.

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

Edit

Update a load balancing rule.

az network lb rule update --lb-name
                          --name
                          --resource-group
                          [--add]
                          [--backend-pool-name]
                          [--backend-port]
                          [--disable-outbound-snat {0, 1, f, false, n, no, t, true, y, yes}]
                          [--enable-floating-ip {0, 1, f, false, n, no, t, true, y, yes}]
                          [--enable-tcp-reset {0, 1, f, false, n, no, t, true, y, yes}]
                          [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                          [--frontend-ip]
                          [--frontend-port]
                          [--idle-timeout]
                          [--load-distribution {Default, SourceIP, SourceIPProtocol}]
                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                          [--probe]
                          [--protocol {All, Tcp, Udp}]
                          [--remove]
                          [--set]

Examples

Update a load balancing rule to change the protocol to UDP.

az network lb rule update -g MyResourceGroup --lb-name MyLb -n MyLbRule --protocol Udp

Update a load balancing rule to support HA ports.

az network lb rule update -g MyResourceGroup --lb-name MyLb -n MyLbRule --protocol All --frontend-port 0 --backend-port 0

Required Parameters

--lb-name

The load balancer name.

--name -n

The name of the load balancing rule.

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

--backend-pool-name --backend-pools-name

List of ID or name of the backend address pools. Multiple pools are only supported by Gateway SKU load balancer. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--backend-port

The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port".

--disable-outbound-snat

Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--enable-floating-ip --floating-ip

Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--enable-tcp-reset

Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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
--frontend-ip --frontend-ip-name

The name of ID of the frontend IP configuration.

--frontend-port

The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 0 and 65534. Note that value 0 enables "Any Port".

--idle-timeout --idle-timeout-in-minutes

The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.

--load-distribution

The load distribution policy for this rule.

Accepted values: Default, SourceIP, SourceIPProtocol
--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--probe --probe-name

The ID or Name of an existing probe to associate with this rule.

--protocol

The reference to the transport protocol used by the load balancing rule.

Accepted values: All, Tcp, Udp
--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

--set

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

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

Edit

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

az network lb rule wait [--created]
                        [--custom]
                        [--deleted]
                        [--exists]
                        [--ids]
                        [--interval]
                        [--lb-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 load balancer name.

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