您现在访问的是微软AZURE全球版技术文档网站,若需要访问由世纪互联运营的MICROSOFT AZURE中国区技术文档网站,请访问 https://docs.azure.cn.

az desktopvirtualization hostpool

备注

此引用是用于 Azure CLI 的 desktopvirtualization 扩展的一部分,需要版本2.3.1 或更高版本。 首次运行 az desktopvirtualization hostpool 命令时,扩展将自动安装。 详细了解扩展。

Desktopvirtualization hostpool.

命令

az desktopvirtualization hostpool create

创建或更新主机池。

az desktopvirtualization hostpool delete

删除主机池。

az desktopvirtualization hostpool list

列出订阅中的 hostPools。

az desktopvirtualization hostpool show

获取主机池。

az desktopvirtualization hostpool update

更新主机池。

az desktopvirtualization hostpool create

创建或更新主机池。

az desktopvirtualization hostpool create --host-pool-type {Personal, Pooled}
                                         --load-balancer-type {BreadthFirst, DepthFirst, Persistent}
                                         --location
                                         --name
                                         --personal-desktop-assignment-type {Automatic, Direct}
                                         --resource-group
                                         [--custom-rdp-property]
                                         [--description]
                                         [--friendly-name]
                                         [--max-session-limit]
                                         [--registration-info]
                                         [--ring]
                                         [--sso-context]
                                         [--tags]
                                         [--validation-environment {false, true}]
                                         [--vm-template]

示例

HostPool_Create

az desktopvirtualization hostpool create --location "centralus" --description "des1" --friendly-name "friendly" --host-pool-type "Pooled" --load-balancer-type "BreadthFirst" --max-session-limit 999999 --personal-desktop-assignment-type "Automatic" --registration-info expiration-time="2020-10-01T14:01:54.9571247Z" registration-token-operation="Update" --sso-context "KeyVaultPath" --tags tag1="value1" tag2="value2" --name "MyHostPool" --resource-group "MyResourceGroup"

必需参数

--host-pool-type

桌面的 HostPool 类型。

接受的值: Personal, Pooled
--load-balancer-type

负载均衡器的类型。

接受的值: BreadthFirst, DepthFirst, Persistent
--location -l

位置。 az account list-locations 中的值。 可以使用 az configure --defaults location=<location> 配置默认位置。

--name -n

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

--personal-desktop-assignment-type

HostPool 的 PersonalDesktopAssignment 类型。

接受的值: Automatic, Direct
--resource-group -g

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

可选参数

--custom-rdp-property

HostPool 的自定义 rdp 属性。

--description

HostPool 的说明。

--friendly-name

HostPool 的友好名称。

--max-session-limit

HostPool 的最大会话限制。

--registration-info

HostPool 的注册信息。

--ring

HostPool 的环号码。

--sso-context

包含 ssoContext 机密的 keyvault 的路径。

--tags

空格分隔标记:键 [= 值] [键 [= 值] ...]。使用 "" 清除现有标记。

--validation-environment

为验证环境。

接受的值: false, true
--vm-template

Hostpool 中 sessionhosts 配置的 VM 模板。

az desktopvirtualization hostpool delete

删除主机池。

az desktopvirtualization hostpool delete --name
                                         --resource-group
                                         [--force {false, true}]

示例

HostPool_Delete

az desktopvirtualization hostpool delete --force true --name "MyHostPool" --resource-group "MyResourceGroup"

必需参数

--name -n

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

--resource-group -g

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

可选参数

--force

强制标记以删除 sessionHost。

接受的值: false, true

az desktopvirtualization hostpool list

列出订阅中的 hostPools。

az desktopvirtualization hostpool list [--resource-group]

示例

HostPool_ListByResourceGroup

az desktopvirtualization hostpool list --resource-group "MyResourceGroup"

可选参数

--resource-group -g

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

az desktopvirtualization hostpool show

获取主机池。

az desktopvirtualization hostpool show --name
                                       --resource-group

示例

HostPool_Get

az desktopvirtualization hostpool show --name "MyHostPool" --resource-group "MyResourceGroup"

必需参数

--name -n

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

--resource-group -g

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

az desktopvirtualization hostpool update

更新主机池。

az desktopvirtualization hostpool update --name
                                         --resource-group
                                         [--custom-rdp-property]
                                         [--description]
                                         [--friendly-name]
                                         [--load-balancer-type {BreadthFirst, DepthFirst, Persistent}]
                                         [--max-session-limit]
                                         [--personal-desktop-assignment-type {Automatic, Direct}]
                                         [--registration-info]
                                         [--ring]
                                         [--sso-context]
                                         [--tags]
                                         [--validation-environment {false, true}]

示例

HostPool_Update

az desktopvirtualization hostpool update --description "des1" --friendly-name "friendly" --load-balancer-type "BreadthFirst" --max-session-limit 999999 --personal-desktop-assignment-type "Automatic" --registration-info expiration-time="2020-10-01T15:01:54.9571247Z" registration-token-operation="Update" --sso-context "KeyVaultPath" --tags tag1="value1" tag2="value2" --name "MyHostPool" --resource-group "MyResourceGroup"

必需参数

--name -n

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

--resource-group -g

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

可选参数

--custom-rdp-property

HostPool 的自定义 rdp 属性。

--description

HostPool 的说明。

--friendly-name

HostPool 的友好名称。

--load-balancer-type

负载均衡器的类型。

接受的值: BreadthFirst, DepthFirst, Persistent
--max-session-limit

HostPool 的最大会话限制。

--personal-desktop-assignment-type

HostPool 的 PersonalDesktopAssignment 类型。

接受的值: Automatic, Direct
--registration-info

HostPool 的注册信息。

--ring

HostPool 的环号码。

--sso-context

包含 ssoContext 机密的 keyvault 的路径。

--tags

空格分隔标记:键 [= 值] [键 [= 值] ...]。使用 "" 清除现有标记。

--validation-environment

为验证环境。

接受的值: false, true