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 --backend-pool-name]
[--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]
[--frontend-port]
[--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}]
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 80
Create 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 true
Required Parameters
The port used for the internal endpoint. Acceptable values range from 1 to 65535.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
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.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Accepted values: | All, Tcp, Udp |
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.
The name or ID of the backend address pool.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
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 |
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 |
The name of ID of the frontend IP configuration.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
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.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
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.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
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.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
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 |
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
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
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.
Property | Value |
---|---|
Default value: | False |
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 MyNatRule
Required 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
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
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.
Property | Value |
---|---|
Default value: | False |
az network lb inbound-nat-rule list
List inbound NAT rules.
az network lb inbound-nat-rule list --lb-name
--resource-group
Examples
List inbound NAT rules.
az network lb inbound-nat-rule list -g MyResourceGroup --lb-name MyLb
Required Parameters
The load balancer name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
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.
Property | Value |
---|---|
Default value: | False |
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-group
Examples
Get the details of an inbound NAT rule.
az network lb inbound-nat-rule show -g MyResourceGroup --lb-name MyLb -n MyNatRule
Required 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>
.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
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.
Property | Value |
---|---|
Default value: | False |
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-pool-name]
[--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]
[--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 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 5
Required 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
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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 |
The name or ID of the backend address pool.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
The port used for the internal endpoint. Acceptable values range from 1 to 65535.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
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 |
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 |
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 |
The name of ID of the frontend IP configuration.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
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.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
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.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
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.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
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 |
Do not wait for the long-running operation to finish.
Property | Value |
---|---|
Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
The reference to the transport protocol used by the load balancing rule.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Accepted values: | All, Tcp, Udp |
Remove a property or an element from a list. Example: --remove property.list <indexToRemove>
OR --remove propertyToRemove
.
Property | Value |
---|---|
Parameter group: | Generic Update Arguments |
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
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
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.
Property | Value |
---|---|
Default value: | False |
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]
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Wait until created with 'provisioningState' at 'Succeeded'.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | False |
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 |
Wait until deleted.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | False |
Wait until the resource exists.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | False |
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 |
Polling interval in seconds.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | 30 |
The load balancer name.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
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 |
Maximum wait in seconds.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | 3600 |
Wait until updated with provisioningState at 'Succeeded'.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | False |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |