az stack-hci-vm network nic
Note
This reference is part of the stack-hci-vm extension for the Azure CLI (version 2.15.0 or higher). The extension will automatically install the first time you run an az stack-hci-vm network nic command. Learn more about extensions.
Manage networkinterface with stack-hci-vm.
Commands
Name | Description | Type | Status |
---|---|---|---|
az stack-hci-vm network nic create |
Create a network interface. |
Extension | GA |
az stack-hci-vm network nic delete |
Delete a network interface. |
Extension | GA |
az stack-hci-vm network nic list |
List all network interfaces. |
Extension | GA |
az stack-hci-vm network nic show |
Get the details of a network interface. |
Extension | GA |
az stack-hci-vm network nic update |
Update a network interface. |
Extension | GA |
az stack-hci-vm network nic create
Create a network interface.
az stack-hci-vm network nic create --custom-location
--name
--resource-group
[--dns-servers]
[--ip-address]
[--ip-configurations]
[--location]
[--mac-address]
[--network-security-group --nsg]
[--polling-interval]
[--subnet-id]
[--tags]
Examples
Without ip configurations provided
az stack-hci-vm network nic create --resource-group "test-rg" --custom-location "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location" --location "West US2" --subnet-id "test-lnet" --ip-address "10.0.0.0" --name "test-nic"
Required Parameters
The ID of the extended location.
Name of the network interface.
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.
Space-separated list of DNS server IP addresses.
Usage: --dns-servers 10.220.32.16 10.220.32.17.
Ip_address - Private IP address of the IP configuration.
Usage: --ip-address "1.2.3.4".
IPConfigurations - A list of IPConfigurations of the network interface. Expected value: json-string/@json-file.
If location is not specified, the location of the resource group is used.
MacAddress - The MAC address of the network interface.
Name or ID of a network security group (NSG).
Usage: --network-security-group "myNSG".
ARM polling interval for long running operations.
ID of the subnet or network to create the network interface on.
Usage: --subnet-id "test-lnet" The subnet-id provided will be ignored if ip-configurations parameter is also provided.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
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 stack-hci-vm network nic delete
Delete a network interface.
az stack-hci-vm network nic delete [--ids]
[--name]
[--polling-interval]
[--resource-group]
[--subscription]
[--yes]
Examples
DeleteNetworkInterface
az stack-hci-vm network nic delete --name "test-nic" --resource-group "test-rg"
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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 |
Name of the network interface.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
ARM polling interval for long running operations.
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 |
Do not prompt for confirmation.
Property | Value |
---|---|
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 |
az stack-hci-vm network nic list
List all network interfaces.
az stack-hci-vm network nic list [--resource-group]
Examples
ListNetworkInterfaceByResourceGroup
az stack-hci-vm network nic list --resource-group "test-rg"
ListNetworkInterfaceBySubscription
az stack-hci-vm network nic list
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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 stack-hci-vm network nic show
Get the details of a network interface.
az stack-hci-vm network nic show [--ids]
[--name]
[--resource-group]
[--subscription]
Examples
GetNetworkInterface
az stack-hci-vm network nic show --name "test-nic" --resource-group "test-rg"
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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 |
Name of the network interface.
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 |
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 |
az stack-hci-vm network nic update
Update a network interface.
az stack-hci-vm network nic update [--add]
[--force-string]
[--ids]
[--name]
[--network-security-group --nsg]
[--remove]
[--resource-group]
[--set]
[--subscription]
[--tags]
Examples
UpdateNetworkInterface
az stack-hci-vm network nic update --tags additionalProperties="sample" --name "test-nic" --resource-group "test-rg --network-security-group myNSG"
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 |
Default value: | [] |
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
Property | Value |
---|---|
Parameter group: | Generic Update 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 |
Name of the network interface.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name or ID of a network security group (NSG).
Usage: --network-security-group "myNSG".
Remove a property or an element from a list. Example: --remove property.list <indexToRemove>
OR --remove propertyToRemove
.
Property | Value |
---|---|
Parameter group: | Generic Update Arguments |
Default value: | [] |
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Property | Value |
---|---|
Parameter group: | Resource Id 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 |
Default value: | [] |
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 |
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
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 |