az network cross-region-lb frontend-ip

Manage frontend IP addresses of a cross-region load balancer.

Commands

Name Description Type Status
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 frontend-ip create

Edit

Create a frontend IP address.

az network cross-region-lb frontend-ip create --lb-name
                                              --name
                                              --resource-group
                                              [--acquire-policy-token]
                                              [--change-reference]
                                              [--ddos-settings]
                                              [--default-outbound --default-outbound-access {0, 1, f, false, n, no, t, true, y, yes}]
                                              [--ipam-allocations --ipam-pool-prefix-allocations]
                                              [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                              [--public-ip-address]
                                              [--public-ip-prefix]
                                              [--service-gateway]
                                              [--sharing-scope {DelegatedServices, Tenant}]
                                              [--zone --zones]

Examples

Create a frontend ip address for a public load balancer.

az network cross-region-lb frontend-ip create -g MyResourceGroup --lb-name MyLb -n MyFrontendIp --public-ip-address MyFrontendIp

Required Parameters

--lb-name

The load balancer name.

--name -n

The name of the frontend IP configuration.

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--ddos-settings

The DDoS protection settings associated with the frontend IP configuration. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--default-outbound --default-outbound-access

Set this property to false to disable default outbound connectivity for all VMs in the subnet.

Property Value
Parameter group: Properties Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--ipam-allocations --ipam-pool-prefix-allocations

A list of IPAM Pools for allocating IP address prefixes. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties 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
--public-ip-address

Name or ID of the existing public IP to associate with the configuration.

Property Value
Parameter group: Properties Arguments
--public-ip-prefix

Name or ID of a public IP prefix.

Property Value
Parameter group: Properties Arguments
--service-gateway

Reference to an existing service gateway. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--sharing-scope

Set this property to Tenant to allow sharing subnet with other subscriptions in your AAD tenant. This property can only be set if defaultOutboundAccess is set to false, both properties can only be set if subnet is empty.

Property Value
Parameter group: Properties Arguments
Accepted values: DelegatedServices, Tenant
--zone --zones -z

A list of availability zones denoting the IP allocated for the resource needs to come from. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties 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.

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

Edit

Delete a frontend IP address.

az network cross-region-lb frontend-ip delete --lb-name
                                              --name
                                              --resource-group
                                              [--acquire-policy-token]
                                              [--change-reference]
                                              [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

Examples

Delete a frontend IP address.

az network cross-region-lb frontend-ip delete -g MyResourceGroup --lb-name MyLb -n MyFrontendIp

Required Parameters

--lb-name

The load balancer name.

--name -n

The name of the frontend IP configuration.

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy 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
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 frontend-ip list

Edit

List frontend IP addresses.

az network cross-region-lb frontend-ip list --lb-name
                                            --resource-group

Examples

List frontend IP addresses.

az network cross-region-lb frontend-ip list -g MyResourceGroup --lb-name MyLb

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.

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

Edit

Get the details of a frontend IP address.

az network cross-region-lb frontend-ip show --lb-name
                                            --name
                                            --resource-group

Examples

Get the details of a frontend IP address.

az network cross-region-lb frontend-ip show -g MyResourceGroup --lb-name MyLb -n MyFrontendIp

Required Parameters

--lb-name

The load balancer name.

--name -n

The name of the frontend IP configuration.

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

Edit

Update a frontend IP address.

az network cross-region-lb frontend-ip update --lb-name
                                              --name
                                              --resource-group
                                              [--acquire-policy-token]
                                              [--add]
                                              [--change-reference]
                                              [--ddos-settings]
                                              [--default-outbound --default-outbound-access {0, 1, f, false, n, no, t, true, y, yes}]
                                              [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                              [--ipam-allocations --ipam-pool-prefix-allocations]
                                              [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                              [--public-ip-address]
                                              [--public-ip-prefix]
                                              [--remove]
                                              [--service-gateway]
                                              [--set]
                                              [--sharing-scope {DelegatedServices, Tenant}]
                                              [--zone --zones]

Examples

Update the frontend IP address of a public load balancer.

az network cross-region-lb frontend-ip update -g MyResourceGroup --lb-name MyLb -n MyFrontendIp --public-ip-address MyFrontendIp

Required Parameters

--lb-name

The load balancer name.

--name -n

The name of the frontend IP configuration.

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--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
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--ddos-settings

The DDoS protection settings associated with the frontend IP configuration. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--default-outbound --default-outbound-access

Set this property to false to disable default outbound connectivity for all VMs in the subnet.

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

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

A list of IPAM Pools for allocating IP address prefixes. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties 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
--public-ip-address

Name or ID of the existing public IP to associate with the configuration.

Property Value
Parameter group: Properties Arguments
--public-ip-prefix

Name or ID of a public IP prefix.

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
--service-gateway

Reference to an existing service gateway. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties 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
--sharing-scope

Set this property to Tenant to allow sharing subnet with other subscriptions in your AAD tenant. This property can only be set if defaultOutboundAccess is set to false, both properties can only be set if subnet is empty.

Property Value
Parameter group: Properties Arguments
Accepted values: DelegatedServices, Tenant
--zone --zones -z

A list of availability zones denoting the IP allocated for the resource needs to come from. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties 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.

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