Get-AzureRemoteDesktopFile
Azure 仮想マシンの RDP ファイルを取得します。
Note
このドキュメントで参照されているコマンドレットは、Azure Service Manager (ASM) API を使用するレガシ Azure リソースを管理するためのものです。 ASM の廃止が予定されているため、新しいリソースを作成する場合、このレガシ PowerShell モジュールは推奨されません。 詳細については、「Azure Service Manager の廃止」を参照してください。
Az PowerShell モジュールは、PowerShell を使用して Azure Resource Manager (ARM) リソースを管理するための推奨される PowerShell モジュールです。
構文
Get-AzureRemoteDesktopFile
[-Name] <String>
[-LocalPath] <String>
[-ServiceName] <String>
[-Profile <AzureSMProfile>]
[-InformationAction <ActionPreference>]
[-InformationVariable <String>]
[<CommonParameters>]
Get-AzureRemoteDesktopFile
[-Name] <String>
[[-LocalPath] <String>]
[-Launch]
[-ServiceName] <String>
[-Profile <AzureSMProfile>]
[-InformationAction <ActionPreference>]
[-InformationVariable <String>]
[<CommonParameters>]
説明
Get-AzureRemoteDesktopFile コマンドレットは、Azure 仮想マシンのリモート デスクトップ接続 (RDP) ファイルをダウンロードして保存します。 コマンドレットは、指定された仮想マシンへのリモート デスクトップ接続を起動できます。
例
例 1: RDP ファイルを取得する
PS C:\> Get-AzureRemoteDesktopFile -ServiceName "ContosoService" -Name "VirtualMachine07" -LocalPath "C:\temp\VirtualMachine07.rdp"
このコマンドは、ContosoService という名前のサービスで実行される VirtualMachine07 という名前の VirtualMachine07 仮想マシンの RDP ファイルを取得します。 このコマンドは、そのファイルを C:\temp\VirtualMachine07.rdp として格納します。
例 2: リモート セッションを開始する
PS C:\> Get-AzureRemoteDesktopFile -ServiceName "ContosoService" -Name "VirtualMachine07" -Launch
このコマンドは、ContosoService という名前のサービスで実行される VirtualMachine07 という名前の VirtualMachine07 仮想マシンの RDP ファイルを取得します。 このコマンドは、リモート デスクトップ セッションを起動します。 このコマンドは、接続が閉じられたときに RDP ファイルを削除します。
パラメーター
-InformationAction
このコマンドレットが情報イベントに応答する方法を指定します。
このパラメーターの有効値は、次のとおりです。
- 続行
- Ignore
- Inquire
- SilentlyContinue
- 阻止
- [中断]
型: | ActionPreference |
Aliases: | infa |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-InformationVariable
情報変数を指定します。
型: | String |
Aliases: | iv |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Launch
このコマンドレットが仮想マシンへのリモート デスクトップ セッションを開始することを示します。
型: | SwitchParameter |
配置: | 3 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-LocalPath
ローカル コンピューター上のダウンロードした RDP ファイルの完全なパスを指定します。
型: | String |
配置: | 2 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-Name
このコマンドレットが RDP ファイルをダウンロードする仮想マシンを指定します。
型: | String |
Aliases: | InstanceName |
配置: | 1 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-Profile
このコマンドレットが読み取る Azure プロファイルを指定します。 プロファイルを指定しない場合、このコマンドレットはローカルの既定のプロファイルから読み取ります。
型: | AzureSMProfile |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-ServiceName
仮想マシンが属する Azure サービスの名前を指定します。
型: | String |
配置: | 0 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |