Share via

az connectedvmware vm nic

Note

This reference is part of the connectedvmware extension for the Azure CLI (version 2.0.67 or higher). The extension will automatically install the first time you run an az connectedvmware vm nic command. Learn more about extensions.

Vm nic.

Commands

Name Description Type Status
az connectedvmware vm nic add

Add virtual nic to a virtual machine.

 Extension GA
az connectedvmware vm nic delete

Delete virtual nic to a virtual machine.

 Extension GA
az connectedvmware vm nic list

Retrieve a list of vm nic from given resource group name and vm name.

 Extension GA
az connectedvmware vm nic show

Get details of a vm nic by it's name, resource-group and vm name.

 Extension GA
az connectedvmware vm nic update

Update virtual network interface of a virtual machine.

 Extension GA

az connectedvmware vm nic add

Add virtual nic to a virtual machine.

az connectedvmware vm nic add --name
                              --network
                              --resource-group
                              --vm-name
                              [--nic-type]
                              [--no-wait]
                              [--power-on-boot]

Examples

Add virtual nic to a virtual machine

az connectedvmware vm nic add --name "Name of the NIC" --network "Network Name or Id"                --resource-group "resource group name" --vm-name "Name of the virtual machine"

Required Parameters

--name -n

Name of the NIC.

--network

Name or Id of the virtual network.

--resource-group -g

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

--vm-name

Name of the virtual machine.

Optional Parameters

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

--nic-type

The nic type for the NIC.

Property Value
Default value: VMXNET3
--no-wait

Do not wait for the long-running operation to finish.

Property Value
Default value: False
--power-on-boot

The power on boot option for the nic.

Property Value
Default value: DISABLED
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 connectedvmware vm nic delete

Delete virtual nic to a virtual machine.

az connectedvmware vm nic delete --nics
                                 --resource-group
                                 --vm-name
                                 [--no-wait]
                                 [--yes]

Examples

Delete virtual nic to a virtual machine

az connectedvmware vm nic delete --nics "Names of the NICs" --resource-group                "resource group name" --vm-name "Name of the virtual machine"

Required Parameters

--nics

Names of the NICs.

--resource-group -g

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

--vm-name

Name of the virtual machine.

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
Default value: False
--yes -y

Do not prompt for confirmation.

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

--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 connectedvmware vm nic list

Retrieve a list of vm nic from given resource group name and vm name.

az connectedvmware vm nic list --resource-group
                               --vm-name

Examples

Retrieve a list of vm nic

az connectedvmware vm nic list --resource-group "resource group name" --vm-name                "Name of the virtual machine"

Required Parameters

--resource-group -g

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

--vm-name

Name of the virtual machine.

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 connectedvmware vm nic show

Get details of a vm nic by it's name, resource-group and vm name.

az connectedvmware vm nic show --name
                               --resource-group
                               --vm-name

Examples

Get details of vm nic

az connectedvmware vm nic show --name "Name of the NIC" --resource-group                "resource group name" --vm-name "Name of the virtual machine"

Required Parameters

--name -n

Name of the NIC.

--resource-group -g

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

--vm-name

Name of the virtual machine.

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 connectedvmware vm nic update

Update virtual network interface of a virtual machine.

az connectedvmware vm nic update --resource-group
                                 --vm-name
                                 [--device-key]
                                 [--name]
                                 [--network]
                                 [--no-wait]
                                 [--power-on-boot]

Required Parameters

--resource-group -g

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

--vm-name

Name of the virtual machine.

Optional Parameters

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

--device-key

The device key for the nic.

--name -n

Name of the NIC.

--network

Name or Id of the virtual network.

--no-wait

Do not wait for the long-running operation to finish.

Property Value
Default value: False
--power-on-boot

The power on boot option for the nic.

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