az network lb inbound-nat-pool

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 --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 --frontend-ip-name]
                                      [--idle-timeout --idle-timeout-in-minutes]
                                      [--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.

Property	Value
Parameter group:	Properties Arguments

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

Property	Value
Parameter group:	Properties Arguments

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

Property	Value
Parameter group:	Properties Arguments

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

Property	Value
Parameter group:	Properties Arguments
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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
Parameter group:	Properties Arguments
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.

Property	Value
Parameter group:	Properties Arguments
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.

Property	Value
Parameter group:	Properties Arguments

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

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

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

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

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 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 --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-ip-name]
                                      [--frontend-port-range-end]
                                      [--frontend-port-range-start]
                                      [--idle-timeout --idle-timeout-in-minutes]
                                      [--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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

--backend-port

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

Property	Value
Parameter group:	Properties Arguments

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

Property	Value
Parameter group:	Properties Arguments
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.

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

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

The name or ID of the frontend IP configuration.

Property	Value
Parameter group:	Properties Arguments

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

Property	Value
Parameter group:	Properties Arguments

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

Property	Value
Parameter group:	Properties Arguments

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

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

--protocol

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

Property	Value
Parameter group:	Properties Arguments
Accepted values:	All, Tcp, Udp

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

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

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Share via

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