Share via

az network nic ip-config

Manage IP configurations of a network interface.

Commands

Name Description Type Status
az network nic ip-config address-pool

Manage address pools in an IP configuration.

 Core GA
az network nic ip-config address-pool add

Add an address pool to an IP configuration.

 Core GA
az network nic ip-config address-pool remove

Remove an address pool of an IP configuration.

 Core GA
az network nic ip-config create

Create an IP configuration.

 Core GA
az network nic ip-config delete

Delete an IP configuration.

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

Manage inbound NAT rules of an IP configuration.

 Core GA
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 list

List the IP configurations of an NIC.

 Core GA
az network nic ip-config show

Show the details of an IP configuration.

 Core GA
az network nic ip-config update

Update an IP configuration.

 Core GA
az network nic ip-config wait

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

 Core GA

az network nic ip-config create

Edit

Create an IP configuration.

You must have the Microsoft.Network/AllowMultipleIpConfigurationsPerNic feature enabled for your subscription. Only one configuration may be designated as the primary IP configuration per NIC, using the --make-primary flag.

az network nic ip-config create --name
                                --nic-name
                                --resource-group
                                [--ag-address-pools --app-gateway-address-pools]
                                [--application-security-groups --asgs]
                                [--gateway-name]
                                [--lb-address-pools]
                                [--lb-inbound-nat-rules]
                                [--lb-name]
                                [--make-primary {0, 1, f, false, n, no, t, true, y, yes}]
                                [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                [--private-ip-address]
                                [--private-ip-address-prefix-length --private-ip-prefix-len]
                                [--private-ip-address-version {IPv4, IPv6}]
                                [--public-ip-address]
                                [--subnet]
                                [--vnet-name]

Examples

Create a primary IP configuration for a NIC.

az network nic ip-config create -g MyResourceGroup -n MyIpConfig --nic-name MyNic --make-primary

Required Parameters

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

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

--ag-address-pools --app-gateway-address-pools

Space-separated list of names or IDs of application gateway backend address pools to associate with the NIC. If names are used, --gateway-name must be specified. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Application Gateway Arguments
--application-security-groups --asgs

Space-separated list of application security groups. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: IP Configuration Arguments
--gateway-name

Name of the application gateway.

Property Value
Parameter group: Application Gateway Arguments
--lb-address-pools

Space-separated list of names or IDs of load balancer address pools to associate with the NIC. If names are used, --lb-name must be specified. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Load Balancer Arguments
--lb-inbound-nat-rules

Space-separated list of names or IDs of load balancer inbound NAT rules to associate with the NIC. If names are used, --lb-name must be specified. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Load Balancer Arguments
--lb-name

Name of the load balancer.

Property Value
Parameter group: Load Balancer Arguments
--make-primary

Set to make this configuration the primary one for the NIC.

Property Value
Parameter group: IP Configuration Arguments
Default value: False
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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
--private-ip-address

Static IP address to use or ""('""' in PowerShell) to use a dynamic address.

Property Value
Parameter group: IP Configuration Arguments
--private-ip-address-prefix-length --private-ip-prefix-len

The private IP address prefix length. If specified and the allocation method is dynamic, the service will allocate a CIDR block instead of a single IP address.

Property Value
Parameter group: IP Configuration Arguments
--private-ip-address-version

Version of private IP address to use.

Property Value
Parameter group: IP Configuration Arguments
Default value: IPv4
Accepted values: IPv4, IPv6
--public-ip-address

Name or ID of an existing public IP address.

Property Value
Parameter group: IP Configuration Arguments
--subnet

Name or ID of an existing subnet. If name specified, please also specify --vnet-name.

Property Value
Parameter group: IP Configuration Arguments
--vnet-name

Name of the virtual network.

Property Value
Parameter group: IP Configuration 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 nic ip-config delete

Edit

Delete an IP configuration.

An NIC must have at least one IP configuration.

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

Examples

Delete an IP configuration.

az network nic ip-config delete -g MyResourceGroup -n MyIpConfig --nic-name MyNic

Required Parameters

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

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 nic ip-config list

Edit

List the IP configurations of an NIC.

az network nic ip-config list --nic-name
                              --resource-group

Examples

List the IP configurations of an NIC.

az network nic ip-config list -g MyResourceGroup --nic-name MyNic

Required Parameters

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

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 nic ip-config show

Edit

Show the details of an IP configuration.

az network nic ip-config show --name
                              --nic-name
                              --resource-group

Examples

Show the details of an IP configuration of an NIC.

az network nic ip-config show -g MyResourceGroup -n MyIpConfig --nic-name MyNic

Required Parameters

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

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 nic ip-config update

Edit

Update an IP configuration.

az network nic ip-config update --name
                                --nic-name
                                --resource-group
                                [--add]
                                [--ag-address-pools --app-gateway-address-pools]
                                [--application-security-groups --asgs]
                                [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                [--gateway-lb]
                                [--gateway-name]
                                [--lb-address-pools]
                                [--lb-inbound-nat-rules]
                                [--lb-name]
                                [--make-primary {0, 1, f, false, n, no, t, true, y, yes}]
                                [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                [--private-ip-address]
                                [--private-ip-address-prefix-length --private-ip-prefix-len]
                                [--private-ip-address-version {IPv4, IPv6}]
                                [--public-ip-address]
                                [--remove]
                                [--set]
                                [--subnet]
                                [--vnet-name]

Examples

Update a NIC to use a new private IP address.

az network nic ip-config update -g MyResourceGroup --nic-name MyNic -n MyIpConfig --private-ip-address 10.0.0.9

Make an IP configuration the default for the supplied NIC.

az network nic ip-config update -g MyResourceGroup --nic-name MyNic -n MyIpConfig --make-primary

Required Parameters

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

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
--ag-address-pools --app-gateway-address-pools

Space-separated list of names or IDs of application gateway backend address pools to associate with the NIC. If names are used, --gateway-name must be specified. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Application Gateway Arguments
--application-security-groups --asgs

Space-separated list of application security groups. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: IP Configuration Arguments
--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
--gateway-lb

ID of gateway load balancer frontend IP. If you want to delete it, input null.

Property Value
Parameter group: IP Configuration Arguments
--gateway-name

Name of the application gateway.

Property Value
Parameter group: Application Gateway Arguments
--lb-address-pools

Space-separated list of names or IDs of load balancer address pools to associate with the NIC. If names are used, --lb-name must be specified. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Load Balancer Arguments
--lb-inbound-nat-rules

Space-separated list of names or IDs of load balancer inbound NAT rules to associate with the NIC. If names are used, --lb-name must be specified. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Load Balancer Arguments
--lb-name

Name of the load balancer.

Property Value
Parameter group: Load Balancer Arguments
--make-primary

Set to make this configuration the primary one for the NIC.

Property Value
Parameter group: IP Configuration Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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
--private-ip-address

Static IP address to use or ""('""' in PowerShell) to use a dynamic address.

Property Value
Parameter group: IP Configuration Arguments
--private-ip-address-prefix-length --private-ip-prefix-len

The private IP address prefix length. If specified and the allocation method is dynamic, the service will allocate a CIDR block instead of a single IP address.

Property Value
Parameter group: IP Configuration Arguments
--private-ip-address-version

Version of private IP address to use.

Property Value
Parameter group: IP Configuration Arguments
Accepted values: IPv4, IPv6
--public-ip-address

Name or ID of an existing public IP address.

Property Value
Parameter group: IP Configuration Arguments
--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
--subnet

Name or ID of an existing subnet. If name specified, please also specify --vnet-name.

Property Value
Parameter group: IP Configuration Arguments
--vnet-name

Name of the virtual network.

Property Value
Parameter group: IP Configuration 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 nic ip-config wait

Edit

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

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

Name of the network interface (NIC).

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