Share via

az networkcloud virtualmachine

Note

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

Manage virtual machine.

Commands

Name Description Type Status
az networkcloud virtualmachine console

Manage virtual machine's console.

 Extension GA
az networkcloud virtualmachine console create

Create a new virtual machine console or update the properties of the existing virtual machine console.

 Extension GA
az networkcloud virtualmachine console delete

Delete the provided virtual machine console.

 Extension GA
az networkcloud virtualmachine console list

List consoles of the virtual machine.

 Extension GA
az networkcloud virtualmachine console show

Get properties of the provided virtual machine console.

 Extension GA
az networkcloud virtualmachine console update

Update the properties of the provided virtual machine console, or update the tags associated with the virtual machine console. Properties and tag updates can be done independently.

 Extension GA
az networkcloud virtualmachine console wait

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

 Extension GA
az networkcloud virtualmachine create

Create a new virtual machine or update the properties of the existing virtual machine.

 Extension GA
az networkcloud virtualmachine delete

Delete the provided virtual machine.

 Extension GA
az networkcloud virtualmachine list

List virtual machines in the provided resource group or subscription.

 Extension GA
az networkcloud virtualmachine power-off

Power off the provided virtual machine.

 Extension GA
az networkcloud virtualmachine reimage

Reimage the provided virtual machine.

 Extension GA
az networkcloud virtualmachine restart

Restart the provided virtual machine.

 Extension GA
az networkcloud virtualmachine show

Get properties of the provided virtual machine.

 Extension GA
az networkcloud virtualmachine start

Start the provided virtual machine.

 Extension GA
az networkcloud virtualmachine update

Update the properties of the provided virtual machine, or update the tags associated with the virtual machine. Properties and tag updates can be done independently.

 Extension GA
az networkcloud virtualmachine wait

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

 Extension GA

az networkcloud virtualmachine create

Create a new virtual machine or update the properties of the existing virtual machine.

az networkcloud virtualmachine create --admin-username
                                      --cloud-services-network-attachment --csn
                                      --cpu-cores
                                      --extended-location
                                      --memory-size --memory-size-gb --memory-size-gib
                                      --name --virtual-machine-name
                                      --resource-group
                                      --storage-profile
                                      --vm-image
                                      [--boot-method {BIOS, UEFI}]
                                      [--ce-location --console-extended-location]
                                      [--generate-ssh-keys {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--if-match]
                                      [--if-none-match]
                                      [--location]
                                      [--na --network-attachments]
                                      [--nd --network-data]
                                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--ph --placement-hints]
                                      [--ssh-dest-key-path]
                                      [--ssh-key-values]
                                      [--tags]
                                      [--ud --user-data]
                                      [--vm-device-model {T1, T2, T3}]
                                      [--vm-image-repository-credentials --vmi-creds]

Examples

Create virtual machine

az networkcloud virtualmachine create --resource-group "resourceGroupName" --name "virtualMachineName" --extended-location name="/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" type="CustomLocation" --location "location" --admin-username "admin" --boot-method "UEFI" --cloud-services-network-attachment attached-network-id="/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/CloudServicesNetworks/cloudServicesNetworkName" --cpu-cores 2 --memory-size 8 --network-attachments "[{attachedNetworkId:'/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/l3Networks/l3NetworkName',defaultGateway:'True',ipAllocationMethod:'Dynamic',ipv4Address:'198.51.100.1',ipv6Address:'2001:0db8:0000:0000:0000:0000:0000:0000',networkAttachmentName:'networkAttachmentName'}]" --network-data "bmV0d29ya0RhdGVTYW1wbGU=" --placement-hints "[{hintType:'Affinity',resourceId:'/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName',schedulingExecution:'Hard,scope:''}]" --ssh-key-values "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT= admin@vm" --storage-profile disk-size=120 create-option="Ephemeral" delete-option="Delete" --tags key1="myvalues1" --tags key2="myvalues2" --user-data "dXNlckRhdGVTYW1wbGU=" --vm-device-model "T2" --vm-image "myacr.azurecr.io/ubuntu-pw:20.04" --vm-image-repository-credentials password="password" registry-url="myacr.azurecr.io" username="username"

Required Parameters

--admin-username

The name of the administrator to which the ssh public keys will be added into the authorized keys.

Property Value
Parameter group: Authentication Arguments
--cloud-services-network-attachment --csn

The cloud service network that provides platform-level services for the virtual machine. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--cpu-cores

The number of CPU cores in the virtual machine.

Property Value
Parameter group: Properties Arguments
--extended-location

The extended location of the cluster associated with the resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: VirtualMachineParameters Arguments
--memory-size --memory-size-gb --memory-size-gib

The memory size of the virtual machine in gibibytes.

Property Value
Parameter group: Properties Arguments
--name --virtual-machine-name -n

The name of the virtual machine.

--resource-group -g

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

--storage-profile

The storage profile that specifies size and other parameters about the disks related to the virtual machine. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--vm-image

The virtual machine image that is currently provisioned to the OS disk, using the full url and tag notation used to pull the image.

Property Value
Parameter group: Properties Arguments

Optional Parameters

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

--boot-method

Selects the boot method for the virtual machine.

Property Value
Parameter group: Properties Arguments
Default value: UEFI
Accepted values: BIOS, UEFI
--ce-location --console-extended-location

The extended location to use for creation of a VM console resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--generate-ssh-keys

Generate SSH public and private key files if missing. The keys will be stored under '~/.ssh'.

Property Value
Parameter group: Authentication Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--if-match

The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.

--if-none-match

Set to '*' to allow a new record set to be created, but to prevent updating an existing resource. Other values will result in error from server as they are not supported.

--location -l

The geo-location where the resource lives When not specified, the location of the resource group will be used.

Property Value
Parameter group: VirtualMachineParameters Arguments
--na --network-attachments

The list of network attachments to the virtual machine. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--nd --network-data

The Base64 encoded cloud-init network data.

Property Value
Parameter group: Properties Arguments
--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
--ph --placement-hints

The scheduling hints for the virtual machine. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--ssh-dest-key-path

The list of space-separated paths to ssh public keys. A file path can be provided or a directory. If a directory is provided will attempt to load all the public keys (.pub) found. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Authentication Arguments
--ssh-key-values

The list of space-separated SSH public keys. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Authentication Arguments
--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: VirtualMachineParameters Arguments
--ud --user-data

The Base64 encoded cloud-init user data.

Property Value
Parameter group: Properties Arguments
--vm-device-model

The type of the device model to use.

Property Value
Parameter group: Properties Arguments
Default value: T2
Accepted values: T1, T2, T3
--vm-image-repository-credentials --vmi-creds

The credentials used to login to the image repository that has access to the specified image. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties 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 networkcloud virtualmachine delete

Delete the provided virtual machine.

az networkcloud virtualmachine delete [--ids]
                                      [--if-match]
                                      [--if-none-match]
                                      [--name --virtual-machine-name]
                                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--resource-group]
                                      [--subscription]
                                      [--yes]

Examples

Delete virtual machine

az networkcloud virtualmachine delete --resource-group "resourceGroupName" --name "virtualMachineName"

Optional Parameters

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

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

The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.

--if-none-match

Set to '*' to allow a new record set to be created, but to prevent updating an existing resource. Other values will result in error from server as they are not supported.

--name --virtual-machine-name -n

The name of the virtual machine.

Property Value
Parameter group: Resource Id Arguments
--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
--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
--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.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az networkcloud virtualmachine list

List virtual machines in the provided resource group or subscription.

az networkcloud virtualmachine list [--max-items]
                                    [--next-token]
                                    [--resource-group]

Examples

List virtual machines for resource group

az networkcloud virtualmachine list --resource-group "resourceGroupName"

List virtual machines for subscription

az networkcloud virtualmachine 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.

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

Property Value
Parameter group: Pagination Arguments
--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Property Value
Parameter group: Pagination Arguments
--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 networkcloud virtualmachine power-off

Power off the provided virtual machine.

az networkcloud virtualmachine power-off [--ids]
                                         [--name --virtual-machine-name]
                                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--resource-group]
                                         [--skip-shutdown {False, True}]
                                         [--subscription]

Examples

Power off virtual machine

az networkcloud virtualmachine power-off --resource-group "resourceGroupName" --name "virtualMachineName" --skip-shutdown "True"

Optional Parameters

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

--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
--name --virtual-machine-name -n

The name of the virtual machine.

Property Value
Parameter group: Resource Id Arguments
--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
--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
--skip-shutdown

The indicator of whether to skip the graceful OS shutdown and power off the virtual machine immediately.

Property Value
Parameter group: VirtualMachinePowerOffParameters Arguments
Default value: False
Accepted values: False, True
--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
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

az networkcloud virtualmachine reimage

Reimage the provided virtual machine.

az networkcloud virtualmachine reimage [--ids]
                                       [--name --virtual-machine-name]
                                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--resource-group]
                                       [--subscription]

Examples

Reimage virtual machine

az networkcloud virtualmachine reimage --resource-group "resourceGroupName" --name "virtualMachineName"

Optional Parameters

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

--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
--name --virtual-machine-name -n

The name of the virtual machine.

Property Value
Parameter group: Resource Id Arguments
--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
--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
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

az networkcloud virtualmachine restart

Restart the provided virtual machine.

az networkcloud virtualmachine restart [--ids]
                                       [--name --virtual-machine-name]
                                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--resource-group]
                                       [--subscription]

Examples

Restart virtual machine

az networkcloud virtualmachine restart --resource-group "resourceGroupName" --name "virtualMachineName"

Optional Parameters

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

--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
--name --virtual-machine-name -n

The name of the virtual machine.

Property Value
Parameter group: Resource Id Arguments
--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
--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
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

az networkcloud virtualmachine show

Get properties of the provided virtual machine.

az networkcloud virtualmachine show [--ids]
                                    [--name --virtual-machine-name]
                                    [--resource-group]
                                    [--subscription]

Examples

Get virtual machine

az networkcloud virtualmachine show --resource-group "resourceGroupName" --name "virtualMachineName"

Optional Parameters

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

--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
--name --virtual-machine-name -n

The name of the virtual machine.

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

az networkcloud virtualmachine start

Start the provided virtual machine.

az networkcloud virtualmachine start [--ids]
                                     [--name --virtual-machine-name]
                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--resource-group]
                                     [--subscription]

Examples

Start virtual machine

az networkcloud virtualmachine start --resource-group "resourceGroupName" --name "virtualMachineName"

Optional Parameters

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

--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
--name --virtual-machine-name -n

The name of the virtual machine.

Property Value
Parameter group: Resource Id Arguments
--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
--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
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

az networkcloud virtualmachine update

Update the properties of the provided virtual machine, or update the tags associated with the virtual machine. Properties and tag updates can be done independently.

az networkcloud virtualmachine update [--ids]
                                      [--if-match]
                                      [--if-none-match]
                                      [--name --virtual-machine-name]
                                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--resource-group]
                                      [--subscription]
                                      [--tags]
                                      [--vm-image-repository-credentials --vmi-creds]

Examples

Patch virtual machine

az networkcloud virtualmachine update --resource-group "resourceGroupName" --name "virtualMachineName" --vm-image-repository-credentials password="password" registry-url="myacr.azurecr.io" username="myuser" --tags key1="myvalue1" key2="myvalue2"

Optional Parameters

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

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

The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.

--if-none-match

Set to '*' to allow a new record set to be created, but to prevent updating an existing resource. Other values will result in error from server as they are not supported.

--name --virtual-machine-name -n

The name of the virtual machine.

Property Value
Parameter group: Resource Id Arguments
--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
--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
--tags

The Azure resource tags that will replace the existing ones. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: VirtualMachineUpdateParameters Arguments
--vm-image-repository-credentials --vmi-creds

The credentials used to login to the image repository that has access to the specified image. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties 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.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az networkcloud virtualmachine wait

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

az networkcloud virtualmachine wait [--created]
                                    [--custom]
                                    [--deleted]
                                    [--exists]
                                    [--ids]
                                    [--interval]
                                    [--name --virtual-machine-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
--name --virtual-machine-name -n

The name of the virtual machine.

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