az batch node remote-desktop

Retrieve the remote desktop protocol file for a Batch compute node.

Commands

Name	Description	Type	Status
az batch node remote-desktop download	Gets the Remote Desktop Protocol file for the specified Compute Node.	Core	GA

az batch node remote-desktop download

Gets the Remote Desktop Protocol file for the specified Compute Node.

Before you can access a Compute Node by using the RDP file, you must create a user Account on the Compute Node. This API can only be invoked on Pools created with a cloud service configuration. For Pools created with a virtual machine configuration, see the GetRemoteLoginSettings API.

az batch node remote-desktop download --destination
                                      --node-id
                                      --pool-id
                                      [--account-endpoint]
                                      [--account-key]
                                      [--account-name]

Required Parameters

--destination

The path to the destination file or directory.

--node-id

The ID of the Compute Node for which you want to get the Remote Desktop Protocol file.

--pool-id

The ID of the Pool that contains the Compute Node.

Optional Parameters

--account-endpoint

Batch service endpoint. Alternatively, set by environment variable: AZURE_BATCH_ENDPOINT.

--account-key

Batch account key. Alternatively, set by environment variable: AZURE_BATCH_ACCESS_KEY.

--account-name

Batch account name. Alternatively, set by environment variable: AZURE_BATCH_ACCOUNT.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

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