az stack-hci-vm vmconnect

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 vmconnect command. Learn more about extensions.

Manage VM Connect functionality for virtual machines.

Commands

Name	Description	Type	Status
az stack-hci-vm vmconnect disable	Disable VM Connect for a virtual machine.	Extension	Preview
az stack-hci-vm vmconnect enable	Enable VM Connect and generate RDP file to connect to the VM.	Extension	Preview

az stack-hci-vm vmconnect disable

Preview

This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Disable VM Connect for a virtual machine.

az stack-hci-vm vmconnect disable --cluster-resource-group
                                  [--acquire-policy-token]
                                  [--change-reference]
                                  [--cluster-name]
                                  [--ids]
                                  [--name]
                                  [--resource-group]
                                  [--subscription]

Examples

Disable VM Connect for a virtual machine

az stack-hci-vm vmconnect disable --resource-group "test-rg" --name "test-vm" --cluster-name "test-cluster" --cluster-resource-group "cluster-rg"

Required Parameters

--cluster-resource-group

Name of the resource group containing the Azure Stack HCI cluster.

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--cluster-name

Name of the Azure Stack HCI cluster.

Property	Value
Parameter group:	Resource Id Arguments

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

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 stack-hci-vm vmconnect enable