az network lb frontend-ip

  • Reference

Manage frontend IP addresses of a load balancer.

Commands

Name Description Type Status
az network lb frontend-ip create

Create a frontend IP address.

 Core GA
az network lb frontend-ip delete

Delete a frontend IP address.

 Core GA
az network lb frontend-ip list

List frontend IP addresses.

 Core GA
az network lb frontend-ip show

Get the details of a frontend IP address.

 Core GA
az network lb frontend-ip update

Update a frontend IP address.

 Core GA
az network lb frontend-ip wait

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

 Core GA

az network lb frontend-ip create

Edit

Create a frontend IP address.

az network lb frontend-ip create --lb-name
                                 --name
                                 --resource-group
                                 [--gateway-lb]
                                 [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                 [--private-ip-address]
                                 [--private-ip-address-version {IPv4, IPv6}]
                                 [--public-ip-address]
                                 [--public-ip-prefix]
                                 [--subnet]
                                 [--vnet-name]
                                 [--zone]

Examples

Create a frontend ip address for a public load balancer.

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

Create a frontend ip address for an internal load balancer.

az network lb frontend-ip create -g MyResourceGroup -n MyFrontendIp --lb-name MyLb --private-ip-address 10.10.10.100 --subnet MySubnet --vnet-name MyVnet

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

--gateway-lb

The reference to gateway load balancer frontend IP.

--no-wait

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

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--private-ip-address

Static private IP address to associate with the configuration.

--private-ip-address-version --private-ipv

Whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4.

accepted values: IPv4, IPv6
default value: IPv4
--public-ip-address

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

--public-ip-prefix

Name or ID of a public IP prefix.

--subnet

Resource ID.

--vnet-name

The virtual network (VNet) associated with the subnet (Omit if supplying a subnet id).

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

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

Edit

Delete a frontend IP address.

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

Examples

Delete a frontend IP address.

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

--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 lb frontend-ip list

Edit

List frontend IP addresses.

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

Examples

List frontend IP addresses.

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

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

Edit

Get the details of a frontend IP address.

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

Examples

Get the details of a frontend IP address.

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

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

Edit

Update a frontend IP address.

az network lb frontend-ip update --lb-name
                                 --name
                                 --resource-group
                                 [--add]
                                 [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                 [--gateway-lb]
                                 [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                 [--private-ip-address]
                                 [--private-ip-address-version {IPv4, IPv6}]
                                 [--public-ip-address]
                                 [--public-ip-prefix]
                                 [--remove]
                                 [--set]
                                 [--subnet]
                                 [--vnet-name]
                                 [--zone]

Examples

Update the frontend IP address of a public load balancer.

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

Update the frontend IP address of an internal load balancer.

az network lb frontend-ip update -g MyResourceGroup --lb-name MyLb -n MyFrontendIp --private-ip-address 10.10.10.50

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

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

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

The reference to gateway load balancer frontend IP.

--no-wait

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

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--private-ip-address

Static private IP address to associate with the configuration.

--private-ip-address-version --private-ipv

Whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4.

accepted values: IPv4, IPv6
--public-ip-address

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

--public-ip-prefix

Name or ID of a public IP prefix.

--remove

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

--set

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

--subnet

Resource ID.

--vnet-name

The virtual network (VNet) associated with the subnet (Omit if supplying a subnet id).

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

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 lb frontend-ip wait

Edit

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

az network lb frontend-ip wait [--created]
                               [--custom]
                               [--deleted]
                               [--exists]
                               [--ids]
                               [--interval]
                               [--lb-name]
                               [--resource-group]
                               [--subscription]
                               [--timeout]
                               [--updated]

Optional Parameters

--created

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

default value: False
--custom

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

--deleted

Wait until deleted.

default value: False
--exists

Wait until the resource exists.

default value: False
--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.

--interval

Polling interval in seconds.

default value: 30
--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>.

--subscription

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

--timeout

Maximum wait in seconds.

default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

default value: False
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.