GetHostPoolResult

data class GetHostPoolResult(val agentUpdate: AgentUpdatePropertiesResponse? = null, val applicationGroupReferences: List<String>, val cloudPcResource: Boolean, val customRdpProperty: String? = null, val description: String? = null, val etag: String, val friendlyName: String? = null, val hostPoolType: String, val id: String, val identity: ResourceModelWithAllowedPropertySetResponseIdentity? = null, val kind: String? = null, val loadBalancerType: String, val location: String? = null, val managedBy: String? = null, val maxSessionLimit: Int? = null, val name: String, val objectId: String, val personalDesktopAssignmentType: String? = null, val plan: ResourceModelWithAllowedPropertySetResponsePlan? = null, val preferredAppGroupType: String, val registrationInfo: RegistrationInfoResponse? = null, val ring: Int? = null, val sku: ResourceModelWithAllowedPropertySetResponseSku? = null, val ssoClientId: String? = null, val ssoClientSecretKeyVaultPath: String? = null, val ssoSecretType: String? = null, val ssoadfsAuthority: String? = null, val startVMOnConnect: Boolean? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val validationEnvironment: Boolean? = null, val vmTemplate: String? = null)

Represents a HostPool definition.

Constructors

Link copied to clipboard
constructor(agentUpdate: AgentUpdatePropertiesResponse? = null, applicationGroupReferences: List<String>, cloudPcResource: Boolean, customRdpProperty: String? = null, description: String? = null, etag: String, friendlyName: String? = null, hostPoolType: String, id: String, identity: ResourceModelWithAllowedPropertySetResponseIdentity? = null, kind: String? = null, loadBalancerType: String, location: String? = null, managedBy: String? = null, maxSessionLimit: Int? = null, name: String, objectId: String, personalDesktopAssignmentType: String? = null, plan: ResourceModelWithAllowedPropertySetResponsePlan? = null, preferredAppGroupType: String, registrationInfo: RegistrationInfoResponse? = null, ring: Int? = null, sku: ResourceModelWithAllowedPropertySetResponseSku? = null, ssoClientId: String? = null, ssoClientSecretKeyVaultPath: String? = null, ssoSecretType: String? = null, ssoadfsAuthority: String? = null, startVMOnConnect: Boolean? = null, systemData: SystemDataResponse, tags: Map<String, String>? = null, type: String, validationEnvironment: Boolean? = null, vmTemplate: String? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

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

Link copied to clipboard

List of applicationGroup links.

Link copied to clipboard

Is cloud pc resource.

Link copied to clipboard

Custom rdp property of HostPool.

Link copied to clipboard
val description: String? = null

Description of HostPool.

Link copied to clipboard

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.

Link copied to clipboard
val friendlyName: String? = null

Friendly name of HostPool.

Link copied to clipboard

HostPool type for desktop.

Link copied to clipboard
val id: String

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

Link copied to clipboard
val kind: String? = null

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.

Link copied to clipboard

The type of the load balancer.

Link copied to clipboard
val location: String? = null

The geo-location where the resource lives

Link copied to clipboard
val managedBy: String? = null

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.

Link copied to clipboard
val maxSessionLimit: Int? = null

The max session limit of HostPool.

Link copied to clipboard

The name of the resource

Link copied to clipboard

ObjectId of HostPool. (internal use)

Link copied to clipboard

PersonalDesktopAssignment type for HostPool.

Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard

The registration info of HostPool.

Link copied to clipboard
val ring: Int? = null

The ring number of HostPool.

Link copied to clipboard
Link copied to clipboard

URL to customer ADFS server for signing WVD SSO certificates.

Link copied to clipboard
val ssoClientId: String? = null

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

Link copied to clipboard

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

Link copied to clipboard
val ssoSecretType: String? = null

The type of single sign on Secret Type.

Link copied to clipboard

The flag to turn on/off StartVMOnConnect feature.

Link copied to clipboard

Metadata pertaining to creation and last modification of the resource.

Link copied to clipboard
val tags: Map<String, String>? = null

Resource tags.

Link copied to clipboard

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Link copied to clipboard

Is validation environment.

Link copied to clipboard
val vmTemplate: String? = null

VM template for sessionhosts configuration within hostpool.