HostPoolProperties Class

Definition

Namespace:

Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models

Assembly:

Az.DesktopVirtualization.private.dll

Properties of HostPool.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.HostPoolPropertiesTypeConverter))]
public class HostPoolProperties : Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.IHostPoolProperties

[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.HostPoolPropertiesTypeConverter))>]
type HostPoolProperties = class
    interface IHostPoolProperties
    interface IJsonSerializable

Public Class HostPoolProperties
Implements IHostPoolProperties

Inheritance

Object

HostPoolProperties

Attributes

TypeConverterAttribute

Implements

IHostPoolProperties IJsonSerializable

Constructors

HostPoolProperties()

Creates an new HostPoolProperties 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.
FriendlyName	Friendly name of HostPool.
HostPoolType	HostPool type for desktop.
LoadBalancerType	The type of the load balancer.
MaxSessionLimit	The max session limit of HostPool.
ObjectId	ObjectId of HostPool. (internal use)
PersonalDesktopAssignmentType	PersonalDesktopAssignment type for HostPool.
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.
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.
ValidationEnvironment	Is validation environment.
VMTemplate	VM template for sessionhosts configuration within hostpool.

Methods

DeserializeFromDictionary(IDictionary)	Deserializes a IDictionary into an instance of HostPoolProperties.
DeserializeFromPSObject(PSObject)	Deserializes a PSObject into an instance of HostPoolProperties.
FromJson(JsonNode)	Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.IHostPoolProperties.
FromJsonString(String)	Creates a new instance of HostPoolProperties, deserializing the content from a json string.
ToJson(JsonObject, SerializationMode)	Serializes this instance of HostPoolProperties into a JsonNode.
ToJsonString()	Serializes this instance to a json string.
ToString()