Delen via


IHostPool Interface

Definition

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api20230905.HostPoolTypeConverter))]
public interface IHostPool : Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api10.IResourceModelWithAllowedPropertySet
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api20230905.HostPoolTypeConverter))>]
type IHostPool = interface
    interface IJsonSerializable
    interface IResourceModelWithAllowedPropertySet
Public Interface IHostPool
Implements IResourceModelWithAllowedPropertySet
Derived
Attributes
Implements

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.

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.

(Inherited from IResourceModelWithAllowedPropertySet)
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 IResourceModelWithAllowedPropertySet)
IdentityPrincipalId

The principal ID of resource identity.

(Inherited from IResourceModelWithAllowedPropertySet)
IdentityTenantId

The tenant ID of resource.

(Inherited from IResourceModelWithAllowedPropertySet)
IdentityType

The identity type.

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

(Inherited from IResourceModelWithAllowedPropertySet)
LoadBalancerType

The type of the load balancer.

Location

The geo-location where the resource lives

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

(Inherited from IResourceModelWithAllowedPropertySet)
MaxSessionLimit

The max session limit of HostPool.

Name

The name of the resource

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

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

(Inherited from IResourceModelWithAllowedPropertySet)
PlanPromotionCode

A publisher provided promotion code as provisioned in Data Market for the said product/artifact.

(Inherited from IResourceModelWithAllowedPropertySet)
PlanPublisher

The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic

(Inherited from IResourceModelWithAllowedPropertySet)
PlanVersion

The version of the desired product/artifact.

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

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.

(Inherited from IResourceModelWithAllowedPropertySet)
SkuFamily

If the service has different generations of hardware, for the same SKU, then that can be captured here.

(Inherited from IResourceModelWithAllowedPropertySet)
SkuName

The name of the SKU. Ex - P3. It is typically a letter+number code

(Inherited from IResourceModelWithAllowedPropertySet)
SkuSize

The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.

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

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

(Inherited from IResourceModelWithAllowedPropertySet)
Type

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

(Inherited from IResourceModelWithAllowedPropertySet)
ValidationEnvironment

Is validation environment.

VMTemplate

VM template for sessionhosts configuration within hostpool.

Methods

ToJson(JsonObject, SerializationMode) (Inherited from IJsonSerializable)

Applies to