Share via

az network cross-region-lb rule

  • Reference

Manage cross-region load balancing rules.

Commands

Name Description Type Status
az network cross-region-lb rule create

Create a load balancing rule.

 Core GA
az network cross-region-lb rule delete

Delete a load balancing rule.

 Core GA
az network cross-region-lb rule list

List load balancing rules.

 Core GA
az network cross-region-lb rule show

Get the details of a load balancing rule.

 Core GA
az network cross-region-lb rule update

Update a load balancing rule.

 Core GA

az network cross-region-lb rule create

Edit

Create a load balancing rule.

az network cross-region-lb rule create --backend-port
                                       --frontend-port
                                       --lb-name
                                       --name
                                       --protocol {All, Tcp, Udp}
                                       --resource-group
                                       [--backend-pool-name]
                                       [--enable-floating-ip {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--frontend-ip]
                                       [--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 cross-region-lb rule create -g MyResourceGroup --lb-name MyLb -n MyLbRule --protocol Tcp --frontend-ip-name 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 cross-region-lb rule create -g MyResourceGroup --lb-name MyLb -n MyLbRule --protocol Tcp --frontend-ip-name MyFrontEndIp --frontend-port 80 --backend-pool-name MyAddressPool --backend-port 80 --floating-ip true

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 cross-region-lb rule create -g MyResourceGroup --lb-name MyLb -n MyHAPortsRule --protocol All --frontend-port 0 --backend-port 0 --frontend-ip-name 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

ID or name of the backend address pools. If only one exists, omit to use as default.

--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
--frontend-ip --frontend-ip-name

The name of ID of the frontend IP configuration.

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

Edit

Delete a load balancing rule.

az network cross-region-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 cross-region-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 cross-region-lb rule list

Edit

List load balancing rules.

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

Examples

List load balancing rules.

az network cross-region-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 cross-region-lb rule show

Edit

Get the details of a load balancing rule.

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

Examples

Get the details of a load balancing rule.

az network cross-region-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 cross-region-lb rule update

Edit

Update a load balancing rule.

az network cross-region-lb rule update --lb-name
                                       --name
                                       --resource-group
                                       [--add]
                                       [--backend-pool-name]
                                       [--backend-port]
                                       [--enable-floating-ip {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]
                                       [--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 cross-region-lb rule update -g MyResourceGroup --lb-name MyLb -n MyLbRule --protocol Udp

Update a load balancing rule to support HA ports.

az network cross-region-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

ID or name of the backend address pools. If only one exists, omit to use as default.

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

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

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