ComputeNode.GetRDPFileAsync Method
Definition
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.
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
A Task object that represents the asynchronous operation.
Applies to
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
A Task object that represents the asynchronous operation.
Applies to
Azure SDK for .NET
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for