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

az desktopvirtualization hostpool

Note

This reference is part of the desktopvirtualization extension for the Azure CLI (version 2.55.0 or higher). 该扩展会在首次运行 az desktopvirtualization hostpool 命令时自动安装。 Learn more about extensions.

管理桌面虚拟化主机池。

命令

名称	说明	类型	Status
az desktopvirtualization hostpool create	创建主机池。	Extension	GA
az desktopvirtualization hostpool delete	删除主机池。	Extension	GA
az desktopvirtualization hostpool list	列出主机池。	Extension	GA
az desktopvirtualization hostpool retrieve-registration-token	主机池的注册令牌。	Extension	GA
az desktopvirtualization hostpool show	显示主机池。	Extension	GA
az desktopvirtualization hostpool update	更新主机池。	Extension	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>配置默认组。

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--custom-rdp-property

主机池的自定义 rdp 属性。

--description

HostPool 的说明。

--friendly-name

HostPool 的友好名称。

--location -l

资源所在的地理位置。

--max-session-limit

HostPool 的最大会话限制。

--personal-desktop-assignment-type

HostPool 的 PersonalDesktopAssignment 类型。

属性	值
接受的值:	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

用于对 WVD SSO 证书进行签名的客户 ADFS 服务器的 URL。

--start-vm-on-connect

要打开/关闭 StartVMOnConnect 功能的标志。

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

--tags

Resource tags. 支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

--validation-environment

验证环境。

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

--vm-template

主机池中会话主机配置的 VM 模板。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。使用 --debug 获取完整的调试日志。

属性	值
默认值:	False

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

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--force

强制标志删除 sessionHost。

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

--ids

一个或多个资源 ID（以空格分隔）。它应该是包含“Resource Id”参数的所有信息的完整资源 ID。应提供 --ids 或其他“Resource Id”参数。

属性	值
Parameter group:	Resource Id Arguments

--name -n

指定资源组中的主机池的名称。

属性	值
Parameter group:	Resource Id Arguments

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name>配置默认组。

属性	值
Parameter group:	Resource Id Arguments

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

属性	值
Parameter group:	Resource Id Arguments

--yes -y

不要提示确认。

属性	值
默认值:	False

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--verbose

增加日志记录详细程度。使用 --debug 获取完整的调试日志。

属性	值
默认值:	False

az desktopvirtualization hostpool list

列出主机池。

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

示例

列出主机池

az desktopvirtualization hostpool list -g rg

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--max-items

命令输出中要返回的项总数。如果可用的项总数大于指定的值，则会在命令的输出中提供令牌。若要恢复分页，请在后续命令的 --next-token 参数中提供令牌值。

属性	值
Parameter group:	Pagination Arguments

--next-token

用于指定开始分页的位置的令牌。这是先前截断的响应中的令牌值。

属性	值
Parameter group:	Pagination Arguments

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name>配置默认组。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。使用 --debug 获取完整的调试日志。

属性	值
默认值:	False

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

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

一个或多个资源 ID（以空格分隔）。它应该是包含“Resource Id”参数的所有信息的完整资源 ID。应提供 --ids 或其他“Resource Id”参数。

属性	值
Parameter group:	Resource Id Arguments

--name -n

指定资源组中的主机池的名称。

属性	值
Parameter group:	Resource Id Arguments

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name>配置默认组。

属性	值
Parameter group:	Resource Id Arguments

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

属性	值
Parameter group:	Resource Id Arguments

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--verbose

增加日志记录详细程度。使用 --debug 获取完整的调试日志。

属性	值
默认值:	False

az desktopvirtualization hostpool show

显示主机池。

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

示例

显示主机池

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

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

一个或多个资源 ID（以空格分隔）。它应该是包含“Resource Id”参数的所有信息的完整资源 ID。应提供 --ids 或其他“Resource Id”参数。

属性	值
Parameter group:	Resource Id Arguments

--name -n

指定资源组中的主机池的名称。

属性	值
Parameter group:	Resource Id Arguments

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name>配置默认组。

属性	值
Parameter group:	Resource Id Arguments

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

属性	值
Parameter group:	Resource Id Arguments

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--verbose

增加日志记录详细程度。使用 --debug 获取完整的调试日志。

属性	值
默认值:	False

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

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--add

通过指定路径和键值对将对象添加到对象列表。示例：--add property.listProperty <key=value, string or JSON string>。

属性	值
Parameter group:	Generic Update Arguments

--custom-rdp-property

主机池的自定义 rdp 属性。

--description

HostPool 的说明。

--force-string

使用“set”或“add”时，保留字符串文本，而不是尝试转换为 JSON。

属性	值
Parameter group:	Generic Update Arguments
接受的值:	0, 1, f, false, n, no, t, true, y, yes

--friendly-name

HostPool 的友好名称。

--ids

一个或多个资源 ID（以空格分隔）。它应该是包含“Resource Id”参数的所有信息的完整资源 ID。应提供 --ids 或其他“Resource Id”参数。

属性	值
Parameter group:	Resource Id Arguments

--load-balancer-type

负载均衡器的类型。

属性	值
接受的值:	BreadthFirst, DepthFirst, Persistent

--max-session-limit

HostPool 的最大会话限制。

--name -n

指定资源组中的主机池的名称。

属性	值
Parameter group:	Resource Id Arguments

--personal-desktop-assignment-type

HostPool 的 PersonalDesktopAssignment 类型。

属性	值
接受的值:	Automatic, Direct

--preferred-app-group-type -t

首选应用程序组类型的类型，默认为桌面应用程序组。

属性	值
接受的值:	Desktop, None, RailApplications

--registration-info

HostPool 的注册信息。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

--remove

从列表中删除属性或元素。示例： --remove property.list <indexToRemove> OR --remove propertyToRemove.

属性	值
Parameter group:	Generic Update Arguments

--resource-group -g

资源组的名称。可以使用 az configure --defaults group=<name>配置默认组。

属性	值
Parameter group:	Resource Id Arguments

--ring

HostPool 的环号。

--set

通过指定要设置的属性路径和值来更新对象。示例：--set property1.property2=<value>。

属性	值
Parameter group:	Generic Update Arguments

--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

用于对 WVD SSO 证书进行签名的客户 ADFS 服务器的 URL。

--start-vm-on-connect

要打开/关闭 StartVMOnConnect 功能的标志。

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

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

属性	值
Parameter group:	Resource Id Arguments

--tags

Resource tags. 支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

--validation-environment

验证环境。

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

--vm-template

主机池中会话主机配置的 VM 模板。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--verbose

增加日志记录详细程度。使用 --debug 获取完整的调试日志。

属性	值
默认值:	False

通过

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

示例

可选参数

反馈