az networkcloud virtualmachine console
Note
This reference is part of the networkcloud extension for the Azure CLI (version 2.51.0 or higher). The extension will automatically install the first time you run an az networkcloud virtualmachine console command. Learn more about extensions.
Command group 'az networkcloud' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Manage virtual machine's console.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az networkcloud virtualmachine console create |
Create a new virtual machine console or update the properties of the existing virtual machine console. |
Extension | Preview |
| az networkcloud virtualmachine console delete |
Delete the provided virtual machine console. |
Extension | Preview |
| az networkcloud virtualmachine console list |
List consoles of the virtual machine. |
Extension | Preview |
| az networkcloud virtualmachine console show |
Get properties of the provided virtual machine console. |
Extension | Preview |
| 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 | Preview |
| az networkcloud virtualmachine console wait |
Place the CLI in a waiting state until a condition is met. |
Extension | Preview |
az networkcloud virtualmachine console create
Command group 'az networkcloud' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Create a new virtual machine console or update the properties of the existing virtual machine console.
A single console is allowed for each virtual machine and is always named 'default'.
az networkcloud virtualmachine console create --enabled {False, True}
--extended-location
--resource-group
--ssh-public-key
--virtual-machine-name
[--expiration]
[--location]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--tags]Examples
Create or update virtual machine console
az networkcloud virtualmachine console create --extended-location name="/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" type="CustomLocation" --location "location" --enabled "True" --expiration "2024-06-01T01:27:03.008Z" --ssh-public-key key-data="ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" --tags key1="myvalue1" key2="myvalue2" --resource-group "resourceGroupName" --virtual-machine-name "virtualMachineName"Create or update virtual machine console with SSH key file
az networkcloud virtualmachine console create --extended-location name="/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName" type="CustomLocation" --location "location" --enabled "True" --expiration "2024-06-01T01:27:03.008Z" --ssh-public-key key-data=~/.ssh/id_rsa.pub --tags key1="myvalue1" key2="myvalue2" --resource-group "resourceGroupName" --virtual-machine-name "virtualMachineName"Required Parameters
The indicator of whether the console access is enabled.
The extended location of the cluster manager associated with the cluster this virtual machine is created on. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The SSH public key that will be provisioned for user access. The user is expected to have the corresponding SSH private key for logging in. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The name of the virtual machine.
Optional Parameters
The date and time after which the key will be disallowed access.
The geo-location where the resource lives When not specified, the location of the resource group will be used.
Do not wait for the long-running operation to finish.
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Global Parameters
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 networkcloud virtualmachine console delete
Command group 'az networkcloud' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Delete the provided virtual machine console.
az networkcloud virtualmachine console delete [--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
[--virtual-machine-name]
[--yes]Examples
Delete virtual machine console
az networkcloud virtualmachine console delete --resource-group "resourceGroupName" --virtual-machine-name "virtualMachineName"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.
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.
The name of the virtual machine.
Do not prompt for confirmation.
Global Parameters
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 networkcloud virtualmachine console list
Command group 'az networkcloud' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
List consoles of the virtual machine.
az networkcloud virtualmachine console list --resource-group
--virtual-machine-name
[--max-items]
[--next-token]Examples
List consoles of the virtual machine
az networkcloud virtualmachine console list --resource-group "resourceGroupName" --virtual-machine-name "virtualMachineName"Required Parameters
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The name of the virtual machine.
Optional Parameters
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.
Token to specify where to start paginating. This is the token value from a previously truncated response.
Global Parameters
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 networkcloud virtualmachine console show
Command group 'az networkcloud' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Get properties of the provided virtual machine console.
az networkcloud virtualmachine console show [--ids]
[--resource-group]
[--subscription]
[--virtual-machine-name]Examples
Get virtual machine console
az networkcloud virtualmachine console show --resource-group "resourceGroupName" --virtual-machine-name "virtualMachineName"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.
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.
The name of the virtual machine.
Global Parameters
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 networkcloud virtualmachine console update
Command group 'az networkcloud' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
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.
az networkcloud virtualmachine console update [--enabled {False, True}]
[--expiration]
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--ssh-public-key]
[--subscription]
[--tags]
[--virtual-machine-name]Examples
Patch virtual machine console
az networkcloud virtualmachine console update --enabled "True" --expiration "2022-06-01T01:27:03.008Z" --ssh-public-key key-data="ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm" --tags key1="myvalue1" key2="myvalue2" --resource-group "resourceGroupName" --virtual-machine-name "virtualMachineName"Patch virtual machine console with SSH key file
az networkcloud virtualmachine console update --enabled "True" --expiration "2022-06-01T01:27:03.008Z" --ssh-public-key key-data=~/.ssh/id_rsa.pub --tags key1="myvalue1" key2="myvalue2" --resource-group "resourceGroupName" --virtual-machine-name "virtualMachineName"Optional Parameters
The indicator of whether the console access is enabled.
The date and time after which the key will be disallowed access.
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.
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>.
The SSH public key that will be provisioned for user access. The user is expected to have the corresponding SSH private key for logging in. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
The Azure resource tags that will replace the existing ones. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The name of the virtual machine.
Global Parameters
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 networkcloud virtualmachine console wait
Command group 'az networkcloud' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Place the CLI in a waiting state until a condition is met.
az networkcloud virtualmachine console wait [--console-name]
[--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--resource-group]
[--subscription]
[--timeout]
[--updated]
[--virtual-machine-name]Optional Parameters
The name of the virtual machine console.
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.
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.
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'.
The name of the virtual machine.
Global Parameters
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
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for