Share via

Get-AzureRemoteDesktopFile

  • リファレンス
モジュール:
Azure

Azure 仮想マシンの RDP ファイルを取得します。

注意

このドキュメントで参照されているコマンドレットは、Service Management API を使用するレガシ Azure リソースを管理するためのものです。 Azure Resource Manager リソースを管理するためのコマンドレットについては、Az 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
  • Stop
  • Suspend
Type:ActionPreference
Aliases:infa
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InformationVariable

情報変数を指定します。

Type:String
Aliases:iv
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Launch

このコマンドレットが仮想マシンへのリモート デスクトップ セッションを開始することを示します。

Type:SwitchParameter
Position:3
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-LocalPath

ローカル コンピューター上のダウンロードした RDP ファイルの完全なパスを指定します。

Type:String
Position:2
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

このコマンドレットが RDP ファイルをダウンロードする仮想マシンを指定します。

Type:String
Aliases:InstanceName
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Profile

このコマンドレットが読み取る Azure プロファイルを指定します。 プロファイルを指定しない場合、このコマンドレットはローカルの既定のプロファイルから読み取ります。

Type:AzureSMProfile
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ServiceName

仮想マシンが属する Azure サービスの名前を指定します。

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False