Share via

HostPoolPatch interface

  • Reference
Package:
@azure/arm-desktopvirtualization

HostPool properties that can be patched.

Extends
Resource

Properties

agentUpdate

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

Custom rdp property of HostPool.
description

Description of HostPool.
friendlyName

Friendly name of HostPool.
loadBalancerType

The type of the load balancer.
maxSessionLimit

The max session limit of HostPool.
personalDesktopAssignmentType

PersonalDesktopAssignment type for HostPool.
preferredAppGroupType

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

Enabled to allow this resource to be access from the public network
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.
tags

tags to be updated
validationEnvironment

Is validation environment.
vmTemplate

VM template for sessionhosts configuration within hostpool.

Inherited Properties

id

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.
name

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

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.
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?: AgentUpdatePatchProperties

Property Value

AgentUpdatePatchProperties

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

loadBalancerType

The type of the load balancer.

loadBalancerType?: string

Property Value

string

maxSessionLimit

The max session limit of HostPool.

maxSessionLimit?: number

Property Value

number

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

publicNetworkAccess

Enabled to allow this resource to be access from the public network

publicNetworkAccess?: string

Property Value

string

registrationInfo

The registration info of HostPool.

registrationInfo?: RegistrationInfoPatch

Property Value

RegistrationInfoPatch

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

tags

tags to be updated

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

Property Value

{[propertyName: string]: string}

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

id

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

string

Inherited From Resource.id

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 Resource.name

systemData

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

SystemData

Inherited From Resource.systemData

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 Resource.type