PoolOperations.GetRDPFileAsync Methode

Definition

Namespace:

Microsoft.Azure.Batch

Assembly:

Microsoft.Azure.Batch.dll

Paket:

Microsoft.Azure.Batch v16.2.0

Überlädt

GetRDPFileAsync(String, String, Stream, IEnumerable<BatchClientBehavior>, CancellationToken)	Ruft eine RDP-Datei (Remote Desktop Protocol) für den angegebenen Knoten ab.
GetRDPFileAsync(String, String, String, IEnumerable<BatchClientBehavior>, CancellationToken)	Ruft eine Remotedesktopprotokolldatei für den angegebenen Knoten ab.

GetRDPFileAsync(String, String, Stream, IEnumerable<BatchClientBehavior>, CancellationToken)

Quelle:

PoolOperations.cs

Ruft eine RDP-Datei (Remote Desktop Protocol) für den angegebenen Knoten ab.

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

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

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

Parameter

poolId

String

Die ID des Pools, der den Computeknoten enthält.

computeNodeId

String

Die ID des Computeknotens, für den eine Remotedesktopdatei abgerufen werden soll.

rdpStream

Stream

Die Stream , in die die RDP-Dateiinhalte geschrieben werden.

additionalBehaviors

IEnumerable<BatchClientBehavior>

Eine Auflistung von BatchClientBehavior Instanzen, die auf die Batch-Dienstanforderung nach CustomBehaviorsangewendet werden.

cancellationToken

CancellationToken

Ein CancellationToken zum Steuern der Lebensdauer des asynchronen Vorgangs.

Gibt zurück

Task

Ein Task-Element, das den asynchronen Vorgang darstellt.

Hinweise

Diese Methode schließt den rdpStream Stream nicht und setzt die Position nach dem Schreiben nicht zurück. Es liegt in der Verantwortung des Aufrufers, den Stream zu schließen oder die Position bei Bedarf zurückzusetzen.

Der Vorgang "RDP-Datei abrufen" wird asynchron ausgeführt.

Diese Methode kann nur aufgerufen werden, wenn der Pool mit einer CloudServiceConfiguration -Eigenschaft erstellt wird. Wenn diese Methode für Pools aufgerufen wird, die mit VirtualMachineConfigurationerstellt wurden, gibt der Batch-Dienst 409 (Konflikt) zurück. Für Pools mit VirtualMachineConfiguration -Eigenschaft muss die neue Methode GetRemoteLoginSettings(String, String, IEnumerable<BatchClientBehavior>) verwendet werden.

GetRDPFileAsync(String, String, String, IEnumerable<BatchClientBehavior>, CancellationToken)

Quelle:

PoolOperations.cs

Ruft eine Remotedesktopprotokolldatei für den angegebenen Knoten ab.

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

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

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

Parameter

poolId

String

Die ID des Pools, der den Computeknoten enthält.

computeNodeId

String

Die ID des Computeknotens, für den eine Remotedesktopdatei abgerufen werden soll.

rdpFileNameToCreate

String

Der Dateipfad, an dem die RDP-Datei erstellt werden soll.

additionalBehaviors

IEnumerable<BatchClientBehavior>

Eine Auflistung von BatchClientBehavior Instanzen, die auf die Batch-Dienstanforderung nach CustomBehaviorsangewendet werden.

cancellationToken

CancellationToken

Ein CancellationToken zum Steuern der Lebensdauer des asynchronen Vorgangs.

Gibt zurück

Task

Ein Task-Element, das den asynchronen Vorgang darstellt.

Hinweise

Wenn die von rdpFileNameToCreate angegebene Datei bereits vorhanden ist, wird sie überschrieben.

Der Vorgang "RDP-Datei abrufen" wird asynchron ausgeführt.

Diese Methode kann nur aufgerufen werden, wenn der Pool mit einer CloudServiceConfiguration -Eigenschaft erstellt wird. Wenn diese Methode für Pools aufgerufen wird, die mit VirtualMachineConfigurationerstellt wurden, gibt der Batch-Dienst 409 (Konflikt) zurück. Für Pools mit VirtualMachineConfiguration -Eigenschaft muss die neue Methode GetRemoteLoginSettingsAsync(String, String, IEnumerable<BatchClientBehavior>, CancellationToken) verwendet werden.