az network lb

Reference

Manage and configure load balancers.

To learn more about Azure Load Balancer visit https://learn.microsoft.com/en-us/azure/load-balancer/quickstart-load-balancer-standard-public-cli.

Commands

Name	Description	Type	Status
az network lb address-pool	Manage address pools of a load balancer.	Core	GA
az network lb address-pool create	Create an address pool.	Core	GA
az network lb address-pool delete	Delete an address pool.	Core	GA
az network lb address-pool list	List address pools.	Core	GA
az network lb address-pool show	Get the details of an address pool.	Core	GA
az network lb address-pool wait	Place the CLI in a waiting state until a condition is met.	Core	GA
az network lb create	Create a load balancer.	Core	GA
az network lb delete	Delete the specified load balancer.	Core	GA
az network lb frontend-ip	Manage frontend IP addresses of a load balancer.	Core	GA
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 inbound-nat-pool	Manage inbound NAT address pools of a load balancer.	Core	GA
az network lb inbound-nat-pool create	Create an inbound NAT address pool.	Core	GA
az network lb inbound-nat-pool delete	Delete an inbound NAT address pool.	Core	GA
az network lb inbound-nat-pool list	List inbound NAT address pools.	Core	GA
az network lb inbound-nat-pool show	Get the details of an inbound NAT address pool.	Core	GA
az network lb inbound-nat-pool update	Update an inbound NAT address pool.	Core	GA
az network lb inbound-nat-pool wait	Place the CLI in a waiting state until a condition is met.	Core	GA
az network lb inbound-nat-rule	Manage inbound NAT rules of a load balancer.	Core	GA
az network lb inbound-nat-rule create	Create an inbound NAT rule.	Core	GA
az network lb inbound-nat-rule delete	Delete an inbound NAT rule.	Core	GA
az network lb inbound-nat-rule list	List inbound NAT rules.	Core	GA
az network lb inbound-nat-rule show	Get the details of an inbound NAT rule.	Core	GA
az network lb inbound-nat-rule update	Update an inbound NAT rule.	Core	GA
az network lb inbound-nat-rule wait	Place the CLI in a waiting state until a condition is met.	Core	GA
az network lb list	List load balancers.	Core	GA
az network lb probe	Evaluate probe information and define routing rules.	Core	GA
az network lb probe create	Create a probe in the load balance.	Core	GA
az network lb probe delete	Delete a probe in the load balancer.	Core	GA
az network lb probe list	List probes in the load balancer.	Core	GA
az network lb probe show	Get the details of a probe in the load balancer.	Core	GA
az network lb probe update	Update a probe in the load balancer.	Core	GA
az network lb probe wait	Place the CLI in a waiting state until a condition is met.	Core	GA
az network lb rule	Manage load balancing rules.	Core	GA
az network lb rule create	Create a load balancing rule.	Core	GA
az network lb rule delete	Delete a load balancing rule.	Core	GA
az network lb rule list	List load balancing rules.	Core	GA
az network lb rule show	Get the details of a load balancing rule.	Core	GA
az network lb rule update	Update a load balancing rule.	Core	GA
az network lb rule wait	Place the CLI in a waiting state until a condition is met.	Core	GA
az network lb show	Get the details of a load balancer.	Core	GA
az network lb update	Update a load balancer.	Core	GA
az network lb wait	Place the CLI in a waiting state until a condition is met.	Core	GA

az network lb create

Edit

Create a load balancer.

Azure CLI

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

Examples

Create a basic load balancer.

Azure CLI

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

Create a basic load balancer on a specific virtual network and subnet. If a virtual network with the same name is found in the same resource group, the load balancer will utilize this virtual network. If one is not found a new one will be created.

Azure CLI

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. The subnet can be in arbitary resource group or subscription by providing the ID of the subnet.

Azure CLI

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.

Azure CLI

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.

Azure CLI

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

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

Default value: False

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

--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. If you want to use an existing subnet in other resource group or subscription, please provide the ID instead of the name of the subnet.

--subnet-address-prefix

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

Default value: 10.0.0.0/24

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

--validate

Generate and validate the ARM template without creating any resources.

Default value: False

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

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 delete

Edit

Delete the specified load balancer.

Azure CLI

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

Examples

Delete a load balancer.

Azure CLI

az network lb delete -g MyResourceGroup -n MyLb

Optional Parameters

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

--name -n

The load balancer name.

--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

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

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 list

Edit

List load balancers.

Azure CLI

az network lb list [--resource-group]

Examples

List load balancers.

Azure CLI

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

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 show

Edit

Get the details of a load balancer.

Azure CLI

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

Examples

Get the details of a load balancer.

Azure CLI

az network lb show -g MyResourceGroup -n MyLb

Optional Parameters

--expand

Expands referenced resources. Default value is None.

--ids

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

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 update

Edit

Update a load balancer.

This command can only be used to update the tags for a load balancer. Name and resource group are immutable and cannot be updated.

Azure CLI

az network lb update [--add]
                     [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                     [--ids]
                     [--name]
                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                     [--outbound-nat-rules]
                     [--probes]
                     [--remove]
                     [--resource-group]
                     [--set]
                     [--subscription]
                     [--tags]

Examples

Update the tags of a load balancer.

Azure CLI

az network lb update -g MyResourceGroup -n MyLB --tags CostCenter=MyTestGroup

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

--ids

--name -n

The load balancer name.

--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--outbound-nat-rules

The outbound NAT rules. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--probes

Collection of probe objects used in the load balancer. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> 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=<value>.

--subscription

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

--tags

Space-separated tags: key[=value] [key[=value] ...]. 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 wait

Edit

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

Azure CLI

az network lb wait [--created]
                   [--custom]
                   [--deleted]
                   [--exists]
                   [--expand]
                   [--ids]
                   [--interval]
                   [--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

--expand

Expands referenced resources. Default value is None.

--ids

--interval

Polling interval in seconds.

Default value: 30

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

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

Share via

az network lb

Commands

az network lb create

Examples

Required Parameters

Optional Parameters

az network lb delete

Examples

Optional Parameters

az network lb list

Examples

Optional Parameters

az network lb show

Examples

Optional Parameters

az network lb update

Examples

Optional Parameters

az network lb wait

Optional Parameters

Additional resources