az network lb

Manage and configure load balancers.

To learn more about Azure Load Balancer visit https://docs.microsoft.com/en-us/azure/load-balancer/load-balancer-get-started-internet-arm-cli.

Commands

az network lb address-pool Manage address pools of a load balancer.
az network lb address-pool create Create an address pool.
az network lb address-pool delete Delete an address pool.
az network lb address-pool list List address pools.
az network lb address-pool show Get the details of an address pool.
az network lb create Create a load balancer.
az network lb delete Delete a load balancer.
az network lb frontend-ip Manage frontend IP addresses of a load balancer.
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 inbound-nat-pool Manage inbound NAT address pools of a load balancer.
az network lb inbound-nat-pool create Create an inbound NAT address pool.
az network lb inbound-nat-pool delete Delete an inbound NAT address pool.
az network lb inbound-nat-pool list List inbound NAT address pools.
az network lb inbound-nat-pool show Get the details of an inbound NAT address pool.
az network lb inbound-nat-pool update Update an inbound NAT address pool.
az network lb inbound-nat-rule Manage inbound NAT rules of a load balancer.
az network lb inbound-nat-rule create Create an inbound NAT rule.
az network lb inbound-nat-rule delete Delete an inbound NAT rule.
az network lb inbound-nat-rule list List inbound NAT rules.
az network lb inbound-nat-rule show Get the details of an inbound NAT rule.
az network lb inbound-nat-rule update Update an inbound NAT rule.
az network lb list List load balancers.
az network lb outbound-rule Manage outbound rules of a load balancer.
az network lb outbound-rule create Create an outbound-rule.
az network lb outbound-rule delete Delete an outbound-rule.
az network lb outbound-rule list List outbound rules.
az network lb outbound-rule show Get the details of an outbound rule.
az network lb outbound-rule update Update an outbound-rule.
az network lb probe Evaluate probe information and define routing rules.
az network lb probe create Create a probe.
az network lb probe delete Delete a probe.
az network lb probe list List probes.
az network lb probe show Get the details of a probe.
az network lb probe update Update a probe.
az network lb rule Manage load balancing rules.
az network lb rule create Create a load balancing rule.
az network lb rule delete Delete a load balancing rule.
az network lb rule list List load balancing rules.
az network lb rule show Get the details of a load balancing rule.
az network lb rule update Update a load balancing rule.
az network lb show Get the details of a load balancer.
az network lb update Update a load balancer.

az network lb create

Create a load balancer.

az network lb create --name
--resource-group
[--backend-pool-name]
[--frontend-ip-name]
[--frontend-ip-zone {1, 2, 3}]
[--location]
[--no-wait]
[--private-ip-address]
[--public-ip-address]
[--public-ip-address-allocation {Dynamic, Static}]
[--public-ip-dns-name]
[--public-ip-zone {1, 2, 3}]
[--sku {Basic, Standard}]
[--subnet]
[--subnet-address-prefix]
[--subscription]
[--tags]
[--validate]
[--vnet-address-prefix]
[--vnet-name]

Examples

Create a basic load balancer.

az network lb create -g MyResourceGroup -n MyLb --sku Basic

Create a basic internal load balancer on a specific virtual network and subnet.

az network lb create -g MyResourceGroup -n MyLb --sku Basic --vnet-name MyVnet --subnet MySubnet

Create a basic load balancer on a subnet of a pre-existing virtual network.

az network lb create -g MyResourceGroup -n MyLb --sku Basic --subnet {subnetID}

Create a basic zone flavored internal load balancer, through provisioning a zonal public ip.

az network lb create -g MyResourceGroup -n MyLb --sku Basic --public-ip-zone 2

Create a standard zone flavored public-facing load balancer, through provisioning a zonal frontend ip configuration and Vnet.

az network lb create -g MyResourceGroup -n MyLb --sku Standard --frontend-ip-zone 1 --vnet-name MyVnet --subnet MySubnet

Required Parameters

--name -n

The load balancer name.

--resource-group -g

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

Optional Parameters

--backend-pool-name

The name of the backend address pool.

--frontend-ip-name

The name of the frontend IP configuration.

default value: LoadBalancerFrontEnd
--frontend-ip-zone

Used to create internal facing Load balancer.

accepted values: 1, 2, 3
--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--no-wait

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

--private-ip-address

Static private IP address to use.

--public-ip-address

Name or ID of the public IP address, or "" for none. Uses existing resource if available or will create a new resource with defaults if omitted.

--public-ip-address-allocation

IP allocation method.

accepted values: Dynamic, Static
--public-ip-dns-name

Globally unique DNS name for a new public IP.

--public-ip-zone

Used to created a new public ip for the load balancer, a.k.a public facing Load balancer.

accepted values: 1, 2, 3
--sku

Load balancer SKU.

accepted values: Basic, Standard
default value: Basic
--subnet

Name or ID of a subnet. Uses existing resource or creates new if specified, or none if omitted. If name specified, also specify --vnet-name.

--subnet-address-prefix

The CIDR address prefix to use when creating a new subnet.

default value: 10.0.0.0/24
--subscription

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

--tags

Space-separated tags in 'key[=value]' format. Use "" to clear existing tags.

--validate

Generate and validate the ARM template without creating any resources.

--vnet-address-prefix

The CIDR address prefix to use when creating a new VNet.

default value: 10.0.0.0/16
--vnet-name

The virtual network (VNet) name.

az network lb delete

Delete a load balancer.

az network lb delete [--ids]
[--name]
[--resource-group]
[--subscription]

Examples

Delete a load balancer.

az network lb delete -g MyResourceGroup -n MyLb

Optional Parameters

--ids

One or more resource IDs (space-delimited). If provided, no other 'Resource Id' arguments should be specified.

--name -n

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.

az network lb list

List load balancers.

az network lb list [--resource-group]
[--subscription]

Examples

List load balancers.

az network lb list -g MyResourceGroup

Optional Parameters

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

az network lb show

Get the details of a load balancer.

az network lb show [--expand]
[--ids]
[--name]
[--resource-group]
[--subscription]

Examples

Get the details of a load balancer.

az network lb show -g MyResourceGroup -n MyLb

Optional Parameters

--expand

Expands referenced resources.

--ids

One or more resource IDs (space-delimited). If provided, no other 'Resource Id' arguments should be specified.

--name -n

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.

az network lb update

Update a load balancer.

az network lb update [--add]
[--force-string]
[--ids]
[--name]
[--remove]
[--resource-group]
[--set]
[--subscription]

Examples

Update the tags of a load balancer.

az network lb update -g MyResourceGroup -n MyLb --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>.

--force-string

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

--ids

One or more resource IDs (space-delimited). If provided, no other 'Resource Id' arguments should be specified.

--name -n

The load balancer name.

--remove

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

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

--subscription

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