Share via

HostPool interface

  • Reference
Package:
@azure/arm-desktopvirtualization

Represents a HostPool definition.

Extends
ResourceModelWithAllowedPropertySet

Properties

agentUpdate

The session host configuration for updating agent, monitoring agent, and stack component.
applicationGroupReferences

List of applicationGroup links. NOTE: This property will not be serialized. It can only be populated by the server.
cloudPcResource

Is cloud pc resource. NOTE: This property will not be serialized. It can only be populated by the server.
customRdpProperty

Custom rdp property of HostPool.
description

Description of HostPool.
friendlyName

Friendly name of HostPool.
hostPoolType

HostPool type for desktop.
loadBalancerType

The type of the load balancer.
maxSessionLimit

The max session limit of HostPool.
objectId

ObjectId of HostPool. (internal use) NOTE: This property will not be serialized. It can only be populated by the server.
personalDesktopAssignmentType

PersonalDesktopAssignment type for HostPool.
preferredAppGroupType

The type of preferred application group type, default to Desktop Application Group
privateEndpointConnections

List of private endpoint connection associated with the specified resource NOTE: This property will not be serialized. It can only be populated by the server.
publicNetworkAccess

Enabled allows this resource to be accessed from both public and private networks, Disabled allows this resource to only be accessed via private endpoints
registrationInfo

The registration info of HostPool.
ring

The ring number of HostPool.
ssoadfsAuthority

URL to customer ADFS server for signing WVD SSO certificates.
ssoClientId

ClientId for the registered Relying Party used to issue WVD SSO certificates.
ssoClientSecretKeyVaultPath

Path to Azure KeyVault storing the secret used for communication to ADFS.
ssoSecretType

The type of single sign on Secret Type.
startVMOnConnect

The flag to turn on/off StartVMOnConnect feature.
systemData

Metadata pertaining to creation and last modification of the resource. NOTE: This property will not be serialized. It can only be populated by the server.
validationEnvironment

Is validation environment.
vmTemplate

VM template for sessionhosts configuration within hostpool.

Inherited Properties

etag

The etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. NOTE: This property will not be serialized. It can only be populated by the server.
id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.
identity
kind

Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.
location

The geo-location where the resource lives
managedBy

The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.
name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
plan
sku
tags

Resource tags.
type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

agentUpdate

The session host configuration for updating agent, monitoring agent, and stack component.

agentUpdate?: AgentUpdateProperties

Property Value

AgentUpdateProperties

applicationGroupReferences

List of applicationGroup links. NOTE: This property will not be serialized. It can only be populated by the server.

applicationGroupReferences?: string[]

Property Value

string[]

cloudPcResource

Is cloud pc resource. NOTE: This property will not be serialized. It can only be populated by the server.

cloudPcResource?: boolean

Property Value

boolean

customRdpProperty

Custom rdp property of HostPool.

customRdpProperty?: string

Property Value

string

description

Description of HostPool.

description?: string

Property Value

string

friendlyName

Friendly name of HostPool.

friendlyName?: string

Property Value

string

hostPoolType

HostPool type for desktop.

hostPoolType: string

Property Value

string

loadBalancerType

The type of the load balancer.

loadBalancerType: string

Property Value

string

maxSessionLimit

The max session limit of HostPool.

maxSessionLimit?: number

Property Value

number

objectId

ObjectId of HostPool. (internal use) NOTE: This property will not be serialized. It can only be populated by the server.

objectId?: string

Property Value

string

personalDesktopAssignmentType

PersonalDesktopAssignment type for HostPool.

personalDesktopAssignmentType?: string

Property Value

string

preferredAppGroupType

The type of preferred application group type, default to Desktop Application Group

preferredAppGroupType: string

Property Value

string

privateEndpointConnections

List of private endpoint connection associated with the specified resource NOTE: This property will not be serialized. It can only be populated by the server.

privateEndpointConnections?: PrivateEndpointConnection[]

Property Value

PrivateEndpointConnection[]

publicNetworkAccess

Enabled allows this resource to be accessed from both public and private networks, Disabled allows this resource to only be accessed via private endpoints

publicNetworkAccess?: string

Property Value

string

registrationInfo

The registration info of HostPool.

registrationInfo?: RegistrationInfo

Property Value

RegistrationInfo

ring

The ring number of HostPool.

ring?: number

Property Value

number

ssoadfsAuthority

URL to customer ADFS server for signing WVD SSO certificates.

ssoadfsAuthority?: string

Property Value

string

ssoClientId

ClientId for the registered Relying Party used to issue WVD SSO certificates.

ssoClientId?: string

Property Value

string

ssoClientSecretKeyVaultPath

Path to Azure KeyVault storing the secret used for communication to ADFS.

ssoClientSecretKeyVaultPath?: string

Property Value

string

ssoSecretType

The type of single sign on Secret Type.

ssoSecretType?: string

Property Value

string

startVMOnConnect

The flag to turn on/off StartVMOnConnect feature.

startVMOnConnect?: boolean

Property Value

boolean

systemData

Metadata pertaining to creation and last modification of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

validationEnvironment

Is validation environment.

validationEnvironment?: boolean

Property Value

boolean

vmTemplate

VM template for sessionhosts configuration within hostpool.

vmTemplate?: string

Property Value

string

Inherited Property Details

etag

The etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. NOTE: This property will not be serialized. It can only be populated by the server.

etag?: string

Property Value

string

Inherited From ResourceModelWithAllowedPropertySet.etag

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ResourceModelWithAllowedPropertySet.id

identity 

identity?: ResourceModelWithAllowedPropertySetIdentity

Property Value

ResourceModelWithAllowedPropertySetIdentity

Inherited From ResourceModelWithAllowedPropertySet.identity

kind

Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.

kind?: string

Property Value

string

Inherited From ResourceModelWithAllowedPropertySet.kind

location

The geo-location where the resource lives

location?: string

Property Value

string

Inherited From ResourceModelWithAllowedPropertySet.location

managedBy

The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.

managedBy?: string

Property Value

string

Inherited From ResourceModelWithAllowedPropertySet.managedBy

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From ResourceModelWithAllowedPropertySet.name

plan 

plan?: ResourceModelWithAllowedPropertySetPlan

Property Value

ResourceModelWithAllowedPropertySetPlan

Inherited From ResourceModelWithAllowedPropertySet.plan

sku 

sku?: ResourceModelWithAllowedPropertySetSku

Property Value

ResourceModelWithAllowedPropertySetSku

Inherited From ResourceModelWithAllowedPropertySet.sku

tags

Resource tags.

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

Property Value

{[propertyName: string]: string}

Inherited From ResourceModelWithAllowedPropertySet.tags

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ResourceModelWithAllowedPropertySet.type