az network cross-region-lb

Manage and configure cross-region load balancers.

To learn more about Azure Load Balancer visit https://learn.microsoft.com/en-us/azure/load-balancer/tutorial-cross-region-cli.

Commands

Name	Description	Type	Status
az network cross-region-lb address-pool	Manage address pools of a cross-region load balancer.	Core	GA
az network cross-region-lb address-pool address	Manage backend addresses of the cross-region load balance backend address pool.	Core	GA
az network cross-region-lb address-pool address add	Add one backend address into the load balance backend address pool.	Core	GA
az network cross-region-lb address-pool address list	List all backend addresses of the load balance backend address pool.	Core	GA
az network cross-region-lb address-pool address remove	Remove one backend address from the load balance backend address pool.	Core	GA
az network cross-region-lb address-pool address show	Show the backend address from the load balance backend address pool.	Core	GA
az network cross-region-lb address-pool address update	Update the backend address into the load balance backend address pool.	Core	GA
az network cross-region-lb address-pool create	Create load balancer backend address pool.	Core	GA
az network cross-region-lb address-pool delete	Delete the specified load balancer backend address pool.	Core	GA
az network cross-region-lb address-pool list	List all the load balancer backed address pools.	Core	GA
az network cross-region-lb address-pool show	Get load balancer backend address pool.	Core	GA
az network cross-region-lb address-pool update	Update a load balancer backend address pool.	Core	GA
az network cross-region-lb create	Create a cross-region load balancer.	Core	GA
az network cross-region-lb delete	Delete the specified load balancer.	Core	GA
az network cross-region-lb frontend-ip	Manage frontend IP addresses of a cross-region load balancer.	Core	GA
az network cross-region-lb frontend-ip create	Create a frontend IP address.	Core	GA
az network cross-region-lb frontend-ip delete	Delete a frontend IP address.	Core	GA
az network cross-region-lb frontend-ip list	List frontend IP addresses.	Core	GA
az network cross-region-lb frontend-ip show	Get the details of a frontend IP address.	Core	GA
az network cross-region-lb frontend-ip update	Update a frontend IP address.	Core	GA
az network cross-region-lb list	List load balancers.	Core	GA
az network cross-region-lb rule	Manage cross-region load balancing rules.	Core	GA
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 show	Get the details of a load balancer.	Core	GA
az network cross-region-lb update	Update a load balancer.	Core	GA
az network cross-region-lb wait	Place the CLI in a waiting state until a condition is met.	Core	GA

az network cross-region-lb create

Create a cross-region load balancer.

az network cross-region-lb create --name
                                  --resource-group
                                  [--address-allocation --public-ip-address-allocation {Dynamic, Static}]
                                  [--backend-pool-name]
                                  [--frontend-ip-name]
                                  [--frontend-ip-zone]
                                  [--location]
                                  [--no-wait]
                                  [--public-ip-address]
                                  [--public-ip-dns-name]
                                  [--public-ip-zone]
                                  [--tags]
                                  [--validate]

Examples

Create a basic load balancer.

az network cross-region-lb create -g MyResourceGroup -n MyLb

Required Parameters

--name -n

The load balancer name.

--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-allocation --public-ip-address-allocation

IP allocation method.

Property	Value
Parameter group:	Public IP Arguments
Accepted values:	Dynamic, Static

--backend-pool-name

The name of the backend address pool.

--frontend-ip-name

The name of the frontend IP configuration.

Property	Value
Default value:	LoadBalancerFrontEnd

--frontend-ip-zone

Used to create internal facing Load balancer.

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--no-wait

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

Property	Value
Default value:	False

--public-ip-address

Name or ID of the public IP address, or "" for none. Uses existing resource if available or will create a new resource with defaults if omitted.

Property	Value
Parameter group:	Public IP Arguments

--public-ip-dns-name

Globally unique DNS name for a new public IP.

Property	Value
Parameter group:	Public IP Arguments

--public-ip-zone

Used to created a new public ip for the load balancer, a.k.a public facing Load balancer.

Property	Value
Parameter group:	Public IP Arguments

--tags

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

--validate

Generate and validate the ARM template without creating any resources.

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

Delete the specified load balancer.

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

Examples

Delete a load balancer.

az network cross-region-lb delete -g MyResourceGroup -n MyLb

Optional Parameters

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

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

Property	Value
Parameter group:	Resource Id Arguments

--name -n

The load balancer name.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

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

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

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.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az network cross-region-lb list

List load balancers.

az network cross-region-lb list [--max-items]
                                [--next-token]
                                [--resource-group]

Examples

List load balancers.

az network cross-region-lb list -g MyResourceGroup

Optional Parameters

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

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

Property	Value
Parameter group:	Pagination Arguments

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Property	Value
Parameter group:	Pagination Arguments

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

Get the details of a load balancer.

az network cross-region-lb show [--expand]
                                [--ids]
                                [--name]
                                [--resource-group]
                                [--subscription]

Examples

Get the details of a load balancer.

az network cross-region-lb show -g MyResourceGroup -n MyLb

Optional Parameters

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

--expand

Expands referenced resources. Default value is None.

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

Property	Value
Parameter group:	Resource Id Arguments

--name -n

The load balancer name.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

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.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az network cross-region-lb update

Update a load balancer.

This command can only be used to update the tags for a load balancer. Name and resource group are immutable and cannot be updated.

az network cross-region-lb update [--add]
                                  [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                  [--ids]
                                  [--name]
                                  [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                  [--probes]
                                  [--remove]
                                  [--resource-group]
                                  [--set]
                                  [--subscription]
                                  [--tags]

Examples

Update the tags of a load balancer.

az network cross-region-lb update -g MyResourceGroup -n MyLB --tags CostCenter=MyTestGroup

Optional Parameters

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

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

Property	Value
Parameter group:	Generic Update Arguments

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Property	Value
Parameter group:	Generic Update Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

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

Property	Value
Parameter group:	Resource Id Arguments

--name -n

The load balancer name.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

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

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--probes

Collection of probe objects used in the load balancer. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--remove

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

Property	Value
Parameter group:	Generic Update Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--set

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

Property	Value
Parameter group:	Generic Update Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

--tags

Space-separated tags: key[=value] [key[=value] ...]. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az network cross-region-lb wait

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

az network cross-region-lb wait [--created]
                                [--custom]
                                [--deleted]
                                [--exists]
                                [--expand]
                                [--ids]
                                [--interval]
                                [--name]
                                [--resource-group]
                                [--subscription]
                                [--timeout]
                                [--updated]

Optional Parameters

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

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Property	Value
Parameter group:	Wait Condition Arguments

--deleted

Wait until deleted.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--exists

Wait until the resource exists.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--expand

Expands referenced resources. Default value is None.

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

Property	Value
Parameter group:	Resource Id Arguments

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	30

--name -n

The load balancer name.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

--timeout

Maximum wait in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
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.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False