This browser is no longer supported.
Upgrade to Microsoft Edge to take advantage of the latest features, security updates, and technical support.
Download Microsoft Edge
More info about Internet Explorer and Microsoft Edge
--resource-group
--subnet
[--accelerated-networking {0, 1, f, false, n, no, t, true, y, yes}]
[--ag-address-pools]
[--application-security-groups]
[--dns-servers]
[--edge-zone]
[--gateway-name]
[--internal-dns-name]
[--ip-forwarding {0, 1, f, false, n, no, t, true, y, yes}]
[--lb-address-pools]
[--lb-inbound-nat-rules]
[--lb-name]
[--location]
[--network-security-group]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--private-ip-address]
[--private-ip-address-version {IPv4, IPv6}]
[--public-ip-address]
[--tags]
[--vnet-name]
Examples
Create a network interface for a specified subnet on a specified virtual network.
az network nic create -g MyResourceGroup --vnet-name MyVnet --subnet MySubnet -n MyNic
Create a network interface for a specified subnet on a virtual network which allows IP forwarding subject to a network security group.
az network nic create -g MyResourceGroup --vnet-name MyVnet --subnet MySubnet -n MyNic --ip-forwarding --network-security-group MyNsg
Create a network interface for a specified subnet on a virtual network with network security group and application security groups.
az network nic create -g MyResourceGroup --vnet-name MyVnet --subnet MySubnet -n MyNic --network-security-group MyNsg --application-security-groups Web App
Required Parameters
--name -n
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>
.
--subnet
Name or ID of an existing subnet. If name specified, please also specify
--vnet-name
; If you want to use an existing subnet in other resource group, please provide the ID instead of the name of the subnet.
Optional Parameters
--accelerated-networking
Whether to enable accelerated networking.
accepted values:
0, 1, f, false, n, no, t, true, y, yes
--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.
--application-security-groups --asgs
Space-separated list of application security groups. Support shorthand-syntax, json-file and yaml-file. Try
??
to show more.
--dns-servers
Space-separated list of DNS server IP addresses. Support shorthand-syntax, json-file and yaml-file. Try
??
to show more.
--edge-zone
Name of edge zone.
--gateway-name
Name of the application gateway.
--internal-dns-name
Name of internal DNS label.
--ip-forwarding
Whether to enable IP forwarding.
accepted values:
0, 1, f, false, n, no, t, true, y, yes
--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.
--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.
--lb-name
Name of the load balancer.
--location -l
Location. Values from:
az account list-locations
. You can configure the default location using
az configure --defaults location=<location>
.
--network-security-group
Name or ID of an existing network security group.
--no-wait
Do not wait for the long-running operation to finish.
accepted values:
0, 1, f, false, n, no, t, true, y, yes
--private-ip-address
Static private IP address to use.
--private-ip-address-version
Version of private IP address to use.
accepted values:
IPv4, IPv6
default value:
IPv4
--public-ip-address
Name or ID of an existing public IP address.
--tags
Space-separated tags: key[=value] [key[=value] ...]. Support shorthand-syntax, json-file and yaml-file. Try
??
to show more.
--vnet-name
Name of the virtual network.
--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 delete [--ids]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
Examples
Delete a network interface.
az network nic delete -g MyResourceGroup -n MyNic
Optional Parameters
--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.
--name -n
Name of the network interface (NIC).
--no-wait
Do not wait for the long-running operation to finish.
accepted values:
0, 1, f, false, n, no, t, true, y, yes
--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
.
--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.
To list network interfaces attached to VMs in VM scale sets use
az vmss nic list
or
az vmss nic list-vm-nics
.
az network nic list [--resource-group]
Examples
List all NICs by internal DNS suffix.
az network nic list --query "[?dnsSettings.internalDomainNameSuffix=`{dnsSuffix}`]"
Optional Parameters
--resource-group -g
Name of resource group. You can configure the default group using
az configure --defaults group=<name>
.
--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.
To learn more about troubleshooting using effective security rules visit
https://learn.microsoft.com/en-us/azure/virtual-network/diagnose-network-traffic-filter-problem
.
az network nic list-effective-nsg [--ids]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
Examples
List the effective security groups associated with a NIC.
az network nic list-effective-nsg -g MyResourceGroup -n MyNic
Optional Parameters
--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.
--name -n
Name of the network interface (NIC).
--no-wait
Do not wait for the long-running operation to finish.
accepted values:
0, 1, f, false, n, no, t, true, y, yes
--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
.
--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.
Examples
Get the internal domain name suffix of a NIC.
az network nic show -g MyResourceGroup -n MyNic --query "dnsSettings.internalDomainNameSuffix"
Optional Parameters
--expand
Expands referenced resources.
--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.
--name -n
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
.
--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.
To learn more about troubleshooting using the effective route tables visit
https://learn.microsoft.com/en-us/azure/virtual-network/diagnose-network-routing-problem#using-effective-routes-to-troubleshoot-vm-traffic-flow
.
az network nic show-effective-route-table [--ids]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
Examples
Show the effective routes applied to a network interface.
az network nic show-effective-route-table -g MyResourceGroup -n MyNic
Optional Parameters
--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.
--name -n
Name of the network interface (NIC).
--no-wait
Do not wait for the long-running operation to finish.
accepted values:
0, 1, f, false, n, no, t, true, y, yes
--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
.
--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 update [--accelerated-networking {0, 1, f, false, n, no, t, true, y, yes}]
[--add]
[--dns-servers]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--internal-dns-name]
[--ip-configurations]
[--ip-forwarding {0, 1, f, false, n, no, t, true, y, yes}]
[--name]
[--network-security-group]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--remove]
[--resource-group]
[--set]
[--subscription]
Examples
Update a network interface to use a different network security group.
az network nic update -g MyResourceGroup -n MyNic --network-security-group MyNewNsg
Optional Parameters
--accelerated-networking
Whether to enable accelerated networking.
accepted values:
0, 1, f, false, n, no, t, true, y, yes
--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>.
--dns-servers
Space-separated list of DNS server IP addresses. Use null to revert to default Azure servers. Support shorthand-syntax, json-file and yaml-file. Try
??
to show more.
--force-string
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
accepted values:
0, 1, f, false, n, no, t, true, y, yes
--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.
--internal-dns-name
Name of internal DNS label.
--ip-configurations
List of IP configurations of the network interface. Support shorthand-syntax, json-file and yaml-file. Try
??
to show more.
--ip-forwarding
Whether to enable IP forwarding.
accepted values:
0, 1, f, false, n, no, t, true, y, yes
--name -n
Name of the network interface (NIC).
--network-security-group
Name or ID of an existing network security group.
--no-wait
Do not wait for the long-running operation to finish.
accepted values:
0, 1, f, false, n, no, t, true, y, yes
--remove
Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.
--resource-group -g
Name of resource group. You can configure the default group using
az configure --defaults group=<name>
.
--set
Update an object by specifying a property path and value to set. Example: --set property1.property2=.
--subscription
Name or ID of subscription. You can configure the default subscription using
az account set -s NAME_OR_ID
.
--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.
--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
--expand
Expands referenced resources.
--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
--name -n
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.
--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.
