你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Get-AzureRemoteDesktopFile
获取 Azure 虚拟机的 RDP 文件。
注意
本文档中引用的 cmdlet 用于管理使用 Azure Service Manager (ASM) API 的旧 Azure 资源。 创建新的资源时,不建议使用此旧版 PowerShell 模块,因为 ASM 计划停用。 有关详细信息,请参阅 Azure Service Manager 停用。
Az PowerShell 模块是推荐的 PowerShell 模块,用于使用 PowerShell 管理 Azure 资源管理器 (ARM) 资源。
语法
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 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 |
别名: | infa |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-InformationVariable
指定信息变量。
类型: | String |
别名: | iv |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-Launch
指示此 cmdlet 启动到虚拟机的远程桌面会话。
类型: | SwitchParameter |
Position: | 3 |
默认值: | None |
必需: | True |
接受管道输入: | False |
接受通配符: | False |
-LocalPath
指定本地计算机上下载的 RDP 文件的完整路径。
类型: | String |
Position: | 2 |
默认值: | None |
必需: | True |
接受管道输入: | True |
接受通配符: | False |
-Name
指定此 cmdlet 下载 RDP 文件的虚拟机。
类型: | String |
别名: | InstanceName |
Position: | 1 |
默认值: | None |
必需: | True |
接受管道输入: | True |
接受通配符: | False |
-Profile
指定此 cmdlet 从中读取的 Azure 配置文件。 如果未指定配置文件,此 cmdlet 将从本地默认配置文件中读取。
类型: | AzureSMProfile |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-ServiceName
指定虚拟机所属的 Azure 服务的名称。
类型: | String |
Position: | 0 |
默认值: | None |
必需: | True |
接受管道输入: | True |
接受通配符: | False |