az desktopvirtualization hostpool

參考

注意

此參考是 Azure CLI 桌面虛擬化延伸模組的一部分（2.55.0 版或更高版本）。擴充功能會在您第一次執行 az desktopvirtualization hostpool 命令時自動安裝。深入了解擴充功能。

管理桌面虛擬化主機集區。

命令

名稱	Description	類型	狀態
az desktopvirtualization hostpool create	建立主機集區。	副檔名	GA
az desktopvirtualization hostpool delete	刪除主機集區。	副檔名	GA
az desktopvirtualization hostpool list	列出主機集區。	副檔名	GA
az desktopvirtualization hostpool retrieve-registration-token	主機集區的註冊令牌。	副檔名	GA
az desktopvirtualization hostpool show	顯示主機集區。	副檔名	GA
az desktopvirtualization hostpool update	更新主機集區。	副檔名	GA

az desktopvirtualization hostpool create

建立主機集區。

az desktopvirtualization hostpool create --host-pool-type {BYODesktop, Personal, Pooled}
                                         --load-balancer-type {BreadthFirst, DepthFirst, Persistent}
                                         --name
                                         --preferred-app-group-type {Desktop, None, RailApplications}
                                         --resource-group
                                         [--custom-rdp-property]
                                         [--description]
                                         [--friendly-name]
                                         [--location]
                                         [--max-session-limit]
                                         [--personal-desktop-assignment-type {Automatic, Direct}]
                                         [--registration-info]
                                         [--ring]
                                         [--sso-client-id]
                                         [--sso-client-secret-key-vault-path]
                                         [--sso-secret-type {Certificate, CertificateInKeyVault, SharedKey, SharedKeyInKeyVault}]
                                         [--ssoadfs-authority]
                                         [--start-vm-on-connect {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--tags]
                                         [--validation-environment {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--vm-template]

範例

建立主機集區

az desktopvirtualization hostpool create -g rg -n hostpool-name --friendly-name friendly --host-pool-type Pooled --load-balancer-type BreadthFirst --max-session-limit 999999 --personal-desktop-assignment-type Automatic --preferred-app-group-type Desktop --registration-info expiration-time="yyyy-mm-ddT08:38:08.189Z" registration-token-operation=Update --sso-client-id client --sso-client-secret-key-vault-path https://keyvault/secret --sso-secret-type SharedKey --start-vm-on-connect false

必要參數

--host-pool-type

桌面主機集區類型。

接受的值: BYODesktop, Personal, Pooled

--load-balancer-type

負載平衡器的型別。

接受的值: BreadthFirst, DepthFirst, Persistent

--name -n

指定資源群組內的主機集區名稱。

--preferred-app-group-type -t

慣用應用程式群組類型的類型，預設為傳統型應用程式群組。

接受的值: Desktop, None, RailApplications

--resource-group -g

資源群組的名稱。您可以使用 az configure --defaults group=<name> 來設定預設群組。

選擇性參數

--custom-rdp-property

主機集區的自定義 rdp 屬性。

--description

HostPool 的描述。

--friendly-name

HostPool 的易記名稱。

--location -l

資源所在的地理位置。

--max-session-limit

HostPool 的最大會話限制。

--personal-desktop-assignment-type

HostPool 的個人DesktopAssignment 類型。

接受的值: Automatic, Direct

--registration-info

HostPool 的註冊資訊。支援速記語法、json-file 和 yaml-file。請嘗試 “？？” 以顯示更多。

--ring

HostPool 的通道編號。

--sso-client-id

用來發出 WVD SSO 憑證之已註冊信賴憑證者的 ClientId。

--sso-client-secret-key-vault-path -p

儲存用來與 ADFS 通訊之秘密的 Azure KeyVault 路徑。

--sso-secret-type

密碼類型上的單一登錄類型。

接受的值: Certificate, CertificateInKeyVault, SharedKey, SharedKeyInKeyVault

--ssoadfs-authority

客戶 ADFS 伺服器的 URL，用於簽署 WVD SSO 憑證。

--start-vm-on-connect

開啟/關閉 StartVMOn 連線功能的旗標。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--tags

資源標籤。支援速記語法、json-file 和 yaml-file。請嘗試 “？？” 以顯示更多。

--validation-environment

這是驗證環境。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--vm-template

主機集區內會話主機設定的 VM 範本。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。您可以使用來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。使用 --debug 來取得完整偵錯記錄。

az desktopvirtualization hostpool delete

刪除主機集區。

az desktopvirtualization hostpool delete [--force {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--ids]
                                         [--name]
                                         [--resource-group]
                                         [--subscription]
                                         [--yes]

範例

刪除主機集區

az desktopvirtualization hostpool delete -g rg -n hostpool-name

選擇性參數

--force

強制旗標刪除 sessionHost。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--ids

一或多個資源識別碼 (以空格分隔)。它應該是完整資源識別碼，其中包含「資源標識碼」引數的所有資訊。您應該提供 --ids 或其他「資源識別碼」引數。

--name -n

指定資源群組內的主機集區名稱。

--resource-group -g

資源群組的名稱。您可以使用 az configure --defaults group=<name> 來設定預設群組。

--subscription

訂用帳戶的名稱或識別碼。您可以使用來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--yes -y

不提示確認。

預設值: False

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。您可以使用來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。使用 --debug 來取得完整偵錯記錄。

az desktopvirtualization hostpool list

列出主機集區。

az desktopvirtualization hostpool list [--max-items]
                                       [--next-token]
                                       [--resource-group]

範例

列出主機集區

az desktopvirtualization hostpool list -g rg

選擇性參數

--max-items

命令輸出中要傳回的項目總數。如果可用的專案總數超過指定的值，則會在命令的輸出中提供令牌。若要繼續分頁，請在後續命令的自變數中 --next-token 提供令牌值。

--next-token

標記，指定要開始分頁的位置。這是先前截斷回應中的令牌值。

--resource-group -g

資源群組的名稱。您可以使用 az configure --defaults group=<name> 來設定預設群組。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。您可以使用來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。使用 --debug 來取得完整偵錯記錄。

az desktopvirtualization hostpool retrieve-registration-token

主機集區的註冊令牌。

az desktopvirtualization hostpool retrieve-registration-token [--ids]
                                                              [--name]
                                                              [--resource-group]
                                                              [--subscription]

範例

主機集區的註冊令牌。

az desktopvirtualization hostpool retrieve-registration-token -n hostpool-name -g rg

選擇性參數

--ids

--name -n

指定資源群組內的主機集區名稱。

--resource-group -g

資源群組的名稱。您可以使用 az configure --defaults group=<name> 來設定預設群組。

--subscription

訂用帳戶的名稱或識別碼。您可以使用來設定預設訂用 az account set -s NAME_OR_ID帳戶。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。您可以使用來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。使用 --debug 來取得完整偵錯記錄。

az desktopvirtualization hostpool show

顯示主機集區。

az desktopvirtualization hostpool show [--ids]
                                       [--name]
                                       [--resource-group]
                                       [--subscription]

範例

顯示主機集區

az desktopvirtualization hostpool show -g rg -n hostpool-name

選擇性參數

--ids

--name -n

指定資源群組內的主機集區名稱。

--resource-group -g

資源群組的名稱。您可以使用 az configure --defaults group=<name> 來設定預設群組。

--subscription

訂用帳戶的名稱或識別碼。您可以使用來設定預設訂用 az account set -s NAME_OR_ID帳戶。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。您可以使用來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。使用 --debug 來取得完整偵錯記錄。

az desktopvirtualization hostpool update

更新主機集區。

az desktopvirtualization hostpool update [--add]
                                         [--custom-rdp-property]
                                         [--description]
                                         [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--friendly-name]
                                         [--ids]
                                         [--load-balancer-type {BreadthFirst, DepthFirst, Persistent}]
                                         [--max-session-limit]
                                         [--name]
                                         [--personal-desktop-assignment-type {Automatic, Direct}]
                                         [--preferred-app-group-type {Desktop, None, RailApplications}]
                                         [--registration-info]
                                         [--remove]
                                         [--resource-group]
                                         [--ring]
                                         [--set]
                                         [--sso-client-id]
                                         [--sso-client-secret-key-vault-path]
                                         [--sso-secret-type {Certificate, CertificateInKeyVault, SharedKey, SharedKeyInKeyVault}]
                                         [--ssoadfs-authority]
                                         [--start-vm-on-connect {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--subscription]
                                         [--tags]
                                         [--validation-environment {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--vm-template]

範例

更新主機集區

az desktopvirtualization hostpool update -g rg -n hostpool-name --tags tag=test

選擇性參數

--add

藉由指定路徑和索引鍵值組，將物件加入物件清單。範例：--add property.listProperty <key=value、string 或 JSON 字串>。

--custom-rdp-property

主機集區的自定義 rdp 屬性。

--description

HostPool 的描述。

--force-string

使用 'set' 或 'add' 時，請保留字串常值，而不是嘗試轉換成 JSON。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--friendly-name

HostPool 的易記名稱。

--ids

--load-balancer-type

負載平衡器的型別。

接受的值: BreadthFirst, DepthFirst, Persistent

--max-session-limit

HostPool 的最大會話限制。

--name -n

指定資源群組內的主機集區名稱。

--personal-desktop-assignment-type

HostPool 的個人DesktopAssignment 類型。

接受的值: Automatic, Direct

--preferred-app-group-type -t

慣用應用程式群組類型的類型，預設為傳統型應用程式群組。

接受的值: Desktop, None, RailApplications

--registration-info

HostPool 的註冊資訊。支援速記語法、json-file 和 yaml-file。請嘗試 “？？” 以顯示更多。

--remove

從清單中移除屬性或專案。範例：--remove property.list OR --remove 屬性ToRemove。

--resource-group -g

資源群組的名稱。您可以使用 az configure --defaults group=<name> 來設定預設群組。

--ring

HostPool 的通道編號。

--set

指定要設定的屬性路徑和值，以更新物件。範例：--set property1.property2=。

--sso-client-id

用來發出 WVD SSO 憑證之已註冊信賴憑證者的 ClientId。

--sso-client-secret-key-vault-path -p

儲存用來與 ADFS 通訊之秘密的 Azure KeyVault 路徑。

--sso-secret-type

密碼類型上的單一登錄類型。

接受的值: Certificate, CertificateInKeyVault, SharedKey, SharedKeyInKeyVault

--ssoadfs-authority

客戶 ADFS 伺服器的 URL，用於簽署 WVD SSO 憑證。

--start-vm-on-connect

開啟/關閉 StartVMOn 連線功能的旗標。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--subscription

訂用帳戶的名稱或識別碼。您可以使用來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--tags

資源標籤。支援速記語法、json-file 和 yaml-file。請嘗試 “？？” 以顯示更多。

--validation-environment

這是驗證環境。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--vm-template

主機集區內會話主機設定的 VM 範本。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。您可以使用來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。使用 --debug 來取得完整偵錯記錄。

共用方式為

az desktopvirtualization hostpool

命令

az desktopvirtualization hostpool create

範例

必要參數

選擇性參數

az desktopvirtualization hostpool delete

範例

選擇性參數

az desktopvirtualization hostpool list

範例

選擇性參數

az desktopvirtualization hostpool retrieve-registration-token

範例

選擇性參數

az desktopvirtualization hostpool show

範例

選擇性參數

az desktopvirtualization hostpool update

範例

選擇性參數

其他資源