Share via


HostPoolPatch Class

Definition

HostPool properties that can be patched.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.HostPoolPatchTypeConverter))]
public class HostPoolPatch : Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.IHostPoolPatch, Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Runtime.IValidates
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.HostPoolPatchTypeConverter))>]
type HostPoolPatch = class
    interface IHostPoolPatch
    interface IJsonSerializable
    interface IResource
    interface IValidates
Public Class HostPoolPatch
Implements IHostPoolPatch, IValidates
Inheritance
HostPoolPatch
Attributes
Implements

Constructors

HostPoolPatch()

Creates an new HostPoolPatch 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.

CustomRdpProperty

Custom rdp property of HostPool.

Description

Description of HostPool.

FriendlyName

Friendly name of HostPool.

Id

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

LoadBalancerType

The type of the load balancer.

MaxSessionLimit

The max session limit of HostPool.

Name

The name of the resource

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

RegistrationInfoExpirationTime

Expiration time of registration token.

RegistrationInfoRegistrationTokenOperation

The type of resetting the token.

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.

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

tags to be updated

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

DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of HostPoolPatch.

FromJson(JsonNode)

Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.IHostPoolPatch.

FromJsonString(String)

Creates a new instance of HostPoolPatch, deserializing the content from a json string.

ToJson(JsonObject, SerializationMode)

Serializes this instance of HostPoolPatch into a JsonNode.

ToJsonString()

Serializes this instance to a json string.

ToString()
Validate(IEventListener)

Validates that this object meets the validation criteria.

Applies to