你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Set-AzureServiceRemoteDesktopExtension

在已部署的服务或部署中启用指定角色或所有角色的远程桌面扩展。

注意

本文档中引用的 cmdlet 用于管理使用 Azure Service Manager (ASM) API 的旧 Azure 资源。 创建新的资源时,不建议使用此旧版 PowerShell 模块,因为 ASM 计划停用。 有关详细信息,请参阅 Azure Service Manager 停用

Az PowerShell 模块是推荐的 PowerShell 模块,用于使用 PowerShell 管理 Azure 资源管理器 (ARM) 资源。

重要

新客户的云服务(经典版)现已弃用,并将于 2024 年 8 月 31 日对所有客户停用。 新部署应使用基于 Azure 资源管理器 的新部署模型 Azure 云服务(扩展支持)。

语法

Set-AzureServiceRemoteDesktopExtension
   [[-ServiceName] <String>]
   [[-Slot] <String>]
   [[-Role] <String[]>]
   [[-X509Certificate] <X509Certificate2>]
   [[-ThumbprintAlgorithm] <String>]
   [-Credential] <PSCredential>
   [[-Expiration] <DateTime>]
   [[-Version] <String>]
   [[-ExtensionId] <String>]
   [-Profile <AzureSMProfile>]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [<CommonParameters>]
Set-AzureServiceRemoteDesktopExtension
   [[-ServiceName] <String>]
   [[-Slot] <String>]
   [[-Role] <String[]>]
   [-CertificateThumbprint] <String>
   [[-ThumbprintAlgorithm] <String>]
   [-Credential] <PSCredential>
   [[-Expiration] <DateTime>]
   [[-Version] <String>]
   [[-ExtensionId] <String>]
   [-Profile <AzureSMProfile>]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [<CommonParameters>]

说明

Set-AzureServiceRemoteDesktopExtension cmdlet 在已部署的服务或部署中启用指定角色或所有角色的远程桌面扩展。

示例

示例 1:启用远程桌面扩展

PS C:\> Set-AzureServiceRemoteDesktopExtension -ServiceName $svc -Credentials $creds

此命令为指定的服务启用远程桌面扩展。

示例 2:为指定角色启用远程桌面扩展

PS C:\> Set-AzureServiceRemoteDesktopExtension -ServiceName $svc -Credentials $creds -Role "WebRole1"

此命令为指定的服务和角色启用远程桌面扩展。

参数

-CertificateThumbprint

指定用于加密专用配置的证书指纹。 此证书必须已存在于证书存储中。 如果未指定证书,此 cmdlet 将创建证书。

类型:String
Position:3
默认值:None
必需:True
Accept pipeline input:True
Accept wildcard characters:False

-Credential

指定要为远程桌面启用的凭据。 凭据包括用户名和密码。

类型:PSCredential
Position:5
默认值:None
必需:True
Accept pipeline input:True
Accept wildcard characters:False

-Expiration

指定一个日期时间对象,该对象允许用户指定用户帐户过期的时间。

类型:DateTime
Position:6
默认值:None
必需:False
Accept pipeline input:True
Accept wildcard characters:False

-ExtensionId

指定扩展 ID。

类型:String
Position:8
默认值:None
必需:False
Accept pipeline input:True
Accept wildcard characters:False

-InformationAction

指定此 cmdlet 如何响应信息事件。

此参数的可接受值为:

  • 继续
  • 忽略
  • 询问
  • SilentlyContinue
  • 停止
  • Suspend
类型:ActionPreference
Aliases:infa
Position:Named
默认值:None
必需:False
Accept pipeline input:False
Accept wildcard characters:False

-InformationVariable

指定信息变量。

类型:String
Aliases:iv
Position:Named
默认值:None
必需:False
Accept pipeline input:False
Accept wildcard characters:False

-Profile

指定此 cmdlet 从中读取的 Azure 配置文件。 如果未指定配置文件,此 cmdlet 将从本地默认配置文件中读取。

类型:AzureSMProfile
Position:Named
默认值:None
必需:False
Accept pipeline input:False
Accept wildcard characters:False

-Role

指定要为其指定远程桌面配置的角色的可选数组。 如果未指定此参数,则远程桌面配置将作为所有角色的默认配置应用。

类型:String[]
Position:2
默认值:None
必需:False
Accept pipeline input:True
Accept wildcard characters:False

-ServiceName

指定部署的 Azure 服务名称。

类型:String
Position:0
默认值:None
必需:False
Accept pipeline input:True
Accept wildcard characters:False

-Slot

指定要修改的部署环境。 此参数的可接受值为:Production、Staging。

类型:String
Position:1
默认值:None
必需:False
Accept pipeline input:True
Accept wildcard characters:False

-ThumbprintAlgorithm

指定指纹哈希算法,该算法与指纹一起使用以标识证书。 此参数是可选的,默认值为 sha1。

类型:String
Position:4
默认值:None
必需:False
Accept pipeline input:True
Accept wildcard characters:False

-Version

指定扩展版本。

类型:String
Position:7
默认值:None
必需:False
Accept pipeline input:True
Accept wildcard characters:False

-X509Certificate

指定自动上传到云服务并用于加密扩展的专用配置的 x509 证书。

类型:X509Certificate2
Position:3
默认值:None
必需:False
Accept pipeline input:True
Accept wildcard characters:False