Interface HostPoolProperties
public interface HostPoolProperties
An immutable client-side representation of HostPoolProperties.
-
Method Summary
Modifier and TypeMethodDescriptionGets the applicationGroupReferences property: List of applicationGroup links.Gets the cloudPcResource property: Is cloud pc resource.Gets the customRdpProperty property: Custom rdp property of HostPool.Gets the description property: Description of HostPool.Gets the friendlyName property: Friendly name of HostPool.Gets the hostPoolType property: HostPool type for desktop.Gets the inner com.azure.resourcemanager.desktopvirtualization.fluent.models.HostPoolPropertiesInner object.Gets the loadBalancerType property: The type of the load balancer.Gets the maxSessionLimit property: The max session limit of HostPool.Gets the migrationRequest property: The registration info of HostPool.objectId()
Gets the objectId property: ObjectId of HostPool.Gets the personalDesktopAssignmentType property: PersonalDesktopAssignment type for HostPool.Gets the preferredAppGroupType property: The type of preferred application group type, default to Desktop Application Group.Gets the publicNetworkAccess property: Enabled allows this resource to be accessed from both public and private networks, Disabled allows this resource to only be accessed via private endpoints.Gets the registrationInfo property: The registration info of HostPool.ring()
Gets the ring property: The ring number of HostPool.Gets the ssoadfsAuthority property: URL to customer ADFS server for signing WVD SSO certificates.Gets the ssoClientId property: ClientId for the registered Relying Party used to issue WVD SSO certificates.Gets the ssoClientSecretKeyVaultPath property: Path to Azure KeyVault storing the secret used for communication to ADFS.Gets the ssoSecretType property: The type of single sign on Secret Type.Gets the startVMOnConnect property: The flag to turn on/off StartVMOnConnect feature.Gets the validationEnvironment property: Is validation environment.Gets the vmTemplate property: VM template for sessionhosts configuration within hostpool.
-
Method Details
-
objectId
String objectId()Gets the objectId property: ObjectId of HostPool. (internal use).- Returns:
- the objectId value.
-
friendlyName
String friendlyName()Gets the friendlyName property: Friendly name of HostPool.- Returns:
- the friendlyName value.
-
description
String description()Gets the description property: Description of HostPool.- Returns:
- the description value.
-
hostPoolType
HostPoolType hostPoolType()Gets the hostPoolType property: HostPool type for desktop.- Returns:
- the hostPoolType value.
-
personalDesktopAssignmentType
PersonalDesktopAssignmentType personalDesktopAssignmentType()Gets the personalDesktopAssignmentType property: PersonalDesktopAssignment type for HostPool.- Returns:
- the personalDesktopAssignmentType value.
-
customRdpProperty
String customRdpProperty()Gets the customRdpProperty property: Custom rdp property of HostPool.- Returns:
- the customRdpProperty value.
-
maxSessionLimit
Integer maxSessionLimit()Gets the maxSessionLimit property: The max session limit of HostPool.- Returns:
- the maxSessionLimit value.
-
loadBalancerType
LoadBalancerType loadBalancerType()Gets the loadBalancerType property: The type of the load balancer.- Returns:
- the loadBalancerType value.
-
ring
Integer ring()Gets the ring property: The ring number of HostPool.- Returns:
- the ring value.
-
validationEnvironment
Boolean validationEnvironment()Gets the validationEnvironment property: Is validation environment.- Returns:
- the validationEnvironment value.
-
registrationInfo
RegistrationInfo registrationInfo()Gets the registrationInfo property: The registration info of HostPool.- Returns:
- the registrationInfo value.
-
vmTemplate
String vmTemplate()Gets the vmTemplate property: VM template for sessionhosts configuration within hostpool.- Returns:
- the vmTemplate value.
-
applicationGroupReferences
Gets the applicationGroupReferences property: List of applicationGroup links.- Returns:
- the applicationGroupReferences value.
-
ssoadfsAuthority
String ssoadfsAuthority()Gets the ssoadfsAuthority property: URL to customer ADFS server for signing WVD SSO certificates.- Returns:
- the ssoadfsAuthority value.
-
ssoClientId
String ssoClientId()Gets the ssoClientId property: ClientId for the registered Relying Party used to issue WVD SSO certificates.- Returns:
- the ssoClientId value.
-
ssoClientSecretKeyVaultPath
String ssoClientSecretKeyVaultPath()Gets the ssoClientSecretKeyVaultPath property: Path to Azure KeyVault storing the secret used for communication to ADFS.- Returns:
- the ssoClientSecretKeyVaultPath value.
-
ssoSecretType
SsoSecretType ssoSecretType()Gets the ssoSecretType property: The type of single sign on Secret Type.- Returns:
- the ssoSecretType value.
-
preferredAppGroupType
PreferredAppGroupType preferredAppGroupType()Gets the preferredAppGroupType property: The type of preferred application group type, default to Desktop Application Group.- Returns:
- the preferredAppGroupType value.
-
startVMOnConnect
Boolean startVMOnConnect()Gets the startVMOnConnect property: The flag to turn on/off StartVMOnConnect feature.- Returns:
- the startVMOnConnect value.
-
migrationRequest
MigrationRequestProperties migrationRequest()Gets the migrationRequest property: The registration info of HostPool.- Returns:
- the migrationRequest value.
-
cloudPcResource
Boolean cloudPcResource()Gets the cloudPcResource property: Is cloud pc resource.- Returns:
- the cloudPcResource value.
-
publicNetworkAccess
PublicNetworkAccess publicNetworkAccess()Gets the publicNetworkAccess property: Enabled allows this resource to be accessed from both public and private networks, Disabled allows this resource to only be accessed via private endpoints.- Returns:
- the publicNetworkAccess value.
-
innerModel
HostPoolPropertiesInner innerModel()Gets the inner com.azure.resourcemanager.desktopvirtualization.fluent.models.HostPoolPropertiesInner object.- Returns:
- the inner object.
-