Get-AzureRemoteDesktopFile
获取 Azure 虚拟机的 RDP 文件。
注意
本文档中引用的 cmdlet 用于管理使用 Azure Service Manager (ASM) API 的旧式 Azure 资源。 创建新资源时，建议不要使用旧的 PowerShell 模块，因为计划将停用 ASM。 有关详细信息，请参阅 Azure Service Manager 停用。
Az PowerShell 模块是建议用于管理 PowerShell 的 Azure 资源管理器 (ARM) 资源的 PowerShell 模块。
语法
Download （默认值）
Get-AzureRemoteDesktopFile
[-Name] <String>
[-LocalPath] <String>
[-ServiceName] <String>
[-Profile <AzureSMProfile>]
[-InformationAction <ActionPreference>]
[-InformationVariable <String>]
[<CommonParameters>]
Launch
Get-AzureRemoteDesktopFile
[-Name] <String>
[[-LocalPath] <String>]
[-ServiceName] <String>
[-Launch]
[-Profile <AzureSMProfile>]
[-InformationAction <ActionPreference>]
[-InformationVariable <String>]
[<CommonParameters>]
说明
Get-AzureRemoteDesktopFile cmdlet 下载并保存 Azure 虚拟机的远程桌面连接 （RDP） 文件。 该 cmdlet 可以启动与指定虚拟机的远程桌面连接。
示例
示例 1：获取 RDP 文件
PS C:\> Get-AzureRemoteDesktopFile -ServiceName "ContosoService" -Name "VirtualMachine07" -LocalPath "C:\temp\VirtualMachine07.rdp"
此命令获取名为 VirtualMachine07 的 VirtualMachine07 虚拟机的 RDP 文件，该文件在名为 ContosoService 的服务上运行。 该命令将该文件存储为 C：\temp\VirtualMachine07.rdp。
示例 2：启动远程会话
PS C:\> Get-AzureRemoteDesktopFile -ServiceName "ContosoService" -Name "VirtualMachine07" -Launch
此命令获取名为 VirtualMachine07 的 VirtualMachine07 虚拟机的 RDP 文件，该文件在名为 ContosoService 的服务上运行。 该命令启动远程桌面会话。 命令在连接关闭时删除 RDP 文件。
参数
-InformationAction
指定此 cmdlet 如何响应信息事件。
此参数的可接受值为：
- 继续
- 忽略
- 询问
- SilentlyContinue
- 停止
- Suspend
参数属性
| 类型: | ActionPreference |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
| 别名: | infa |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-InformationVariable
指定信息变量。
参数属性
| 类型: | String |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
| 别名: | 四 |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-Launch
指示此 cmdlet 启动到虚拟机的远程桌面会话。
参数属性
| 类型: | SwitchParameter |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
Launch
| Position: | 3 |
| 必需: | True |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-LocalPath
指定本地计算机上下载的 RDP 文件的完整路径。
参数属性
| 类型: | String |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
Download
| Position: | 2 |
| 必需: | True |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | True |
| 来自剩余参数的值: | False |
-Name
指定此 cmdlet 下载 RDP 文件的虚拟机。
参数属性
| 类型: | String |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
| 别名: | 实例名称 |
参数集
(All)
| Position: | 1 |
| 必需: | True |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | True |
| 来自剩余参数的值: | False |
-Profile
指定此 cmdlet 从中读取的 Azure 配置文件。 如果未指定配置文件，此 cmdlet 将从本地默认配置文件中读取。
参数属性
| 类型: | AzureSMProfile |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-ServiceName
指定虚拟机所属的 Azure 服务的名称。
参数属性
| 类型: | String |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | 0 |
| 必需: | True |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | True |
| 来自剩余参数的值: | False |
CommonParameters
此 cmdlet 支持通用参数：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息，请参阅 about_CommonParameters。