ComputeNodeOperationsExtensions.GetRemoteDesktopAsync Method

Reference

Definition

Namespace:: Microsoft.Azure.Batch.Protocol

Assembly:: Microsoft.Azure.Batch.dll

Package:: Microsoft.Azure.Batch v16.2.0

Source:: ComputeNodeOperationsExtensions.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public static System.Threading.Tasks.Task<System.IO.Stream> GetRemoteDesktopAsync (this Microsoft.Azure.Batch.Protocol.IComputeNodeOperations operations, string poolId, string nodeId, Microsoft.Azure.Batch.Protocol.Models.ComputeNodeGetRemoteDesktopOptions computeNodeGetRemoteDesktopOptions = default, System.Threading.CancellationToken cancellationToken = default);

static member GetRemoteDesktopAsync : Microsoft.Azure.Batch.Protocol.IComputeNodeOperations * string * string * Microsoft.Azure.Batch.Protocol.Models.ComputeNodeGetRemoteDesktopOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.IO.Stream>

<Extension()>
Public Function GetRemoteDesktopAsync (operations As IComputeNodeOperations, poolId As String, nodeId As String, Optional computeNodeGetRemoteDesktopOptions As ComputeNodeGetRemoteDesktopOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Stream)

Parameters

operations: IComputeNodeOperations

The operations group for this extension method.

poolId: String

The ID of the Pool that contains the Compute Node.

nodeId: String

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

computeNodeGetRemoteDesktopOptions: ComputeNodeGetRemoteDesktopOptions

Additional parameters for the operation

cancellationToken: CancellationToken

The cancellation token.

Returns

Task<Stream>

Remarks

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.

Applies to

Share via