HostPool interface

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

agentUpdate?: AgentUpdateProperties

Property Value

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

appAttachPackageReferences?: string[]

Property Value

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

applicationGroupReferences?: string[]

Property Value

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

cloudPcResource?: boolean

Property Value

Custom rdp property of HostPool.

customRdpProperty?: string

Property Value

Description of HostPool.

description?: string

Property Value

Friendly name of HostPool.

friendlyName?: string

Property Value

HostPool type for desktop.

hostPoolType: string

Property Value

The type of the load balancer.

loadBalancerType: string

Property Value

The max session limit of HostPool.

maxSessionLimit?: number

Property Value

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

objectId?: string

Property Value

PersonalDesktopAssignment type for HostPool.

personalDesktopAssignmentType?: string

Property Value

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

preferredAppGroupType: string

Property Value

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

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

The registration info of HostPool.

registrationInfo?: RegistrationInfo

Property Value

The ring number of HostPool.

ring?: number

Property Value

URL to customer ADFS server for signing WVD SSO certificates.

ssoadfsAuthority?: string

Property Value

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

ssoClientId?: string

Property Value

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

ssoClientSecretKeyVaultPath?: string

Property Value

The type of single sign on Secret Type.

ssoSecretType?: string

Property Value

The flag to turn on/off StartVMOnConnect feature.

startVMOnConnect?: boolean

Property Value

Is validation environment.

validationEnvironment?: boolean

Property Value

VM template for sessionhosts configuration within hostpool.

vmTemplate?: string

Property Value

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

Inherited From ResourceModelWithAllowedPropertySet.etag

Fully qualified resource ID for the resource. E.g. "/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

Inherited From ResourceModelWithAllowedPropertySet.id

identity?: ResourceModelWithAllowedPropertySetIdentity

Property Value

Inherited From ResourceModelWithAllowedPropertySet.identity

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

Inherited From ResourceModelWithAllowedPropertySet.kind

The geo-location where the resource lives

location: string

Property Value

Inherited From ResourceModelWithAllowedPropertySet.location

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

Inherited From ResourceModelWithAllowedPropertySet.managedBy

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

name?: string

Property Value

Inherited From ResourceModelWithAllowedPropertySet.name

plan?: ResourceModelWithAllowedPropertySetPlan

Property Value

Inherited From ResourceModelWithAllowedPropertySet.plan

sku?: ResourceModelWithAllowedPropertySetSku

Property Value

Inherited From ResourceModelWithAllowedPropertySet.sku

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

Inherited From ResourceModelWithAllowedPropertySet.systemData

Resource tags.

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

Property Value

Inherited From ResourceModelWithAllowedPropertySet.tags

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

Inherited From ResourceModelWithAllowedPropertySet.type