az network nic ip-config inbound-nat-rule

  • Reference

Manage inbound NAT rules of an IP configuration.

Commands

Name Description Type Status
az network nic ip-config inbound-nat-rule add

Add an inbound NAT rule to an IP configuration.

 Core GA
az network nic ip-config inbound-nat-rule remove

Remove an inbound NAT rule of an IP configuration.

 Core GA
az network nic ip-config inbound-nat-rule wait

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

 Core GA

az network nic ip-config inbound-nat-rule add

Edit

Add an inbound NAT rule to an IP configuration.

az network nic ip-config inbound-nat-rule add --inbound-nat-rule
                                              --ip-config-name
                                              --nic-name
                                              --resource-group
                                              [--lb-name]
                                              [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

Examples

Add an inbound NAT rule to an IP configuration.

az network nic ip-config inbound-nat-rule add -g MyResourceGroup --nic-name MyNic -n MyIpConfig --inbound-nat-rule MyNatRule

Required Parameters

--inbound-nat-rule

Name or ID of an existing inbound NAT rule. If name is used, --lb-name must be specified.

--ip-config-name -n

Name of the IP configuration.

--nic-name

Name of the network interface (NIC).

--resource-group -g

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

Optional Parameters

--lb-name

Name of the load balancer.

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

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 nic ip-config inbound-nat-rule remove

Edit

Remove an inbound NAT rule of an IP configuration.

az network nic ip-config inbound-nat-rule remove --inbound-nat-rule
                                                 --ip-config-name
                                                 --nic-name
                                                 --resource-group
                                                 [--lb-name]
                                                 [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

Examples

Remove an inbound NAT rule of an IP configuration.

az network nic ip-config inbound-nat-rule remove -g MyResourceGroup --nic-name MyNic -n MyIpConfig --inbound-nat-rule MyNatRule

Required Parameters

--inbound-nat-rule

Name or ID of an existing inbound NAT rule. If name is used, --lb-name must be specified.

--ip-config-name -n

Name of the IP configuration.

--nic-name

Name of the network interface (NIC).

--resource-group -g

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

Optional Parameters

--lb-name

Name of the load balancer.

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

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 nic ip-config inbound-nat-rule wait

Edit

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

az network nic ip-config inbound-nat-rule wait [--created]
                                               [--custom]
                                               [--deleted]
                                               [--exists]
                                               [--ids]
                                               [--interval]
                                               [--nic-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
--nic-name

Name of the network interface (NIC).

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