HostPool Class

Definition

Namespace:

Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models

Assembly:

Az.DesktopVirtualization.private.dll

Represents a HostPool definition.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.HostPoolTypeConverter))]
public class HostPool : Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.IHostPool, Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Runtime.IValidates

[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.HostPoolTypeConverter))>]
type HostPool = class
    interface IHostPool
    interface IJsonSerializable
    interface IResourceModelWithAllowedPropertySet
    interface ITrackedResource
    interface IResource
    interface IValidates

Public Class HostPool
Implements IHostPool, IValidates

Inheritance

Object

HostPool

Attributes

TypeConverterAttribute

Implements

IHostPool IResource IResourceModelWithAllowedPropertySet ITrackedResource IJsonSerializable IValidates

Constructors

HostPool()

Creates an new HostPool instance.

Properties

AgentUpdateMaintenanceWindow	List of maintenance windows. Maintenance windows are 2 hours long.
AgentUpdateMaintenanceWindowTimeZone	Time zone for maintenance as defined in https://docs.microsoft.com/en-us/dotnet/api/system.timezoneinfo.findsystemtimezonebyid?view=net-5.0. Must be set if useLocalTime is true.
AgentUpdateType	The type of maintenance for session host components.
AgentUpdateUseSessionHostLocalTime	Whether to use localTime of the virtual machine.
AppAttachPackageReference	List of App Attach Package links.
ApplicationGroupReference	List of applicationGroup links.
CloudPcResource	Is cloud pc resource.
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. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
IdentityPrincipalId	The principal ID of resource identity. The value must be an UUID.
IdentityTenantId	The tenant ID of resource. The value must be an UUID.
IdentityType	The identity type.
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
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
ObjectId	ObjectId of HostPool. (internal use)
PersonalDesktopAssignmentType	PersonalDesktopAssignment type for HostPool.
PlanName	A user defined name of the 3rd Party Artifact that is being procured.
PlanProduct	The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding.
PlanPromotionCode	A publisher provided promotion code as provisioned in Data Market for the said product/artifact.
PlanPublisher	The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic
PlanVersion	The version of the desired product/artifact.
PreferredAppGroupType	The type of preferred application group type, default to Desktop Application Group
PrivateEndpointConnection	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
RegistrationInfoExpirationTime	Expiration time of registration token.
RegistrationInfoRegistrationTokenOperation	The type of resetting the token.
RegistrationInfoToken	The registration token base64 encoded string.
ResourceGroupName	Gets the resource group name
Ring	The ring number of HostPool.
SkuCapacity	If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
SkuFamily	If the service has different generations of hardware, for the same SKU, then that can be captured here.
SkuName	The name of the SKU. E.g. P3. It is typically a letter+number code
SkuSize	The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
SkuTier	This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.
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.
SystemDataCreatedAt	The timestamp of resource creation (UTC).
SystemDataCreatedBy	The identity that created the resource.
SystemDataCreatedByType	The type of identity that created the resource.
SystemDataLastModifiedAt	The timestamp of resource last modification (UTC)
SystemDataLastModifiedBy	The identity that last modified the resource.
SystemDataLastModifiedByType	The type of identity that last modified the resource.
Tag	Resource tags.
Type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
ValidationEnvironment	Is validation environment.
VMTemplate	VM template for sessionhosts configuration within hostpool.

Methods

DeserializeFromDictionary(IDictionary)	Deserializes a IDictionary into an instance of HostPool.
DeserializeFromPSObject(PSObject)	Deserializes a PSObject into an instance of HostPool.
FromJson(JsonNode)	Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.IHostPool.
FromJsonString(String)	Creates a new instance of HostPool, deserializing the content from a json string.
ToJson(JsonObject, SerializationMode)	Serializes this instance of HostPool into a JsonNode.
ToJsonString()	Serializes this instance to a json string.
ToString()
Validate(IEventListener)	Validates that this object meets the validation criteria.