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

Host Pools - Create Or Update

创建或更新主机池。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}?api-version=2022-02-10-preview

URI 参数

Name In Required Type Description
hostPoolName
path True
  • string

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

resourceGroupName
path True
  • string

资源组的名称。 此名称不区分大小写。

subscriptionId
path True
  • string

目标订阅的 ID。

api-version
query True
  • string

要用于此操作的 API 版本。

请求正文

Name Required Type Description
properties.hostPoolType True

桌面的 HostPool 类型。

properties.loadBalancerType True

负载均衡器的类型。

properties.preferredAppGroupType True

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

identity
kind
  • string

门户/工具/等用于为相同类型的资源呈现不同的 UX 体验的元数据;例如,ApiApps 是一种 Microsoft.Web/sites 类型。 如果受支持,资源提供程序必须验证并保留此值。

location
  • string

资源所在的地理位置

managedBy
  • string

管理此资源的资源的完全限定资源 ID。 指示此资源是否由另一个 Azure 资源管理。 如果存在这种情况,则如果从模板中删除该资源,则完全模式部署不会删除该资源,因为它由另一个资源管理。

plan
properties.agentUpdate

用于在会话主机上更新代理组件 (RDAgent、日内瓦监视代理和并行堆栈) 的首选设置。

properties.customRdpProperty
  • string

HostPool 的自定义 rdp 属性。

properties.description
  • string

HostPool 的说明。

properties.friendlyName
  • string

HostPool 的友好名称。

properties.maxSessionLimit
  • integer

HostPool 的最大会话限制。

properties.migrationRequest

HostPool 的注册信息。

properties.personalDesktopAssignmentType

HostPool 的个人DesktopAssignment 类型。

properties.publicNetworkAccess

启用允许从公共和专用网络访问此资源,禁用允许仅通过专用终结点访问此资源

properties.registrationInfo

HostPool 的注册信息。

properties.ring
  • integer

HostPool 的环号。

properties.ssoClientId
  • string

用于颁发 WVD SSO 证书的已注册信赖方的 ClientId。

properties.ssoClientSecretKeyVaultPath
  • string

存储用于与 ADFS 通信的机密的 Azure KeyVault 的路径。

properties.ssoSecretType

机密类型的单一登录类型。

properties.ssoadfsAuthority
  • string

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

properties.startVMOnConnect
  • boolean

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

properties.validationEnvironment
  • boolean

验证环境。

properties.vmTemplate
  • string

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

sku
tags
  • object

资源标记。

响应

Name Type Description
200 OK

已成功更新主机池。

201 Created

已成功创建主机池。

Other Status Codes

描述操作失败的原因的自动化错误响应。

示例

HostPool_Create

Sample Request

PUT https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1?api-version=2022-02-10-preview

{
  "location": "centralus",
  "tags": {
    "tag1": "value1",
    "tag2": "value2"
  },
  "properties": {
    "friendlyName": "friendly",
    "description": "des1",
    "hostPoolType": "Pooled",
    "personalDesktopAssignmentType": "Automatic",
    "customRdpProperty": null,
    "maxSessionLimit": 999999,
    "loadBalancerType": "BreadthFirst",
    "registrationInfo": {
      "expirationTime": "2020-10-01T14:01:54.9571247Z",
      "registrationTokenOperation": "Update"
    },
    "vmTemplate": "{json:json}",
    "ssoadfsAuthority": "https://adfs",
    "ssoClientId": "client",
    "ssoClientSecretKeyVaultPath": "https://keyvault/secret",
    "ssoSecretType": "SharedKey",
    "preferredAppGroupType": "Desktop",
    "startVMOnConnect": false,
    "migrationRequest": {
      "migrationPath": "TenantGroups/{defaultV1TenantGroup.Name}/Tenants/{defaultV1Tenant.Name}/HostPools/{sessionHostPool.Name}",
      "operation": "Start"
    },
    "publicNetworkAccess": "Enabled",
    "agentUpdate": {
      "type": "Scheduled",
      "useSessionHostLocalTime": false,
      "maintenanceWindowTimeZone": "Alaskan Standard Time",
      "maintenanceWindows": [
        {
          "hour": 7,
          "dayOfWeek": "Friday"
        },
        {
          "hour": 8,
          "dayOfWeek": "Saturday"
        }
      ]
    }
  }
}

Sample Response

{
  "name": "hostPool1",
  "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1",
  "type": "/Microsoft.DesktopVirtualization/hostPools",
  "location": "centralus",
  "tags": {
    "key1": "value1",
    "key2": "value2"
  },
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2020-01-01T17:18:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
  },
  "properties": {
    "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325",
    "friendlyName": "friendly",
    "description": "des1",
    "hostPoolType": "Pooled",
    "personalDesktopAssignmentType": "Automatic",
    "customRdpProperty": null,
    "maxSessionLimit": 999999,
    "loadBalancerType": "BreadthFirst",
    "validationEnvironment": null,
    "ring": null,
    "registrationInfo": {
      "expirationTime": "2020-10-01T14:01:54.9571247Z",
      "token": "token",
      "registrationTokenOperation": "Update"
    },
    "vmTemplate": "{json:json}",
    "ssoadfsAuthority": "https://adfs",
    "ssoClientId": "client",
    "ssoClientSecretKeyVaultPath": "https://keyvault/secret",
    "ssoSecretType": "SharedKey",
    "preferredAppGroupType": "Desktop",
    "startVMOnConnect": false,
    "cloudPcResource": false,
    "migrationRequest": {
      "migrationPath": "TenantGroups/{defaultV1TenantGroup.Name}/Tenants/{defaultV1Tenant.Name}/HostPools/{sessionHostPool.Name}",
      "operation": "Start"
    },
    "publicNetworkAccess": "Enabled",
    "agentUpdate": {
      "type": "Scheduled",
      "useSessionHostLocalTime": false,
      "maintenanceWindowTimeZone": "Alaskan Standard Time",
      "maintenanceWindows": [
        {
          "hour": 7,
          "dayOfWeek": "Friday"
        },
        {
          "hour": 8,
          "dayOfWeek": "Saturday"
        }
      ]
    }
  }
}
{
  "name": "hostPool1",
  "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1",
  "type": "/Microsoft.DesktopVirtualization/hostPools",
  "location": "centralus",
  "tags": {
    "key1": "value1",
    "key2": "value2"
  },
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2020-01-01T17:18:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
  },
  "properties": {
    "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325",
    "friendlyName": "friendly",
    "description": "des1",
    "hostPoolType": "Pooled",
    "personalDesktopAssignmentType": "Automatic",
    "customRdpProperty": null,
    "maxSessionLimit": 999999,
    "loadBalancerType": "BreadthFirst",
    "validationEnvironment": null,
    "ring": null,
    "registrationInfo": {
      "expirationTime": "2020-10-01T14:01:54.9571247Z",
      "token": "token",
      "registrationTokenOperation": "Update"
    },
    "vmTemplate": "{json:json}",
    "ssoadfsAuthority": "https://adfs",
    "ssoClientId": "client",
    "ssoClientSecretKeyVaultPath": "https://keyvault/secret",
    "ssoSecretType": "SharedKey",
    "preferredAppGroupType": "Desktop",
    "startVMOnConnect": false,
    "cloudPcResource": false,
    "migrationRequest": {
      "migrationPath": "TenantGroups/{defaultV1TenantGroup.Name}/Tenants/{defaultV1Tenant.Name}/HostPools/{sessionHostPool.Name}",
      "operation": "Start"
    },
    "publicNetworkAccess": "Enabled",
    "agentUpdate": {
      "type": "Scheduled",
      "useSessionHostLocalTime": false,
      "maintenanceWindowTimeZone": "Alaskan Standard Time",
      "maintenanceWindows": [
        {
          "hour": 7,
          "dayOfWeek": "Friday"
        },
        {
          "hour": 8,
          "dayOfWeek": "Saturday"
        }
      ]
    }
  }
}

定义

AgentUpdateProperties

用于在会话主机上 (RDAgent、日内瓦监视代理和并行堆栈) 更新代理组件的首选设置。

CloudError

云错误对象。

CloudErrorProperties

云错误对象属性。

createdByType

创建资源的标识的类型。

DayOfWeek

星期一-星期日) (一周的一天。

HostPool

表示 HostPool 定义。

HostpoolPublicNetworkAccess

启用允许从公共和专用网络访问此资源,禁用允许仅通过专用终结点访问此资源

HostPoolType

桌面的 HostPool 类型。

Identity
LoadBalancerType

负载均衡器的类型。

MaintenanceWindowProperties

维护时段从一周中的小时和一天开始。

MigrationRequestProperties

arm 迁移的属性。

Operation

迁移的操作类型。

PersonalDesktopAssignmentType

HostPool 的个人DesktopAssignment 类型。

Plan
PreferredAppGroupType

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

PrivateEndpoint

专用终结点资源。

PrivateEndpointConnection

专用终结点连接资源。

PrivateEndpointConnectionProvisioningState

当前预配状态。

PrivateEndpointServiceConnectionStatus

专用终结点连接状态。

PrivateLinkServiceConnectionState

有关服务使用者与提供程序之间的连接状态的信息集合。

RegistrationInfo

表示 RegistrationInfo 定义。

RegistrationTokenOperation

重置令牌的类型。

ResourceIdentityType

标识类型。

SessionHostComponentUpdateType

用于更新代理组件的首选机制。 这是计划或默认值。

Sku
SkuTier

如果服务具有多个层,但在 PUT 上不需要,则需要资源提供程序实现此字段。

SSOSecretType

机密类型的单一登录类型。

systemData

与创建和上次修改资源相关的元数据。

AgentUpdateProperties

用于在会话主机上 (RDAgent、日内瓦监视代理和并行堆栈) 更新代理组件的首选设置。

Name Type Description
maintenanceWindowTimeZone
  • string

用于更新代理组件的时区。 可在以下位置找到有效的时区: https://docs.microsoft.com/en-us/dotnet/api/system.timezoneinfo.findsystemtimezonebyid?view=net-5.0 如果 useSessionHostLocalTime 为 false,则必须指定时区。

maintenanceWindows

更新代理组件的维护时段 (日期和时间) 。 必须至少指定 1 个窗口。 (可选)可以指定第二个窗口。

type

用于更新代理组件的首选机制。 这是计划或默认值。

useSessionHostLocalTime
  • boolean

指示是否更新主机池中每个会话主机的本地时区中的代理组件的布尔值。 默认情况下,这是 false。

CloudError

云错误对象。

Name Type Description
error

云错误对象属性。

CloudErrorProperties

云错误对象属性。

Name Type Description
code
  • string

错误代码

message
  • string

指示操作失败的原因的错误消息。

createdByType

创建资源的标识的类型。

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

DayOfWeek

星期一-星期日) (一周的一天。

Name Type Description
Friday
  • string
Monday
  • string
Saturday
  • string
Sunday
  • string
Thursday
  • string
Tuesday
  • string
Wednesday
  • string

HostPool

表示 HostPool 定义。

Name Type Description
etag
  • string

不需要 etag 字段。 如果在响应正文中提供,则还必须根据常规 etag 约定将其作为标头提供。 实体标记用于比较同一请求资源的两个或多个实体。 HTTP/1.1 在 etag (节 14.19) 中使用实体标记,If-Match (第 14.24 节) 、If-None-Match (第 14.26 节) 和If-Range (第 14.27 节) 标头字段。

id
  • string

资源的完全限定的资源 ID。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity
kind
  • string

门户/工具/etc 用于为相同类型的资源呈现不同的 UX 体验的元数据;例如,ApiApps 是 Microsoft.Web/sites 类型的类型。 如果受支持,资源提供程序必须验证并保留此值。

location
  • string

资源所在的地理位置

managedBy
  • string

管理此资源的资源的完全限定资源 ID。 指示此资源是否由另一个 Azure 资源管理。 如果存在这种情况,则如果从模板中删除该资源,则完整模式部署不会删除该资源,因为该资源由另一个资源管理。

name
  • string

资源的名称

plan
properties.agentUpdate

用于在会话主机上 (RDAgent、日内瓦监视代理和并行堆栈) 更新代理组件的首选设置。

properties.applicationGroupReferences
  • string[]

applicationGroup 链接列表。

properties.cloudPcResource
  • boolean

云电脑资源。

properties.customRdpProperty
  • string

HostPool 的自定义 rdp 属性。

properties.description
  • string

HostPool 的说明。

properties.friendlyName
  • string

HostPool 的友好名称。

properties.hostPoolType

桌面的 HostPool 类型。

properties.loadBalancerType

负载均衡器的类型。

properties.maxSessionLimit
  • integer

HostPool 的最大会话限制。

properties.migrationRequest

HostPool 的注册信息。

properties.objectId
  • string

HostPool 的 ObjectId。 (内部使用)

properties.personalDesktopAssignmentType

HostPool 的 PersonalDesktopAssignment 类型。

properties.preferredAppGroupType

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

properties.privateEndpointConnections

与指定资源关联的专用终结点连接列表

properties.publicNetworkAccess

启用后,可从公共和专用网络访问此资源,禁用后,仅可通过专用终结点访问此资源

properties.registrationInfo

HostPool 的注册信息。

properties.ring
  • integer

HostPool 的环号。

properties.ssoClientId
  • string

用于颁发 WVD SSO 证书的已注册信赖方的 ClientId。

properties.ssoClientSecretKeyVaultPath
  • string

存储用于与 ADFS 通信的机密的 Azure KeyVault 的路径。

properties.ssoSecretType

机密类型的单一登录类型。

properties.ssoadfsAuthority
  • string

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

properties.startVMOnConnect
  • boolean

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

properties.validationEnvironment
  • boolean

是验证环境。

properties.vmTemplate
  • string

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

sku
systemData

与创建和上次修改资源相关的元数据。

tags
  • object

资源标记。

type
  • string

资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft”。存储/storageAccounts”

HostpoolPublicNetworkAccess

启用允许从公共和专用网络访问此资源,禁用允许仅通过专用终结点访问此资源

Name Type Description
Disabled
  • string
Enabled
  • string
EnabledForClientsOnly
  • string
EnabledForSessionHostsOnly
  • string

HostPoolType

桌面的 HostPool 类型。

Name Type Description
BYODesktop
  • string

用户分配自己的计算机,负载均衡逻辑与个人逻辑保持不变。 PersonalDesktopAssignmentType 必须是 Direct。

Personal
  • string

管理员 (PersonalDesktopAssignmentType = Direct) 或连接到池时, (PersonalDesktopAssignmentType = 自动) ,将为用户分配 SessionHost。 它们将始终重定向到其分配的 SessionHost。

Pooled
  • string

每次连接到 HostPool 时,用户都会获得新的 (随机) SessionHost。

Identity

Name Type Description
principalId
  • string

资源标识的主体 ID。

tenantId
  • string

资源的租户 ID。

type

标识类型。

LoadBalancerType

负载均衡器的类型。

Name Type Description
BreadthFirst
  • string
DepthFirst
  • string
Persistent
  • string

MaintenanceWindowProperties

维护时段从一周中的小时和一天开始。

Name Type Description
dayOfWeek

星期一-星期日) (一周的一天。

hour
  • integer

维护时段的开始时间 (0-23) 。 请注意,维护时段长 2 小时。 这意味着,可以从指定的开始时间到 2 小时后随时应用更新。

MigrationRequestProperties

arm 迁移的属性。

Name Type Description
migrationPath
  • string

要迁移的旧对象的路径。

operation

迁移操作的类型。

Operation

迁移的操作类型。

Name Type Description
Complete
  • string

完成迁移。

Hide
  • string

隐藏主机池。

Revoke
  • string

撤销迁移。

Start
  • string

开始迁移。

Unhide
  • string

取消隐藏主机池。

PersonalDesktopAssignmentType

HostPool 的个人DesktopAssignment 类型。

Name Type Description
Automatic
  • string
Direct
  • string

Plan

Name Type Description
name
  • string

要采购的第三方项目的用户定义的名称。

product
  • string

正在采购的第三方项目。 例如 NewRelic。 产品映射到在数据市场载入时为项目指定的 OfferID。

promotionCode
  • string

发布者为上述产品/项目提供数据市场中预配的促销代码。

publisher
  • string

正在购买的第三方项目的发布者。 例如 NewRelic

version
  • string

所需产品/项目的版本。

PreferredAppGroupType

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

Name Type Description
Desktop
  • string
None
  • string
RailApplications
  • string

PrivateEndpoint

专用终结点资源。

Name Type Description
id
  • string

专用终结点的 ARM 标识符

PrivateEndpointConnection

专用终结点连接资源。

Name Type Description
id
  • string

资源的完全限定的资源 ID。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name
  • string

资源的名称

properties.privateEndpoint

专用终结点的资源。

properties.privateLinkServiceConnectionState

有关服务使用者与提供程序之间的连接状态的信息集合。

properties.provisioningState

专用终结点连接资源的预配状态。

type
  • string

资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft”。存储/storageAccounts”

PrivateEndpointConnectionProvisioningState

当前预配状态。

Name Type Description
Creating
  • string
Deleting
  • string
Failed
  • string
Succeeded
  • string

PrivateEndpointServiceConnectionStatus

专用终结点连接状态。

Name Type Description
Approved
  • string
Pending
  • string
Rejected
  • string

PrivateLinkServiceConnectionState

有关服务使用者与提供程序之间的连接状态的信息集合。

Name Type Description
actionsRequired
  • string

一条消息,指示服务提供商上的更改是否需要对使用者进行任何更新。

description
  • string

批准/拒绝连接的原因。

status

指示是否已由服务的所有者批准/拒绝/删除连接。

RegistrationInfo

表示 RegistrationInfo 定义。

Name Type Description
expirationTime
  • string

注册令牌的过期时间。

registrationTokenOperation

重置令牌的类型。

token
  • string

注册令牌 base64 编码字符串。

RegistrationTokenOperation

重置令牌的类型。

Name Type Description
Delete
  • string
None
  • string
Update
  • string

ResourceIdentityType

标识类型。

Name Type Description
SystemAssigned
  • string

SessionHostComponentUpdateType

用于更新代理组件的首选机制。 这是计划或默认值。

Name Type Description
Default
  • string

根据 AVD 基础结构外部测试版更新代理组件。 有关详细信息,请参阅 https://aka.ms/avdagent

Scheduled
  • string

这将启用计划代理更新功能,该功能允许代理组件根据管理员定义的计划进行更新。 有关详细信息,请参阅 https://aka.ms/avdsau

Sku

Name Type Description
capacity
  • integer

如果 SKU 支持横向扩展/缩减,则应包含容量整数。 如果资源无法横向扩展/缩小,则可能会省略。

family
  • string

如果服务具有不同代的硬件(对于同一 SKU,则可以在此处捕获)。

name
  • string

SKU 的名称。 前 - P3。 它通常是字母+数字代码

size
  • string

SKU 大小。 当名称字段是层和其他一些值的组合时,这将是独立的代码。

tier

如果服务具有多个层,但在 PUT 上不需要,则需要资源提供程序实现此字段。

SkuTier

如果服务具有多个层,但在 PUT 上不需要,则需要资源提供程序实现此字段。

Name Type Description
Basic
  • string
Free
  • string
Premium
  • string
Standard
  • string

SSOSecretType

机密类型的单一登录类型。

Name Type Description
Certificate
  • string
CertificateInKeyVault
  • string
SharedKey
  • string
SharedKeyInKeyVault
  • string

systemData

与创建和上次修改资源相关的元数据。

Name Type Description
createdAt
  • string

资源创建时间戳 (UTC) 。

createdBy
  • string

创建资源的标识。

createdByType

创建资源的标识的类型。

lastModifiedAt
  • string

资源上次修改的时间戳 (UTC)

lastModifiedBy
  • string

上次修改资源的标识。

lastModifiedByType

上次修改资源的标识的类型。