az network lb inbound-nat-rule
Manage inbound NAT rules of a load balancer.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| 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 inbound-nat-rule create
Create an inbound NAT rule.
az network lb inbound-nat-rule create --backend-port
--lb-name
--name
--protocol {All, Tcp, Udp}
--resource-group
[--backend-address-pool]
[--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]
[--frontend-port]
[--frontend-port-range-end]
[--frontend-port-range-start]
[--idle-timeout]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]Examples
Create a basic inbound NAT rule for port 80.
az network lb inbound-nat-rule create -g MyResourceGroup --lb-name MyLb -n MyNatRule --protocol Tcp --frontend-port 80 --backend-port 80Create a basic inbound NAT rule for a specific frontend IP and enable floating IP for NAT Rule.
az network lb inbound-nat-rule create -g MyResourceGroup --lb-name MyLb -n MyNatRule --protocol Tcp --frontend-port 5432 --backend-port 3389 --frontend-ip MyFrontendIp --floating-ip trueRequired Parameters
The port used for the internal endpoint. Acceptable values range from 1 to 65535.
The load balancer name.
The name of the resource that is unique within the set of inbound NAT rules used by the load balancer.
The reference to the transport protocol used by the load balancing rule.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
The name or ID of the backend address pool.
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.
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.
The name of ID of the frontend IP configuration.
The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values range from 1 to 65534.
The port range end for the external endpoint. This property is used together with BackendAddressPool and FrontendPortRangeStart. Individual inbound NAT rule port mappings will be created for each backend address from BackendAddressPool. Acceptable values range from 1 to 65534.
The port range start for the external endpoint. This property is used together with BackendAddressPool and FrontendPortRangeEnd. Individual inbound NAT rule port mappings will be created for each backend address from BackendAddressPool. Acceptable values range from 1 to 65534.
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.
Do not wait for the long-running operation to finish.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az network lb inbound-nat-rule delete
Delete an inbound NAT rule.
az network lb inbound-nat-rule delete --lb-name
--name
--resource-group
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]Examples
Delete an inbound NAT rule.
az network lb inbound-nat-rule delete -g MyResourceGroup --lb-name MyLb -n MyNatRuleRequired Parameters
The load balancer name.
The name of the resource that is unique within the set of inbound NAT rules used by the load balancer.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Do not wait for the long-running operation to finish.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az network lb inbound-nat-rule list
List inbound NAT rules.
az network lb inbound-nat-rule list --lb-name
--resource-groupExamples
List inbound NAT rules.
az network lb inbound-nat-rule list -g MyResourceGroup --lb-name MyLbRequired Parameters
The load balancer name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az network lb inbound-nat-rule show
Get the details of an inbound NAT rule.
az network lb inbound-nat-rule show --lb-name
--name
--resource-groupExamples
Get the details of an inbound NAT rule.
az network lb inbound-nat-rule show -g MyResourceGroup --lb-name MyLb -n MyNatRuleRequired Parameters
The load balancer name.
The name of the resource that is unique within the set of inbound NAT rules used by the load balancer.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az network lb inbound-nat-rule update
Update an inbound NAT rule.
az network lb inbound-nat-rule update --lb-name
--name
--resource-group
[--add]
[--backend-address-pool]
[--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]
[--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 rule to disable floating IP and modify idle timeout duration.
az network lb inbound-nat-rule update -g MyResourceGroup --lb-name MyLb -n MyNatRule --floating-ip false --idle-timeout 5Required Parameters
The load balancer name.
The name of the resource that is unique within the set of inbound NAT rules used by the load balancer.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
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>.
The name or ID of the backend address pool.
The port used for the internal endpoint. Acceptable values range from 1 to 65535.
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.
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.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
The name of ID of the frontend IP configuration.
The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values range from 1 to 65534.
The port range end for the external endpoint. This property is used together with BackendAddressPool and FrontendPortRangeStart. Individual inbound NAT rule port mappings will be created for each backend address from BackendAddressPool. Acceptable values range from 1 to 65534.
The port range start for the external endpoint. This property is used together with BackendAddressPool and FrontendPortRangeEnd. Individual inbound NAT rule port mappings will be created for each backend address from BackendAddressPool. Acceptable values range from 1 to 65534.
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.
Do not wait for the long-running operation to finish.
The reference to the transport protocol used by the load balancing rule.
Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.
Update an object by specifying a property path and value to set. Example: --set property1.property2=.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az network lb inbound-nat-rule wait
Place the CLI in a waiting state until a condition is met.
az network lb inbound-nat-rule wait [--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--lb-name]
[--resource-group]
[--subscription]
[--timeout]
[--updated]Examples
Required Parameters
Optional Parameters
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
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.
Polling interval in seconds.
The load balancer name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
