ArmDesktopVirtualizationModelFactory.HostPoolData Method

Definition

Initializes a new instance of HostPoolData.

public static Azure.ResourceManager.DesktopVirtualization.HostPoolData HostPoolData (Azure.Core.ResourceIdentifier id = default, string name = default, Azure.Core.ResourceType resourceType = default, Azure.ResourceManager.Models.SystemData systemData = default, System.Collections.Generic.IDictionary<string,string> tags = default, Azure.Core.AzureLocation location = default, string objectId = default, string friendlyName = default, string description = default, Azure.ResourceManager.DesktopVirtualization.Models.HostPoolType hostPoolType = default, Azure.ResourceManager.DesktopVirtualization.Models.PersonalDesktopAssignmentType? personalDesktopAssignmentType = default, string customRdpProperty = default, int? maxSessionLimit = default, Azure.ResourceManager.DesktopVirtualization.Models.HostPoolLoadBalancerType loadBalancerType = default, int? ring = default, bool? isValidationEnvironment = default, Azure.ResourceManager.DesktopVirtualization.Models.HostPoolRegistrationInfo registrationInfo = default, string vmTemplate = default, System.Collections.Generic.IEnumerable<string> applicationGroupReferences = default, System.Collections.Generic.IEnumerable<string> appAttachPackageReferences = default, string ssoAdfsAuthority = default, string ssoClientId = default, string ssoClientSecretKeyVaultPath = default, Azure.ResourceManager.DesktopVirtualization.Models.HostPoolSsoSecretType? ssoSecretType = default, Azure.ResourceManager.DesktopVirtualization.Models.PreferredAppGroupType preferredAppGroupType = default, bool? startVmOnConnect = default, bool? isCloudPCResource = default, Azure.ResourceManager.DesktopVirtualization.Models.HostPoolPublicNetworkAccess? publicNetworkAccess = default, Azure.ResourceManager.DesktopVirtualization.Models.SessionHostAgentUpdateProperties agentUpdate = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.DesktopVirtualization.Models.DesktopVirtualizationPrivateEndpointConnection> privateEndpointConnections = default, Azure.Core.ResourceIdentifier managedBy = default, string kind = default, Azure.ETag? etag = default, Azure.ResourceManager.Models.ManagedServiceIdentity identity = default, Azure.ResourceManager.DesktopVirtualization.Models.DesktopVirtualizationSku sku = default, Azure.ResourceManager.Models.ArmPlan plan = default);
static member HostPoolData : Azure.Core.ResourceIdentifier * string * Azure.Core.ResourceType * Azure.ResourceManager.Models.SystemData * System.Collections.Generic.IDictionary<string, string> * Azure.Core.AzureLocation * string * string * string * Azure.ResourceManager.DesktopVirtualization.Models.HostPoolType * Nullable<Azure.ResourceManager.DesktopVirtualization.Models.PersonalDesktopAssignmentType> * string * Nullable<int> * Azure.ResourceManager.DesktopVirtualization.Models.HostPoolLoadBalancerType * Nullable<int> * Nullable<bool> * Azure.ResourceManager.DesktopVirtualization.Models.HostPoolRegistrationInfo * string * seq<string> * seq<string> * string * string * string * Nullable<Azure.ResourceManager.DesktopVirtualization.Models.HostPoolSsoSecretType> * Azure.ResourceManager.DesktopVirtualization.Models.PreferredAppGroupType * Nullable<bool> * Nullable<bool> * Nullable<Azure.ResourceManager.DesktopVirtualization.Models.HostPoolPublicNetworkAccess> * Azure.ResourceManager.DesktopVirtualization.Models.SessionHostAgentUpdateProperties * seq<Azure.ResourceManager.DesktopVirtualization.Models.DesktopVirtualizationPrivateEndpointConnection> * Azure.Core.ResourceIdentifier * string * Nullable<Azure.ETag> * Azure.ResourceManager.Models.ManagedServiceIdentity * Azure.ResourceManager.DesktopVirtualization.Models.DesktopVirtualizationSku * Azure.ResourceManager.Models.ArmPlan -> Azure.ResourceManager.DesktopVirtualization.HostPoolData
Public Shared Function HostPoolData (Optional id As ResourceIdentifier = Nothing, Optional name As String = Nothing, Optional resourceType As ResourceType = Nothing, Optional systemData As SystemData = Nothing, Optional tags As IDictionary(Of String, String) = Nothing, Optional location As AzureLocation = Nothing, Optional objectId As String = Nothing, Optional friendlyName As String = Nothing, Optional description As String = Nothing, Optional hostPoolType As HostPoolType = Nothing, Optional personalDesktopAssignmentType As Nullable(Of PersonalDesktopAssignmentType) = Nothing, Optional customRdpProperty As String = Nothing, Optional maxSessionLimit As Nullable(Of Integer) = Nothing, Optional loadBalancerType As HostPoolLoadBalancerType = Nothing, Optional ring As Nullable(Of Integer) = Nothing, Optional isValidationEnvironment As Nullable(Of Boolean) = Nothing, Optional registrationInfo As HostPoolRegistrationInfo = Nothing, Optional vmTemplate As String = Nothing, Optional applicationGroupReferences As IEnumerable(Of String) = Nothing, Optional appAttachPackageReferences As IEnumerable(Of String) = Nothing, Optional ssoAdfsAuthority As String = Nothing, Optional ssoClientId As String = Nothing, Optional ssoClientSecretKeyVaultPath As String = Nothing, Optional ssoSecretType As Nullable(Of HostPoolSsoSecretType) = Nothing, Optional preferredAppGroupType As PreferredAppGroupType = Nothing, Optional startVmOnConnect As Nullable(Of Boolean) = Nothing, Optional isCloudPCResource As Nullable(Of Boolean) = Nothing, Optional publicNetworkAccess As Nullable(Of HostPoolPublicNetworkAccess) = Nothing, Optional agentUpdate As SessionHostAgentUpdateProperties = Nothing, Optional privateEndpointConnections As IEnumerable(Of DesktopVirtualizationPrivateEndpointConnection) = Nothing, Optional managedBy As ResourceIdentifier = Nothing, Optional kind As String = Nothing, Optional etag As Nullable(Of ETag) = Nothing, Optional identity As ManagedServiceIdentity = Nothing, Optional sku As DesktopVirtualizationSku = Nothing, Optional plan As ArmPlan = Nothing) As HostPoolData

Parameters

id
ResourceIdentifier

The id.

name
String

The name.

resourceType
ResourceType

The resourceType.

systemData
SystemData

The systemData.

tags
IDictionary<String,String>

The tags.

location
AzureLocation

The location.

objectId
String

ObjectId of HostPool. (internal use).

friendlyName
String

Friendly name of HostPool.

description
String

Description of HostPool.

hostPoolType
HostPoolType

HostPool type for desktop.

personalDesktopAssignmentType
Nullable<PersonalDesktopAssignmentType>

PersonalDesktopAssignment type for HostPool.

customRdpProperty
String

Custom rdp property of HostPool.

maxSessionLimit
Nullable<Int32>

The max session limit of HostPool.

loadBalancerType
HostPoolLoadBalancerType

The type of the load balancer.

ring
Nullable<Int32>

The ring number of HostPool.

isValidationEnvironment
Nullable<Boolean>

Is validation environment.

registrationInfo
HostPoolRegistrationInfo

The registration info of HostPool.

vmTemplate
String

VM template for sessionhosts configuration within hostpool.

applicationGroupReferences
IEnumerable<String>

List of applicationGroup links.

appAttachPackageReferences
IEnumerable<String>

List of App Attach Package links.

ssoAdfsAuthority
String

URL to customer ADFS server for signing WVD SSO certificates.

ssoClientId
String

ClientId for the registered Relying Party used to issue WVD SSO certificates.

ssoClientSecretKeyVaultPath
String

Path to Azure KeyVault storing the secret used for communication to ADFS.

ssoSecretType
Nullable<HostPoolSsoSecretType>

The type of single sign on Secret Type.

preferredAppGroupType
PreferredAppGroupType

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

startVmOnConnect
Nullable<Boolean>

The flag to turn on/off StartVMOnConnect feature.

isCloudPCResource
Nullable<Boolean>

Is cloud pc resource.

publicNetworkAccess
Nullable<HostPoolPublicNetworkAccess>

Enabled allows this resource to be accessed from both public and private networks, Disabled allows this resource to only be accessed via private endpoints.

agentUpdate
SessionHostAgentUpdateProperties

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

privateEndpointConnections
IEnumerable<DesktopVirtualizationPrivateEndpointConnection>

List of private endpoint connection associated with the specified resource.

managedBy
ResourceIdentifier

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.

kind
String

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.

etag
Nullable<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.

identity
ManagedServiceIdentity

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

sku
DesktopVirtualizationSku

The resource model definition representing SKU.

plan
ArmPlan

Gets or sets the plan.

Returns

A new HostPoolData instance for mocking.

Applies to