Set-AzureServiceRemoteDesktopExtension
在已部署的服務或部署時啟用指定角色或所有角色的遠端桌面擴充功能。
注意
本文件中參考的 Cmdlet 用於管理使用 Azure Service Manager(ASM) API 的舊版 Azure 資源。 建立新的資源時,不建議使用此舊版 PowerShell 模組,因為 ASM 已排定淘汰。 如需詳細資訊,請參閱 Azure Service Manager 淘汰。
Az PowerShell 模組是使用 PowerShell 管理 Azure Resource Manager (ARM) 資源的建議 PowerShell 模組。
重要
針對新客戶目前已取代 Azure 雲端服務 (傳統),而針對所有客戶,該服務將從 2024 年 8 月 31 日起完全淘汰。 新部署應該使用 Azure Resource Manager 型的新部署模型 Azure 雲端服務 (延伸支援)。
語法
SetExtension (預設值)
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>]
SetExtensionUsingThumbprint
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>]
Description
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
|
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
SetExtensionUsingThumbprint
| Position: | 3 |
| 必要: | True |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | True |
| 來自剩餘引數的值: | False |
-Credential
指定要啟用遠端桌面的認證。
認證包括使用者名稱和密碼。
參數屬性
| 類型: | PSCredential
|
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | 5 |
| 必要: | True |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | True |
| 來自剩餘引數的值: | False |
-Expiration
指定日期時間對象,允許使用者指定用戶帳戶到期的時間。
參數屬性
| 類型: | DateTime
|
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | 6 |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | True |
| 來自剩餘引數的值: | False |
-ExtensionId
指定延伸模組識別碼。
參數屬性
| 類型: | String
|
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | 8 |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | True |
| 來自剩餘引數的值: | False |
指定此 Cmdlet 如何回應資訊事件。
此參數可接受的值為:
- 繼續
- 忽略
- 詢問
- SilentlyContinue
- 停止
- 暫止
| 類型: | ActionPreference
|
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
| 別名: | infa |
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
指定資訊變數。
| 類型: | String
|
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
| 別名: | 四 |
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Profile
指定此 Cmdlet 從中讀取的 Azure 設定檔。
如果您未指定設定檔,此 Cmdlet 會從本機預設配置檔讀取。
參數屬性
| 類型: | AzureSMProfile
|
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Role
指定要指定遠端桌面組態之角色的選擇性陣列。
如果未指定此參數,則遠端桌面組態會套用為所有角色的預設組態。
參數屬性
| 類型: | String[]
|
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | 2 |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | True |
| 來自剩餘引數的值: | False |
-ServiceName
指定部署的 Azure 服務名稱。
參數屬性
| 類型: | String
|
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | 0 |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | True |
| 來自剩餘引數的值: | False |
-Slot
指定要修改之部署的環境。
此參數可接受的值為:Production、Staging。
參數屬性
| 類型: | String
|
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | 1 |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | True |
| 來自剩餘引數的值: | False |
-ThumbprintAlgorithm
指定指紋哈希演算法,此演算法會與指紋搭配使用,以識別憑證。
此參數是選擇性的,預設值為sha1。
參數屬性
| 類型: | String
|
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | 4 |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | True |
| 來自剩餘引數的值: | False |
-Version
指定擴充功能版本。
參數屬性
| 類型: | String
|
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | 7 |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | True |
| 來自剩餘引數的值: | False |
-X509Certificate
指定自動上傳至雲端服務的 x509 憑證,並用於加密延伸模組的私人組態。
參數屬性
| 類型: | X509Certificate2
|
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
SetExtension
| Position: | 3 |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | True |
| 來自剩餘引數的值: | False |
CommonParameters
此 Cmdlet 支援一般參數:-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 如需詳細資訊,請參閱 about_CommonParameters。