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

HostPool interface

包:

@azure/arm-desktopvirtualization

表示 HostPool 定义。

扩展

ResourceModelWithAllowedPropertySet

属性

agentUpdate	用于更新代理、监视代理和堆栈组件的会话主机配置。
appAttachPackageReferences	应用附加包链接的列表。 注意：此属性不会序列化。 它只能由服务器填充。
applicationGroupReferences	applicationGroup 链接列表。 注意：此属性不会序列化。 它只能由服务器填充。
cloudPcResource	云电脑资源。 注意：此属性不会序列化。 它只能由服务器填充。
customRdpProperty	HostPool 的自定义 rdp 属性。
description	HostPool 的说明。
friendlyName	HostPool 的友好名称。
hostPoolType	适用于桌面的 HostPool 类型。
loadBalancerType	负载均衡器的类型。
maxSessionLimit	HostPool 的最大会话限制。
objectId	HostPool 的 ObjectId。 （内部使用）注意：此属性不会序列化。 它只能由服务器填充。
personalDesktopAssignmentType	HostPool 的 PersonalDesktopAssignment 类型。
preferredAppGroupType	首选应用程序组类型的类型，默认为桌面应用程序组
privateEndpointConnections	与指定资源说明关联的专用终结点连接列表：此属性不会序列化。 它只能由服务器填充。
publicNetworkAccess	启用后，可从公共和专用网络访问此资源，禁用后，只能通过专用终结点访问此资源
registrationInfo	HostPool 的注册信息。
ring	HostPool 的环号。
ssoadfsAuthority	用于对 WVD SSO 证书进行签名的客户 ADFS 服务器的 URL。
ssoClientId	用于颁发 WVD SSO 证书的已注册信赖方的 ClientId。
ssoClientSecretKeyVaultPath	存储用于与 ADFS 通信的机密的 Azure KeyVault 的路径。
ssoSecretType	单一登录机密类型的类型。
startVMOnConnect	要打开/关闭 StartVMOnConnect 功能的标志。
validationEnvironment	验证环境。
vmTemplate	主机池中会话主机配置的 VM 模板。

继承属性

etag	etag 字段 不需要。 如果在响应正文中提供，则还必须根据正常的 etag 约定将其作为标头提供。 实体标记用于比较同一请求资源的两个或多个实体。 HTTP/1.1 在 etag（第 14.19 节）、If-Match（第 14.24 节）、If-None-Match（第 14.26 节）和 If-Range（第 14.27 节）标头字段中使用实体标记。 注意：此属性不会序列化。 它只能由服务器填充。
id	资源的完全限定资源 ID。 例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”注意：此属性不会序列化。 它只能由服务器填充。
identity
kind	门户/工具等用于为相同类型的资源呈现不同的 UX 体验的元数据。 例如，ApiApps 是一种 Microsoft.Web/sites 类型。 如果受支持，资源提供程序必须验证并保留此值。
location	资源所在的地理位置
managedBy	管理此资源的资源的完全限定资源 ID。 指示此资源是否由另一个 Azure 资源管理。 如果存在，则完全模式部署不会删除资源（如果从模板中删除，因为它由另一个资源管理）。
name	资源说明的名称：此属性不会序列化。 它只能由服务器填充。
plan
sku
systemData	包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。 注意：此属性不会序列化。 它只能由服务器填充。
tags	资源标记。
type	资源的类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”注意：此属性不会序列化。 它只能由服务器填充。

属性详细信息

agentUpdate

用于更新代理、监视代理和堆栈组件的会话主机配置。

agentUpdate?: AgentUpdateProperties

属性值

AgentUpdateProperties

appAttachPackageReferences

应用附加包链接的列表。 注意：此属性不会序列化。 它只能由服务器填充。

appAttachPackageReferences?: string[]

属性值

string[]

applicationGroupReferences

applicationGroup 链接列表。 注意：此属性不会序列化。 它只能由服务器填充。

applicationGroupReferences?: string[]

属性值

string[]

cloudPcResource

云电脑资源。 注意：此属性不会序列化。 它只能由服务器填充。

cloudPcResource?: boolean

属性值

boolean

customRdpProperty

HostPool 的自定义 rdp 属性。

customRdpProperty?: string

属性值

string

description

HostPool 的说明。

description?: string

属性值

string

friendlyName

HostPool 的友好名称。

friendlyName?: string

属性值

string

hostPoolType

适用于桌面的 HostPool 类型。

hostPoolType: string

属性值

string

loadBalancerType

负载均衡器的类型。

loadBalancerType: string

属性值

string

maxSessionLimit

HostPool 的最大会话限制。

maxSessionLimit?: number

属性值

number

objectId

HostPool 的 ObjectId。 （内部使用）注意：此属性不会序列化。 它只能由服务器填充。

objectId?: string

属性值

string

personalDesktopAssignmentType

HostPool 的 PersonalDesktopAssignment 类型。

personalDesktopAssignmentType?: string

属性值

string

preferredAppGroupType

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

preferredAppGroupType: string

属性值

string

privateEndpointConnections

与指定资源说明关联的专用终结点连接列表：此属性不会序列化。 它只能由服务器填充。

privateEndpointConnections?: PrivateEndpointConnection[]

属性值

PrivateEndpointConnection[]

publicNetworkAccess

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

publicNetworkAccess?: string

属性值

string

registrationInfo

HostPool 的注册信息。

registrationInfo?: RegistrationInfo

属性值

RegistrationInfo

ring

HostPool 的环号。

ring?: number

属性值

number

ssoadfsAuthority

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

ssoadfsAuthority?: string

属性值

string

ssoClientId

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

ssoClientId?: string

属性值

string

ssoClientSecretKeyVaultPath

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

ssoClientSecretKeyVaultPath?: string

属性值

string

ssoSecretType

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

ssoSecretType?: string

属性值

string

startVMOnConnect

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

startVMOnConnect?: boolean

属性值

boolean

validationEnvironment

验证环境。

validationEnvironment?: boolean

属性值

boolean

vmTemplate

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

vmTemplate?: string

属性值

string

继承属性详细信息

etag

etag 字段 不需要。 如果在响应正文中提供，则还必须根据正常的 etag 约定将其作为标头提供。 实体标记用于比较同一请求资源的两个或多个实体。 HTTP/1.1 在 etag（第 14.19 节）、If-Match（第 14.24 节）、If-None-Match（第 14.26 节）和 If-Range（第 14.27 节）标头字段中使用实体标记。 注意：此属性不会序列化。 它只能由服务器填充。

etag?: string

属性值

string

继承自ResourceModelWithAllowedPropertySet.etag

id

资源的完全限定资源 ID。 例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”注意：此属性不会序列化。 它只能由服务器填充。

id?: string

属性值

string

继承自ResourceModelWithAllowedPropertySet.id 的

identity

identity?: ResourceModelWithAllowedPropertySetIdentity

属性值

ResourceModelWithAllowedPropertySetIdentity

继承自ResourceModelWithAllowedPropertySet.identity

kind

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

kind?: string

属性值

string

继承自ResourceModelWithAllowedPropertySet.kind

location

资源所在的地理位置

location: string

属性值

string

继承自ResourceModelWithAllowedPropertySet.location

managedBy

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

managedBy?: string

属性值

string

继承自ResourceModelWithAllowedPropertySet.managedBy

name

资源说明的名称：此属性不会序列化。 它只能由服务器填充。

name?: string

属性值

string

继承自ResourceModelWithAllowedPropertySet.name 的

plan

plan?: ResourceModelWithAllowedPropertySetPlan

属性值

ResourceModelWithAllowedPropertySetPlan

继承自ResourceModelWithAllowedPropertySet.plan

sku

sku?: ResourceModelWithAllowedPropertySetSku

属性值

ResourceModelWithAllowedPropertySetSku

继承自ResourceModelWithAllowedPropertySet.sku

systemData

包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。 注意：此属性不会序列化。 它只能由服务器填充。

systemData?: SystemData

属性值

SystemData

继承自ResourceModelWithAllowedPropertySet.systemData

tags

资源标记。

tags?: {[propertyName: string]: string}

属性值

{[propertyName: string]: string}

继承自resourceModelWithAllowedPropertySet.tags

type

资源的类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”注意：此属性不会序列化。 它只能由服务器填充。

type?: string

属性值

string

继承自ResourceModelWithAllowedPropertySet.type