az network lb frontend-ip

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
                                 [--acquire-policy-token]
                                 [--change-reference]
                                 [--ddos-settings]
                                 [--default-outbound --default-outbound-access {0, 1, f, false, n, no, t, true, y, yes}]
                                 [--gateway-lb]
                                 [--ipam-allocations --ipam-pool-prefix-allocations]
                                 [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                 [--private-ip-address]
                                 [--private-ip-address-version --private-ipv {IPv4, IPv6}]
                                 [--public-ip-address]
                                 [--public-ip-prefix]
                                 [--service-gateway]
                                 [--sharing-scope {DelegatedServices, Tenant}]
                                 [--subnet]
                                 [--vnet-name]
                                 [--zone --zones]

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

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

--gateway-lb

The reference to gateway load balancer frontend IP.

Property	Value
Parameter group:	Properties Arguments

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

--private-ip-address

Static private IP address to associate with the configuration.

Property	Value
Parameter group:	Properties Arguments

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

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

Property	Value
Parameter group:	Properties Arguments
Default value:	IPv4
Accepted values:	IPv4, IPv6

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

--subnet

Resource ID.

Property	Value
Parameter group:	Properties Arguments

--vnet-name

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

Property	Value
Parameter group:	Properties Arguments

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

Edit

Delete a frontend IP address.

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

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

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

Edit

Update a frontend IP address.

az network 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}]
                                 [--gateway-lb]
                                 [--ipam-allocations --ipam-pool-prefix-allocations]
                                 [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                 [--private-ip-address]
                                 [--private-ip-address-version --private-ipv {IPv4, IPv6}]
                                 [--public-ip-address]
                                 [--public-ip-prefix]
                                 [--remove]
                                 [--service-gateway]
                                 [--set]
                                 [--sharing-scope {DelegatedServices, Tenant}]
                                 [--subnet]
                                 [--vnet-name]
                                 [--zone --zones]

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

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

--gateway-lb

The reference to gateway load balancer frontend IP.

Property	Value
Parameter group:	Properties Arguments

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

--private-ip-address

Static private IP address to associate with the configuration.

Property	Value
Parameter group:	Properties Arguments

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

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

Property	Value
Parameter group:	Properties Arguments
Accepted values:	IPv4, IPv6

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

Property	Value
Parameter group:	Properties Arguments
Accepted values:	DelegatedServices, Tenant

--subnet

Resource ID.

Property	Value
Parameter group:	Properties Arguments

--vnet-name

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

Property	Value
Parameter group:	Properties Arguments

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

Edit

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

az network lb frontend-ip wait [--acquire-policy-token]
                               [--change-reference]
                               [--created]
                               [--custom]
                               [--deleted]
                               [--exists]
                               [--ids]
                               [--interval]
                               [--lb-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.

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

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

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

--lb-name

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

Feedback

Was this page helpful?