ComputeNode.GetRDPFileAsync Method

Definition

Namespace:

Microsoft.Azure.Batch

Assembly:

Microsoft.Azure.Batch.dll

Package:

Microsoft.Azure.Batch v16.2.0

Overloads

GetRDPFileAsync(Stream, IEnumerable<BatchClientBehavior>, CancellationToken)	Begins an asynchronous call to get RDP file data targeting the compute node of the current instance and write them to a specified Stream.
GetRDPFileAsync(String, IEnumerable<BatchClientBehavior>, CancellationToken)	Begins an asynchronous call to get RDP file data targeting the compute node of the current instance and write them to a file with the specified name.

GetRDPFileAsync(Stream, IEnumerable<BatchClientBehavior>, CancellationToken)

Source:

ComputeNode.cs

Begins an asynchronous call to get RDP file data targeting the compute node of the current instance and write them to a specified Stream.

public System.Threading.Tasks.Task GetRDPFileAsync (System.IO.Stream rdpStream, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default, System.Threading.CancellationToken cancellationToken = default);

member this.GetRDPFileAsync : System.IO.Stream * seq<Microsoft.Azure.Batch.BatchClientBehavior> * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Function GetRDPFileAsync (rdpStream As Stream, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task

Parameters

rdpStream

Stream

The Stream into which the RDP file data will be written. This stream will not be closed or rewound by this call.

additionalBehaviors

IEnumerable<BatchClientBehavior>

A collection of BatchClientBehavior instances that are applied after the CustomBehaviors on the current object.

cancellationToken

CancellationToken

A CancellationToken for controlling the lifetime of the asynchronous operation.

Returns

Task

A Task object that represents the asynchronous operation.

GetRDPFileAsync(String, IEnumerable<BatchClientBehavior>, CancellationToken)

Source:

ComputeNode.cs

Begins an asynchronous call to get RDP file data targeting the compute node of the current instance and write them to a file with the specified name.

public System.Threading.Tasks.Task GetRDPFileAsync (string rdpFileNameToCreate, System.Collections.Generic.IEnumerable<Microsoft.Azure.Batch.BatchClientBehavior> additionalBehaviors = default, System.Threading.CancellationToken cancellationToken = default);

member this.GetRDPFileAsync : string * seq<Microsoft.Azure.Batch.BatchClientBehavior> * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Function GetRDPFileAsync (rdpFileNameToCreate As String, Optional additionalBehaviors As IEnumerable(Of BatchClientBehavior) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task

Parameters

rdpFileNameToCreate

String

The name of the RDP file to be created.

additionalBehaviors

IEnumerable<BatchClientBehavior>

A collection of BatchClientBehavior instances that are applied after the CustomBehaviors on the current object.

cancellationToken

CancellationToken

A CancellationToken for controlling the lifetime of the asynchronous operation.

Returns

Task

A Task object that represents the asynchronous operation.