HostPoolData Class

Definition

A class representing the HostPool data model. Represents a HostPool definition.

public class HostPoolData : Azure.ResourceManager.Models.TrackedResourceData, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.DesktopVirtualization.HostPoolData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.DesktopVirtualization.HostPoolData>
type HostPoolData = class
    inherit TrackedResourceData
    interface IJsonModel<HostPoolData>
    interface IPersistableModel<HostPoolData>
Public Class HostPoolData
Inherits TrackedResourceData
Implements IJsonModel(Of HostPoolData), IPersistableModel(Of HostPoolData)
Inheritance
Implements

Constructors

HostPoolData(AzureLocation, HostPoolType, HostPoolLoadBalancerType, PreferredAppGroupType)

Initializes a new instance of HostPoolData.

Properties

AgentUpdate

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

AppAttachPackageReferences

List of App Attach Package links.

ApplicationGroupReferences

List of applicationGroup links.

CustomRdpProperty

Custom rdp property of HostPool.

Description

Description of HostPool.

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.

FriendlyName

Friendly name of HostPool.

HostPoolType

HostPool type for desktop.

Id

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

(Inherited from ResourceData)
Identity

Gets or sets the identity. Current supported identity types: SystemAssigned.

IsCloudPCResource

Is cloud pc resource.

IsValidationEnvironment

Is validation environment.

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.

LoadBalancerType

The type of the load balancer.

Location

The geo-location where the resource lives.

(Inherited from TrackedResourceData)
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.

MaxSessionLimit

The max session limit of HostPool.

Name

The name of the resource.

(Inherited from ResourceData)
ObjectId

ObjectId of HostPool. (internal use).

PersonalDesktopAssignmentType

PersonalDesktopAssignment type for HostPool.

Plan

Gets or sets the plan.

PreferredAppGroupType

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

PrivateEndpointConnections

List of private endpoint connection associated with the specified resource.

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.

ResourceType

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

(Inherited from ResourceData)
Ring

The ring number of HostPool.

Sku

The resource model definition representing SKU.

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

Azure Resource Manager metadata containing createdBy and modifiedBy information.

(Inherited from ResourceData)
Tags

Resource tags.

(Inherited from TrackedResourceData)
VmTemplate

VM template for sessionhosts configuration within hostpool.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from TrackedResourceData)

Explicit Interface Implementations

IJsonModel<HostPoolData>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<HostPoolData>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<HostPoolData>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<HostPoolData>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<HostPoolData>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to