az network lb inbound-nat-pool

Reference

Manage inbound NAT address pools of a load balancer.

Commands

Name	Description	Type	Status
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-pool create

Edit

Create an inbound NAT address pool.

az network lb inbound-nat-pool create --backend-port
                                      --frontend-port-range-end
                                      --frontend-port-range-start
                                      --lb-name
                                      --name
                                      --protocol {All, Tcp, Udp}
                                      --resource-group
                                      [--enable-floating-ip {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--enable-tcp-reset {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--frontend-ip]
                                      [--idle-timeout]
                                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

Examples

Create an inbound NAT address pool.

az network lb inbound-nat-pool create -g MyResourceGroup --lb-name MyLb -n MyNatPool --protocol Tcp --frontend-port-range-start 80 --frontend-port-range-end 89 --backend-port 80 --frontend-ip MyFrontendIp

Required Parameters

--backend-port

The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535.

--frontend-port-range-end

The last port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65535.

--frontend-port-range-start

The first port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65534.

--lb-name

The load balancer name.

--name -n

The name of the resource that is unique within the set of inbound NAT pools used by the load balancer. This name can be used to access the resource.

--protocol

The reference to the transport protocol used by the inbound NAT pool.

accepted values: All, Tcp, Udp

--resource-group -g

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

Optional Parameters

--enable-floating-ip --floating-ip

Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.

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

--enable-tcp-reset

Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.

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

--frontend-ip --frontend-ip-name

The name or ID of the frontend IP configuration.

--idle-timeout --idle-timeout-in-minutes

The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.

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

--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 inbound-nat-pool delete

Edit

Delete an inbound NAT address pool.

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

Examples

Delete an inbound NAT address pool.

az network lb inbound-nat-pool delete -g MyResourceGroup --lb-name MyLb -n MyNatPool

Required Parameters

--lb-name

The load balancer name.

--name -n

The name of the resource that is unique within the set of inbound NAT pools used by the load balancer. This name can be used to access the resource.

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

--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 inbound-nat-pool list

Edit

List inbound NAT address pools.

az network lb inbound-nat-pool list --lb-name
                                    --resource-group

Examples

List inbound NAT address pools.

az network lb inbound-nat-pool 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.

--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 inbound-nat-pool show

Edit

Get the details of an inbound NAT address pool.

az network lb inbound-nat-pool show --lb-name
                                    --name
                                    --resource-group

Examples

Get the details of an inbound NAT address pool.

az network lb inbound-nat-pool show -g MyResourceGroup --lb-name MyLb -n MyNatPool

Required Parameters

--lb-name

The load balancer name.

--name -n

The name of the resource that is unique within the set of inbound NAT pools used by the load balancer. This name can be used to access the resource.

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

--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 inbound-nat-pool update

Edit

Update an inbound NAT address pool.

az network lb inbound-nat-pool update --lb-name
                                      --name
                                      --resource-group
                                      [--add]
                                      [--backend-port]
                                      [--enable-floating-ip {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--enable-tcp-reset {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--frontend-ip]
                                      [--frontend-port-range-end]
                                      [--frontend-port-range-start]
                                      [--idle-timeout]
                                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--protocol {All, Tcp, Udp}]
                                      [--remove]
                                      [--set]

Examples

Update an inbound NAT address pool to a different backend port.

az network lb inbound-nat-pool update -g MyResourceGroup --lb-name MyLb -n MyNatPool --protocol Tcp --backend-port 8080

Update an inbound NAT address pool.

az network lb inbound-nat-pool update --backend-port 8080 --enable-tcp-reset true --frontend-port-range-end 89 --frontend-port-range-start 80 --lb-name MyLb --name MyNatPool --resource-group MyResourceGroup

Required Parameters

--lb-name

The load balancer name.

--name -n

The name of the resource that is unique within the set of inbound NAT pools used by the load balancer. This name can be used to access the resource.

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

--backend-port

The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535.

--enable-floating-ip --floating-ip

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

--enable-tcp-reset

Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.

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.

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

--frontend-ip --frontend-ip-name

The name or ID of the frontend IP configuration.

--frontend-port-range-end

The last port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65535.

--frontend-port-range-start

The first port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65534.

--idle-timeout --idle-timeout-in-minutes

The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.

--no-wait

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

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

--protocol

The reference to the transport protocol used by the inbound NAT pool.

accepted values: All, Tcp, Udp

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

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.

--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 inbound-nat-pool wait

Edit

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

az network lb inbound-nat-pool 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.

--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 inbound-nat-pool

Commands

az network lb inbound-nat-pool create

Examples

Required Parameters

Optional Parameters

az network lb inbound-nat-pool delete

Examples

Required Parameters

Optional Parameters

az network lb inbound-nat-pool list

Examples

Required Parameters

az network lb inbound-nat-pool show

Examples

Required Parameters

az network lb inbound-nat-pool update

Examples

Required Parameters

Optional Parameters

az network lb inbound-nat-pool wait

Optional Parameters

Feedback

Additional resources