Get-AzBatchRemoteDesktopProtocolFile

  • リファレンス
モジュール:
Az.Batch

コンピューティング ノードから RDP ファイルを取得します。

構文

Get-AzBatchRemoteDesktopProtocolFile
   [-PoolId] <String>
   [-ComputeNodeId] <String>
   -DestinationPath <String>
   -BatchContext <BatchAccountContext>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzBatchRemoteDesktopProtocolFile
   [-PoolId] <String>
   [-ComputeNodeId] <String>
   -DestinationStream <Stream>
   -BatchContext <BatchAccountContext>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzBatchRemoteDesktopProtocolFile
   [[-ComputeNode] <PSComputeNode>]
   -DestinationPath <String>
   -BatchContext <BatchAccountContext>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzBatchRemoteDesktopProtocolFile
   [[-ComputeNode] <PSComputeNode>]
   -DestinationStream <Stream>
   -BatchContext <BatchAccountContext>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

説明

Get-AzBatchRemoteDesktopProtocolFile コマンドレットは、コンピューティング ノードからリモート デスクトップ プロトコル (RDP) ファイルを取得し、ファイルまたはユーザーが指定したストリームに保存します。

例

例 1: 指定したコンピューティング ノードから RDP ファイルを取得し、ファイルを保存する

Get-AzBatchRemoteDesktopProtocolFile -PoolId "Pool06" -ComputeNodeId "ComputeNode01" -DestinationPath "C:\PowerShell\ComputeNode01.rdp" -BatchContext $Context

このコマンドは、ID Pool06 を持つプール内の ID ComputeNode01 を持つコンピューティング ノードから RDP ファイルを取得します。 このコマンドは、.rdp ファイルを C:\PowerShell\MyComputeNode.rdp として保存します。 Get-AzBatchAccountKey コマンドレットを使用して、$Context変数にコンテキストを割り当てます。

例 2: コンピューティング ノードから RDP ファイルを取得し、パイプラインを使用してファイルを保存する

Get-AzBatchComputeNode -PoolId "Pool06" -Id "ComputeNode02" -BatchContext $Context | Get-AzBatchRemoteDesktopProtocolFile -DestinationPath "C:\PowerShell\MyComputeNode02.rdp" -BatchContext $Context

このコマンドは、ID Pool06 を持つプール内に ID ComputeNode02 を持つコンピューティング ノードを取得します。 このコマンドは、パイプライン演算子を使用して、そのコンピューティング ノードを現在のコマンドレットに渡します。 現在のコマンドレットは、コンピューティング ノードから .rpd ファイルを取得し、その内容を C:\PowerShell\MyComputeNode02.rdp という名前のファイルとして保存します。

例 3: 指定したコンピューティング ノードから RDP ファイルを取得し、ストリームに転送する

$Stream = New-Object -TypeName "System.IO.MemoryStream"
Get-AzBatchRemoteDesktopProtocolFile "Pool06" -ComputeNodeId "ComputeNode03" -DestinationStream $Stream -BatchContext $Context

最初のコマンドは、New-Object コマンドレットを使用してストリームを作成し、$Stream変数に格納します。 2 番目のコマンドは、ID Pool06 を持つプール内の ID ComputeNode03 を持つコンピューティング ノードから .rdp ファイルを取得します。 このコマンドは、ファイルの内容を$Streamのストリームに転送します。

パラメーター

-BatchContext

このコマンドレットが Batch サービスとの対話に使用する BatchAccountContext インスタンスを指定します。 Get-AzBatchAccount コマンドレットを使用して BatchAccountContext を取得する場合、Batch サービスと対話するときに Microsoft Entra 認証が使用されます。 代わりに共有キー認証を使用するには、Get-AzBatchAccountKey コマンドレットを使用して、アクセス キーが設定された BatchAccountContext オブジェクトを取得します。 共有キー認証を使用する場合、プライマリ アクセス キーは既定で使用されます。 使用するキーを変更するには、BatchAccountContext.KeyInUse プロパティを設定します。

型:BatchAccountContext
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-ComputeNode

.rdp ファイルがポイントする PSComputeNode オブジェクトとしてコンピューティング ノードを指定します。 コンピューティング ノード オブジェクトを取得するには、Get-AzBatchComputeNode コマンドレットを使用します。

型:PSComputeNode
配置:0
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-ComputeNodeId

.rdp ファイルがポイントするコンピューティング ノードの ID を指定します。

型:String
配置:1
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-DefaultProfile

Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション。

型:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-DestinationPath

このコマンドレットが .rdp ファイルを保存するファイル パスを指定します。

型:String
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-DestinationStream

このコマンドレットが RDP データを転送するストリームを指定します。 このコマンドレットは、このストリームを閉じたり巻き戻したりしません。

型:Stream
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-PoolId

このコマンドレットが .rdp ファイルを取得するコンピューティング ノードを含むプールの ID を指定します。

型:String
配置:0
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

入力

String

PSComputeNode

BatchAccountContext

出力

Void