PoolOperations.GetRDPFileAsync メソッド

定義

名前空間:

Microsoft.Azure.Batch

アセンブリ:

Microsoft.Azure.Batch.dll

パッケージ:

Microsoft.Azure.Batch v16.2.0

オーバーロード

GetRDPFileAsync(String, String, Stream, IEnumerable<BatchClientBehavior>, CancellationToken)	指定したノードのリモート デスクトップ プロトコル (RDP) ファイルを取得します。
GetRDPFileAsync(String, String, String, IEnumerable<BatchClientBehavior>, CancellationToken)	指定したノードのリモート デスクトップ プロトコル ファイルを取得します。

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

ソース:

PoolOperations.cs

指定したノードのリモート デスクトップ プロトコル (RDP) ファイルを取得します。

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

パラメーター

poolId

String

コンピューティング ノードを含むプールの ID。

computeNodeId

String

リモート デスクトップ ファイルを取得するコンピューティング ノードの ID。

rdpStream

Stream

Stream RDP ファイルの内容の書き込み先となる 。

additionalBehaviors

IEnumerable<BatchClientBehavior>

の後の BatchClientBehavior Batch サービス要求に適用されるインスタンスの CustomBehaviorsコレクション。

cancellationToken

CancellationToken

CancellationToken非同期操作の有効期間を制御するための 。

戻り値

Task

非同期操作を表す Task。

注釈

このメソッドはストリームを rdpStream 閉じず、書き込み後に位置をリセットしません。 ストリームを閉じるか、必要に応じて位置をリセットするのは呼び出し元の責任です。

RDP ファイルの取得操作は非同期的に実行されます。

このメソッドは、プールが プロパティを使用して CloudServiceConfiguration 作成された場合にのみ呼び出すことができます。 で作成された VirtualMachineConfigurationプールでこのメソッドが呼び出された場合、Batch サービスは 409 (競合) を返します。 プロパティを持つ VirtualMachineConfiguration プールの場合は、新しいメソッド GetRemoteLoginSettings(String, String, IEnumerable<BatchClientBehavior>) を使用する必要があります。

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

ソース:

PoolOperations.cs

指定したノードのリモート デスクトップ プロトコル ファイルを取得します。

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

パラメーター

poolId

String

コンピューティング ノードを含むプールの ID。

computeNodeId

String

リモート デスクトップ ファイルを取得するコンピューティング ノードの ID。

rdpFileNameToCreate

String

RDP ファイルを作成するファイル パス。

additionalBehaviors

IEnumerable<BatchClientBehavior>

の後の BatchClientBehavior Batch サービス要求に適用されるインスタンスの CustomBehaviorsコレクション。

cancellationToken

CancellationToken

CancellationToken非同期操作の有効期間を制御するための 。

戻り値

Task

非同期操作を表す Task。

注釈

で rdpFileNameToCreate 指定されたファイルが既に存在する場合は、上書きされます。

RDP ファイルの取得操作は非同期的に実行されます。

このメソッドは、プールが プロパティを使用して CloudServiceConfiguration 作成された場合にのみ呼び出すことができます。 で作成された VirtualMachineConfigurationプールでこのメソッドが呼び出された場合、Batch サービスは 409 (競合) を返します。 プロパティを持つ VirtualMachineConfiguration プールの場合は、新しいメソッド GetRemoteLoginSettingsAsync(String, String, IEnumerable<BatchClientBehavior>, CancellationToken) を使用する必要があります。