Remote desktop protocols for batch compute nodes - az batch node remote-desktop

Retrieve the remote desktop protocol for a Batch compute node.

Commands

az batch node remote-desktop download Gets the Remote Desktop Protocol file for the specified compute node.

az batch node remote-desktop download

Before you can access a node by using the RDP file, you must create a user account on the node. This API can only be invoked on pools created with the cloud service configuration property.

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.