HostPool interface

套件:

@azure/arm-desktopvirtualization

表示 HostPool 定義。

Extends

ResourceModelWithAllowedPropertySet

屬性

agentUpdate	更新代理程式、監視代理程式和堆疊元件的會話主機組態。
appAttachPackageReferences	應用程式附加套件連結的清單。 注意：這個屬性不會串行化。 它只能由伺服器填入。
applicationGroupReferences	applicationGroup 連結的清單。 注意：這個屬性不會串行化。 它只能由伺服器填入。
cloudPcResource	這是雲端計算機資源。 注意：這個屬性不會串行化。 它只能由伺服器填入。
customRdpProperty	HostPool 的自定義 rdp 屬性。
description	HostPool 的描述。
friendlyName	HostPool 的易記名稱。
hostPoolType	桌面的 HostPool 類型。
loadBalancerType	負載平衡器的型別。
maxSessionLimit	HostPool 的最大會話限制。
objectId	HostPool 的 ObjectId。 （內部使用）注意：這個屬性不會串行化。 它只能由伺服器填入。
personalDesktopAssignmentType	HostPool 的個人DesktopAssignment 類型。
preferredAppGroupType	慣用應用程式群組類型的類型，預設為傳統型應用程式群組
privateEndpointConnections	與指定資源相關聯的私人端點連線清單注意：此屬性將不會串行化。 它只能由伺服器填入。
publicNetworkAccess	Enabled 允許從公用和專用網存取此資源，[已停用] 可讓此資源只能透過私人端點存取
registrationInfo	HostPool 的註冊資訊。
ring	HostPool 的通道編號。
ssoadfsAuthority	客戶 ADFS 伺服器的 URL，用於簽署 WVD SSO 憑證。
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 （section 14.26） 和 If-Range （第 14.27 節） 標頭字段中使用實體標記。 注意：這個屬性不會串行化。 它只能由伺服器填入。
id	資源的完整資源標識碼。 例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” 附注：此屬性將不會串行化。 它只能由伺服器填入。
identity
kind	入口網站/工具等用來轉譯相同類型資源的不同UX體驗的元數據。 例如，ApiApps 是一種Microsoft.Web/sites 類型。 如果支援，資源提供者必須驗證並保存此值。
location	資源所在的地理位置
managedBy	管理此資源之資源的完整資源標識碼。 指出此資源是否由另一個 Azure 資源管理。 如果存在，如果從範本中移除，則完整模式部署將不會刪除資源，因為該資源是由另一個資源管理。
name	資源名稱注意：此屬性將不會串行化。 它只能由伺服器填入。
plan
sku
systemData	包含 createdBy 和 modifiedBy 資訊的 Azure Resource Manager 元數據。 注意：這個屬性不會串行化。 它只能由伺服器填入。
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 的個人DesktopAssignment 類型。

personalDesktopAssignmentType?: string

屬性值

string

preferredAppGroupType

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

preferredAppGroupType: string

屬性值

string

privateEndpointConnections

與指定資源相關聯的私人端點連線清單注意：此屬性將不會串行化。 它只能由伺服器填入。

privateEndpointConnections?: PrivateEndpointConnection[]

屬性值

PrivateEndpointConnection[]

publicNetworkAccess

Enabled 允許從公用和專用網存取此資源，[已停用] 可讓此資源只能透過私人端點存取

publicNetworkAccess?: string

屬性值

string

registrationInfo

HostPool 的註冊資訊。

registrationInfo?: RegistrationInfo

屬性值

RegistrationInfo

ring

HostPool 的通道編號。

ring?: number

屬性值

number

ssoadfsAuthority

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

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 （section 14.26） 和 If-Range （第 14.27 節） 標頭字段中使用實體標記。 注意：這個屬性不會串行化。 它只能由伺服器填入。

etag?: string

屬性值

string

繼承自ResourceModelWithAllowedPropertySet.etag

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

管理此資源之資源的完整資源標識碼。 指出此資源是否由另一個 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 Resource Manager 元數據。 注意：這個屬性不會串行化。 它只能由伺服器填入。

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