az network nic
Manage network interfaces.
To learn more about network interfaces in Azure visit https://docs.microsoft.com/azure/virtual-network/virtual-network-network-interface.
Commands
az network nic create |
Create a network interface. |
az network nic delete |
Delete a network interface. |
az network nic ip-config |
Manage IP configurations of a network interface. |
az network nic ip-config address-pool |
Manage address pools in an IP configuration. |
az network nic ip-config address-pool add |
Add an address pool to an IP configuration. |
az network nic ip-config address-pool remove |
Remove an address pool of an IP configuration. |
az network nic ip-config create |
Create an IP configuration. |
az network nic ip-config delete |
Delete an IP configuration. |
az network nic ip-config inbound-nat-rule |
Manage inbound NAT rules of an IP configuration. |
az network nic ip-config inbound-nat-rule add |
Add an inbound NAT rule to an IP configuration. |
az network nic ip-config inbound-nat-rule remove |
Remove an inbound NAT rule of an IP configuration. |
az network nic ip-config list |
List the IP configurations of a NIC. |
az network nic ip-config show |
Show the details of an IP configuration. |
az network nic ip-config update |
Update an IP configuration. |
az network nic list |
List network interfaces. |
az network nic list-effective-nsg |
List all effective network security groups applied to a network interface. |
az network nic show |
Get the details of a network interface. |
az network nic show-effective-route-table |
Show the effective route table applied to a network interface. |
az network nic update |
Update a network interface. |
az network nic vtap-config |
Manage virtual network tap configurations. |
az network nic vtap-config create |
Create a virtual network tap configuration. |
az network nic vtap-config delete |
Delete a virtual network tap configuration. |
az network nic vtap-config list |
List virtual network tap configurations. |
az network nic vtap-config show |
Get details of a virtual network tap configuration. |
az network nic wait |
Place the CLI in a waiting state until a condition of the network interface is met. |
az network nic create
Create a network interface.
az network nic create --name
--resource-group
--subnet
[--accelerated-networking {false, true}]
[--app-gateway-address-pools]
[--application-security-groups]
[--dns-servers]
[--edge-zone]
[--gateway-name]
[--internal-dns-name]
[--ip-forwarding {false, true}]
[--lb-address-pools]
[--lb-inbound-nat-rules]
[--lb-name]
[--location]
[--network-security-group]
[--no-wait]
[--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
The network interface (NIC).
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of an existing subnet. If name specified, 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
Enable accelerated networking.
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.
Space-separated list of application security groups.
Space-separated list of DNS server IP addresses.
The name of edge zone.
The name of the application gateway to use when adding address pools by name (ignored when IDs are specified).
The internal DNS name label.
Enable IP forwarding.
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.
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.
The name of the load balancer to use when adding NAT rules or address pools by name (ignored when IDs are specified).
Location. Values from: az account list-locations
. You can configure the default location using az configure --defaults location=<location>
.
Name or ID of an existing network security group, or none by default.
Do not wait for the long-running operation to finish.
Static private IP address to use.
The private IP address version to use.
Name or ID of an existing public IP address, or none by default.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
The virtual network (VNet) name.
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 nic delete
Delete a network interface.
az network nic delete [--ids]
[--name]
[--no-wait]
[--resource-group]
[--subscription]
Examples
Delete a network interface.
az network nic delete -g MyResourceGroup -n MyNic
Optional Parameters
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.
The network interface (NIC).
Do not wait for the long-running operation to finish.
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
.
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 nic list
List network interfaces.
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
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
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 nic list-effective-nsg
List all effective network security groups applied to a network interface.
To learn more about troubleshooting using effective security rules visit https://docs.microsoft.com/azure/virtual-network/virtual-network-nsg-troubleshoot-portal.
az network nic list-effective-nsg [--ids]
[--name]
[--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
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.
The network interface (NIC).
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
.
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 nic show
Get the details of a network interface.
az network nic show [--expand]
[--ids]
[--name]
[--resource-group]
[--subscription]
Examples
Get the internal domain name suffix of a NIC.
az network nic show -g MyResourceGroup -n MyNic --query "dnsSettings.internalDomainNameSuffix"
Optional Parameters
Expands referenced resources. Default value is None.
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.
The network interface (NIC).
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
.
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 nic show-effective-route-table
Show the effective route table applied to a network interface.
To learn more about troubleshooting using the effective route tables visit https://docs.microsoft.com/azure/virtual-network/virtual-network-routes-troubleshoot-portal#using-effective-routes-to-troubleshoot-vm-traffic-flow.
az network nic show-effective-route-table [--ids]
[--name]
[--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
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.
The network interface (NIC).
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
.
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 nic update
Update a network interface.
az network nic update [--accelerated-networking {false, true}]
[--add]
[--dns-servers]
[--force-string]
[--ids]
[--internal-dns-name]
[--ip-forwarding {false, true}]
[--name]
[--network-security-group]
[--no-wait]
[--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
Update a network interface. (autogenerated)
az network nic update --accelerated-networking true --name MyNic --resource-group MyResourceGroup
Optional Parameters
Enable accelerated networking.
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>.
Space-separated list of DNS server IP addresses. Use ""('""' in PowerShell) to revert to default Azure servers.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
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.
The internal DNS name label.
Enable IP forwarding.
The network interface (NIC).
Name or ID of the associated network security group.
Do not wait for the long-running operation to finish.
Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Update an object by specifying a property path and value to set. Example: --set property1.property2=.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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 nic wait
Place the CLI in a waiting state until a condition of the network interface is met.
az network nic wait [--created]
[--custom]
[--deleted]
[--exists]
[--expand]
[--ids]
[--interval]
[--name]
[--resource-group]
[--subscription]
[--timeout]
[--updated]
Examples
Pause CLI until the network interface is created.
az network nic wait -g MyResourceGroup -n MyNic --created
Place the CLI in a waiting state until a condition of the network interface is met. (autogenerated)
az network nic wait --deleted --name MyNic --resource-group MyResourceGroup --subscription MySubscription
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.
Expands referenced resources. Default value is None.
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 network interface (NIC).
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'.
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.
Feedback
Submit and view feedback for