az network cross-region-lb address-pool
Manage address pools of a cross-region load balancer.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| 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 | Preview |
| az network cross-region-lb address-pool address list |
List all backend addresses of the load balance backend address pool. |
Core | Preview |
| az network cross-region-lb address-pool address remove |
Remove one backend address from the load balance backend address pool. |
Core | Preview |
| az network cross-region-lb address-pool address show |
Show the backend address from the load balance backend address pool. |
Core | Preview |
| az network cross-region-lb address-pool address update |
Update the backend address into the load balance backend address pool. |
Core | Preview |
| 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 address-pool create
Create load balancer backend address pool.
az network cross-region-lb address-pool create --address-pool-name
--lb-name
--resource-group
[--backend-address]
[--drain-period]
[--location]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--sync-mode {Automatic, Manual}]
[--vnet-id]Examples
Create an address pool.
az network cross-region-lb address-pool create -g MyResourceGroup --lb-name MyLb -n MyAddressPoolCreate an address pool with several backend addresses using shorthand syntax arguments.
az network cross-region-lb address-pool create -g MyResourceGroup --lb-name MyLb -n MyAddressPool --backend-addresses "[{name:addr1,frontend-ip-address:'/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/cli_test_lb_address_pool_addresses000001/providers/Microsoft.Network/loadBalancers/regional-lb/frontendIPConfigurations/fe-rlb1'},{name:addr2,frontend-ip-address:'/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/cli_test_lb_address_pool_addresses000001/providers/Microsoft.Network/loadBalancers/regional-lb/frontendIPConfigurations/fe-rlb2'}]"Create an address pool with several backend addresses using config file
az network cross-region-lb address-pool create -g MyResourceGroup --lb-name MyLb -n MyAddressPool --backend-addresses config_file.jsonRequired Parameters
The name of the backend address pool.
The name of the load balancer.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
An array of backend addresses. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. Singular flags: --backend-address.
Amount of seconds Load Balancer waits for before sending RESET to client and backend address.
The location of the backend address pool.
Do not wait for the long-running operation to finish.
Backend address synchronous mode for the backend pool.
A reference to a virtual network.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az network cross-region-lb address-pool delete
Delete the specified load balancer backend address pool.
az network cross-region-lb address-pool delete [--address-pool-name]
[--ids]
[--lb-name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]Examples
Delete an address pool.
az network cross-region-lb address-pool delete -g MyResourceGroup --lb-name MyLb -n MyAddressPoolOptional Parameters
The name of the backend address pool.
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.
The name of the load balancer.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az network cross-region-lb address-pool list
List all the load balancer backed address pools.
az network cross-region-lb address-pool list --lb-name
--resource-group
[--max-items]
[--next-token]Examples
List address pools.
az network cross-region-lb address-pool list -g MyResourceGroup --lb-name MyLb -o tableRequired Parameters
The name of the load balancer.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
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.
Token to specify where to start paginating. This is the token value from a previously truncated response.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az network cross-region-lb address-pool show
Get load balancer backend address pool.
az network cross-region-lb address-pool show [--address-pool-name]
[--ids]
[--lb-name]
[--resource-group]
[--subscription]Examples
Get the details of an address pool.
az network cross-region-lb address-pool show -g MyResourceGroup --lb-name MyLb -n MyAddressPoolOptional Parameters
The name of the backend address pool.
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.
The name of the load balancer.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az network cross-region-lb address-pool update
Update a load balancer backend address pool.
az network cross-region-lb address-pool update [--add]
[--address-pool-name]
[--backend-address]
[--drain-period]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--lb-name]
[--location]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--remove]
[--resource-group]
[--set]
[--subscription]
[--sync-mode {Automatic, Manual}]
[--vnet-id]Examples
Update all backend addresses in the address pool using shorthand syntax
az network cross-region-lb address-pool update -g MyResourceGroup --lb-name MyLb -n MyAddressPool --backend-addresses "[{name:addr1,frontend-ip-address:'/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/cli_test_lb_address_pool_addresses000001/providers/Microsoft.Network/loadBalancers/regional-lb/frontendIPConfigurations/fe-rlb1'},{name:addr2,frontend-ip-address:'/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/cli_test_lb_address_pool_addresses000001/providers/Microsoft.Network/loadBalancers/regional-lb/frontendIPConfigurations/fe-rlb2'}]"Update the frontend-ip-address of the first backend address in the address pool using shorthand syntax
az network cross-region-lb address-pool update -g MyResourceGroup --lb-name MyLb -n MyAddressPool --backend-addresses [0].frontend-ip-address=/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/cli_test_lb_address_pool_addresses000001/providers/Microsoft.Network/loadBalancers/regional-lb/frontendIPConfigurations/fe-rlb1Remove the first backend address in the address pool using shorthand syntax
az network cross-region-lb address-pool update -g MyResourceGroup --lb-name MyLb -n MyAddressPool --backend-addresses [0]=nullOptional Parameters
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>.
The name of the backend address pool.
An array of backend addresses. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. Singular flags: --backend-address.
Amount of seconds Load Balancer waits for before sending RESET to client and backend address.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
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.
The name of the load balancer.
The location of the backend address pool.
Do not wait for the long-running operation to finish.
Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Update an object by specifying a property path and value to set. Example: --set property1.property2=.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Backend address synchronous mode for the backend pool.
A reference to a virtual network.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for