ArmDesktopVirtualizationModelFactory.HostPoolData Method

Definition

Namespace:: Azure.ResourceManager.DesktopVirtualization.Models

Assembly:: Azure.ResourceManager.DesktopVirtualization.dll

Package:: Azure.ResourceManager.DesktopVirtualization v1.4.0-beta.1

Source:: ArmDesktopVirtualizationModelFactory.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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.ResourceManager.DesktopVirtualization.Models.DesktopVirtualizationManagedPrivateUdp? managedPrivateUdp = default, Azure.ResourceManager.DesktopVirtualization.Models.DesktopVirtualizationDirectUdp? directUdp = default, Azure.ResourceManager.DesktopVirtualization.Models.DesktopVirtualizationPublicUdp? publicUdp = default, Azure.ResourceManager.DesktopVirtualization.Models.DesktopVirtualizationRelayUdp? relayUdp = default, Azure.ResourceManager.DesktopVirtualization.Models.DesktopVirtualizationManagementType? managementType = default, Azure.ResourceManager.DesktopVirtualization.Models.DesktopVirtualizationDeploymentScope? deploymentScope = default, string oboTenantId = default, Azure.ResourceManager.DesktopVirtualization.Models.DesktopVirtualizationAllowRdpShortPathWithPrivateLink? allowRdpShortPathWithPrivateLink = default, Azure.ResourceManager.Models.ManagedServiceIdentity identity = default, Azure.ETag? etag = default, string kind = default, Azure.Core.ResourceIdentifier managedBy = default, Azure.ResourceManager.Models.ArmPlan plan = default, Azure.ResourceManager.DesktopVirtualization.Models.DesktopVirtualizationSku sku = 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 * Nullable<Azure.ResourceManager.DesktopVirtualization.Models.HostPoolType> * Nullable<Azure.ResourceManager.DesktopVirtualization.Models.PersonalDesktopAssignmentType> * string * Nullable<int> * Nullable<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> * Nullable<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> * Nullable<Azure.ResourceManager.DesktopVirtualization.Models.DesktopVirtualizationManagedPrivateUdp> * Nullable<Azure.ResourceManager.DesktopVirtualization.Models.DesktopVirtualizationDirectUdp> * Nullable<Azure.ResourceManager.DesktopVirtualization.Models.DesktopVirtualizationPublicUdp> * Nullable<Azure.ResourceManager.DesktopVirtualization.Models.DesktopVirtualizationRelayUdp> * Nullable<Azure.ResourceManager.DesktopVirtualization.Models.DesktopVirtualizationManagementType> * Nullable<Azure.ResourceManager.DesktopVirtualization.Models.DesktopVirtualizationDeploymentScope> * string * Nullable<Azure.ResourceManager.DesktopVirtualization.Models.DesktopVirtualizationAllowRdpShortPathWithPrivateLink> * Azure.ResourceManager.Models.ManagedServiceIdentity * Nullable<Azure.ETag> * string * Azure.Core.ResourceIdentifier * Azure.ResourceManager.Models.ArmPlan * Azure.ResourceManager.DesktopVirtualization.Models.DesktopVirtualizationSku -> 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 Nullable(Of HostPoolType) = Nothing, Optional personalDesktopAssignmentType As Nullable(Of PersonalDesktopAssignmentType) = Nothing, Optional customRdpProperty As String = Nothing, Optional maxSessionLimit As Nullable(Of Integer) = Nothing, Optional loadBalancerType As Nullable(Of 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 Nullable(Of 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 managedPrivateUdp As Nullable(Of DesktopVirtualizationManagedPrivateUdp) = Nothing, Optional directUdp As Nullable(Of DesktopVirtualizationDirectUdp) = Nothing, Optional publicUdp As Nullable(Of DesktopVirtualizationPublicUdp) = Nothing, Optional relayUdp As Nullable(Of DesktopVirtualizationRelayUdp) = Nothing, Optional managementType As Nullable(Of DesktopVirtualizationManagementType) = Nothing, Optional deploymentScope As Nullable(Of DesktopVirtualizationDeploymentScope) = Nothing, Optional oboTenantId As String = Nothing, Optional allowRdpShortPathWithPrivateLink As Nullable(Of DesktopVirtualizationAllowRdpShortPathWithPrivateLink) = Nothing, Optional identity As ManagedServiceIdentity = Nothing, Optional etag As Nullable(Of ETag) = Nothing, Optional kind As String = Nothing, Optional managedBy As ResourceIdentifier = Nothing, Optional plan As ArmPlan = Nothing, Optional sku As DesktopVirtualizationSku = Nothing) As HostPoolData

Parameters

id: ResourceIdentifier

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

name: String

The name of the resource.

resourceType: ResourceType

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

systemData: SystemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

tags: IDictionary<String,String>

Resource tags.

location: AzureLocation

The geo-location where the resource lives.

objectId: String

ObjectId of HostPool. (internal use).

friendlyName: String

Friendly name of HostPool.

description: String

Description of HostPool.

hostPoolType: Nullable<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: Nullable<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: Nullable<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.

managedPrivateUdp: Nullable<DesktopVirtualizationManagedPrivateUdp>

Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections.

directUdp: Nullable<DesktopVirtualizationDirectUdp>

publicUdp: Nullable<DesktopVirtualizationPublicUdp>

relayUdp: Nullable<DesktopVirtualizationRelayUdp>

managementType: Nullable<DesktopVirtualizationManagementType>

The type of management for this hostpool, Automated or Standard. The default value is Automated.

deploymentScope: Nullable<DesktopVirtualizationDeploymentScope>

DeploymentScope type for HostPool.

oboTenantId: String

Tenant that the resource is being requested on behalf of.

allowRdpShortPathWithPrivateLink: Nullable<DesktopVirtualizationAllowRdpShortPathWithPrivateLink>

Controls if the use of RDPShortPath transport is allowed, possibly bypassing Private Link routes.

identity: ManagedServiceIdentity

The managed service identities assigned to this resource.

etag: Nullable<ETag>

If etag is provided in the response body, it may 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.

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.

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.