az network lb frontend-ip

  • Reference

Manage frontend IP addresses of a load balancer.

Commands

az network lb frontend-ip create

Create a frontend IP address.
az network lb frontend-ip delete

Delete a frontend IP address.
az network lb frontend-ip list

List frontend IP addresses.
az network lb frontend-ip show

Get the details of a frontend IP address.
az network lb frontend-ip update

Update a frontend IP address.

az network lb frontend-ip create

Edit

Create a frontend IP address.

az network lb frontend-ip create --lb-name
                                 --name
                                 --resource-group
                                 [--private-ip-address]
                                 [--private-ip-address-version {IPv4, IPv6}]
                                 [--public-ip-address]
                                 [--public-ip-prefix]
                                 [--subnet]
                                 [--vnet-name]
                                 [--zone {1, 2, 3}]

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

--private-ip-address

Static private IP address to associate with the configuration.

--private-ip-address-version

The private IP address version to use.

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

Name or ID of an existing subnet. If name is specified, also specify --vnet-name.

--vnet-name

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

--zone -z

Space-separated list of availability zones into which to provision the resource.

accepted values: 1, 2, 3

az network lb frontend-ip delete

Edit

Delete a frontend IP address.

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

Examples

Delete a frontend IP address.

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

Required Parameters

--lb-name

The name of the load balancer.

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

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 name of the load balancer.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

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

Get the details of a frontend IP address (autogenerated)

az network lb frontend-ip show --lb-name MyLb --name MyFrontendIp --resource-group MyResourceGroup --subscription MySubscription

Required Parameters

--lb-name

The name of the load balancer.

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

az network lb frontend-ip update

Edit

Update a frontend IP address.

az network lb frontend-ip update [--add]
                                 [--force-string]
                                 [--gateway-lb]
                                 [--ids]
                                 [--lb-name]
                                 [--name]
                                 [--private-ip-address]
                                 [--public-ip-address]
                                 [--public-ip-prefix]
                                 [--remove]
                                 [--resource-group]
                                 [--set]
                                 [--subnet]
                                 [--subscription]
                                 [--vnet-name]

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

Update a frontend IP address. (autogenerated)

az network lb frontend-ip update --lb-name MyLb --name MyFrontendIp --resource-group MyResourceGroup --set tags.CostCenter=MyBusinessGroup

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

default value: []
--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

default value: False
--gateway-lb

The reference to gateway load balancer frontend IP. If you want to delete it, input '""'(Powershell) or ""(Linux).

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

--lb-name

The load balancer name.

--name -n

The name of the frontend IP configuration.

--private-ip-address

Static private IP address to associate with the configuration. Use ""('""' in PowerShell) to remove the static address and use a dynamic address instead.

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

default value: []
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--set

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

default value: []
--subnet

Name or ID of an existing subnet. If name is specified, also specify --vnet-name.

--subscription

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

--vnet-name

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