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 | 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 address-pool create
Create load balancer backend address pool.
az network cross-region-lb address-pool create --address-pool-name --name
--lb-name
--resource-group
[--admin-state {Down, None, Up}]
[--backend-address --backend-addresses]
[--drain-period --drain-period-in-seconds]
[--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 MyAddressPool
Create 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.json
Required 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
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Default administrative state to backend addresses in --backend-addresses
.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Accepted values: | Down, None, Up |
An array of backend addresses. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. Singular flags: --backend-address
.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Amount of seconds Load Balancer waits for before sending RESET to client and backend address.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
The location of the backend address pool.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Do not wait for the long-running operation to finish.
Property | Value |
---|---|
Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
Backend address synchronous mode for the backend pool.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Accepted values: | Automatic, Manual |
A reference to a virtual network.
Property | Value |
---|---|
Parameter group: | VirtualNetwork Arguments |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
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.
Property | Value |
---|---|
Default value: | False |
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 --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 MyAddressPool
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
The name of the backend address pool.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
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 |
The name of the load balancer.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Do not wait for the long-running operation to finish.
Property | Value |
---|---|
Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
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
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
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 table
Required 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
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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 |
Token to specify where to start paginating. This is the token value from a previously truncated response.
Property | Value |
---|---|
Parameter group: | Pagination Arguments |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
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.
Property | Value |
---|---|
Default value: | False |
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 --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 MyAddressPool
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
The name of the backend address pool.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
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 |
The name of the load balancer.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
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
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
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 --name]
[--admin-state {Down, None, Up}]
[--backend-address --backend-addresses]
[--drain-period --drain-period-in-seconds]
[--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-rlb1
Remove 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]=null
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 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 |
The name of the backend address pool.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Default administrative state to backend addresses in --backend-addresses
.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Accepted values: | Down, None, Up |
An array of backend addresses. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. Singular flags: --backend-address
.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Amount of seconds Load Balancer waits for before sending RESET to client and backend address.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
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 |
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 |
The name of the load balancer.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
The location of the backend address pool.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Do not wait for the long-running operation to finish.
Property | Value |
---|---|
Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
Remove a property or an element from a list. Example: --remove property.list <indexToRemove>
OR --remove propertyToRemove
.
Property | Value |
---|---|
Parameter group: | Generic Update Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>
.
Property | Value |
---|---|
Parameter group: | Generic Update Arguments |
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 |
Backend address synchronous mode for the backend pool.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Accepted values: | Automatic, Manual |
A reference to a virtual network.
Property | Value |
---|---|
Parameter group: | VirtualNetwork Arguments |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |