Class HostPoolPropertiesInner
java.lang.Object
com.azure.resourcemanager.desktopvirtualization.fluent.models.HostPoolPropertiesInner
Properties of HostPool.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGet the applicationGroupReferences property: List of applicationGroup links.Get the cloudPcResource property: Is cloud pc resource.Get the customRdpProperty property: Custom rdp property of HostPool.Get the description property: Description of HostPool.Get the friendlyName property: Friendly name of HostPool.Get the hostPoolType property: HostPool type for desktop.Get the loadBalancerType property: The type of the load balancer.Get the maxSessionLimit property: The max session limit of HostPool.Get the migrationRequest property: The registration info of HostPool.objectId()
Get the objectId property: ObjectId of HostPool.Get the personalDesktopAssignmentType property: PersonalDesktopAssignment type for HostPool.Get the preferredAppGroupType property: The type of preferred application group type, default to Desktop Application Group.Get 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.Get the registrationInfo property: The registration info of HostPool.ring()
Get the ring property: The ring number of HostPool.Get the ssoadfsAuthority property: URL to customer ADFS server for signing WVD SSO certificates.Get the ssoClientId property: ClientId for the registered Relying Party used to issue WVD SSO certificates.Get the ssoClientSecretKeyVaultPath property: Path to Azure KeyVault storing the secret used for communication to ADFS.Get the ssoSecretType property: The type of single sign on Secret Type.Get the startVMOnConnect property: The flag to turn on/off StartVMOnConnect feature.void
validate()
Validates the instance.Get the validationEnvironment property: Is validation environment.Get the vmTemplate property: VM template for sessionhosts configuration within hostpool.withCustomRdpProperty
(String customRdpProperty) Set the customRdpProperty property: Custom rdp property of HostPool.withDescription
(String description) Set the description property: Description of HostPool.withFriendlyName
(String friendlyName) Set the friendlyName property: Friendly name of HostPool.withHostPoolType
(HostPoolType hostPoolType) Set the hostPoolType property: HostPool type for desktop.withLoadBalancerType
(LoadBalancerType loadBalancerType) Set the loadBalancerType property: The type of the load balancer.withMaxSessionLimit
(Integer maxSessionLimit) Set the maxSessionLimit property: The max session limit of HostPool.withMigrationRequest
(MigrationRequestProperties migrationRequest) Set the migrationRequest property: The registration info of HostPool.withPersonalDesktopAssignmentType
(PersonalDesktopAssignmentType personalDesktopAssignmentType) Set the personalDesktopAssignmentType property: PersonalDesktopAssignment type for HostPool.withPreferredAppGroupType
(PreferredAppGroupType preferredAppGroupType) Set the preferredAppGroupType property: The type of preferred application group type, default to Desktop Application Group.withPublicNetworkAccess
(PublicNetworkAccess publicNetworkAccess) Set 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.withRegistrationInfo
(RegistrationInfoInner registrationInfo) Set the registrationInfo property: The registration info of HostPool.Set the ring property: The ring number of HostPool.withSsoadfsAuthority
(String ssoadfsAuthority) Set the ssoadfsAuthority property: URL to customer ADFS server for signing WVD SSO certificates.withSsoClientId
(String ssoClientId) Set the ssoClientId property: ClientId for the registered Relying Party used to issue WVD SSO certificates.withSsoClientSecretKeyVaultPath
(String ssoClientSecretKeyVaultPath) Set the ssoClientSecretKeyVaultPath property: Path to Azure KeyVault storing the secret used for communication to ADFS.withSsoSecretType
(SsoSecretType ssoSecretType) Set the ssoSecretType property: The type of single sign on Secret Type.withStartVMOnConnect
(Boolean startVMOnConnect) Set the startVMOnConnect property: The flag to turn on/off StartVMOnConnect feature.withValidationEnvironment
(Boolean validationEnvironment) Set the validationEnvironment property: Is validation environment.withVmTemplate
(String vmTemplate) Set the vmTemplate property: VM template for sessionhosts configuration within hostpool.
-
Constructor Details
-
HostPoolPropertiesInner
public HostPoolPropertiesInner()
-
-
Method Details
-
objectId
Get the objectId property: ObjectId of HostPool. (internal use).- Returns:
- the objectId value.
-
friendlyName
Get the friendlyName property: Friendly name of HostPool.- Returns:
- the friendlyName value.
-
withFriendlyName
Set the friendlyName property: Friendly name of HostPool.- Parameters:
friendlyName
- the friendlyName value to set.- Returns:
- the HostPoolPropertiesInner object itself.
-
description
Get the description property: Description of HostPool.- Returns:
- the description value.
-
withDescription
Set the description property: Description of HostPool.- Parameters:
description
- the description value to set.- Returns:
- the HostPoolPropertiesInner object itself.
-
hostPoolType
Get the hostPoolType property: HostPool type for desktop.- Returns:
- the hostPoolType value.
-
withHostPoolType
Set the hostPoolType property: HostPool type for desktop.- Parameters:
hostPoolType
- the hostPoolType value to set.- Returns:
- the HostPoolPropertiesInner object itself.
-
personalDesktopAssignmentType
Get the personalDesktopAssignmentType property: PersonalDesktopAssignment type for HostPool.- Returns:
- the personalDesktopAssignmentType value.
-
withPersonalDesktopAssignmentType
public HostPoolPropertiesInner withPersonalDesktopAssignmentType(PersonalDesktopAssignmentType personalDesktopAssignmentType) Set the personalDesktopAssignmentType property: PersonalDesktopAssignment type for HostPool.- Parameters:
personalDesktopAssignmentType
- the personalDesktopAssignmentType value to set.- Returns:
- the HostPoolPropertiesInner object itself.
-
customRdpProperty
Get the customRdpProperty property: Custom rdp property of HostPool.- Returns:
- the customRdpProperty value.
-
withCustomRdpProperty
Set the customRdpProperty property: Custom rdp property of HostPool.- Parameters:
customRdpProperty
- the customRdpProperty value to set.- Returns:
- the HostPoolPropertiesInner object itself.
-
maxSessionLimit
Get the maxSessionLimit property: The max session limit of HostPool.- Returns:
- the maxSessionLimit value.
-
withMaxSessionLimit
Set the maxSessionLimit property: The max session limit of HostPool.- Parameters:
maxSessionLimit
- the maxSessionLimit value to set.- Returns:
- the HostPoolPropertiesInner object itself.
-
loadBalancerType
Get the loadBalancerType property: The type of the load balancer.- Returns:
- the loadBalancerType value.
-
withLoadBalancerType
Set the loadBalancerType property: The type of the load balancer.- Parameters:
loadBalancerType
- the loadBalancerType value to set.- Returns:
- the HostPoolPropertiesInner object itself.
-
ring
Get the ring property: The ring number of HostPool.- Returns:
- the ring value.
-
withRing
Set the ring property: The ring number of HostPool.- Parameters:
ring
- the ring value to set.- Returns:
- the HostPoolPropertiesInner object itself.
-
validationEnvironment
Get the validationEnvironment property: Is validation environment.- Returns:
- the validationEnvironment value.
-
withValidationEnvironment
Set the validationEnvironment property: Is validation environment.- Parameters:
validationEnvironment
- the validationEnvironment value to set.- Returns:
- the HostPoolPropertiesInner object itself.
-
registrationInfo
Get the registrationInfo property: The registration info of HostPool.- Returns:
- the registrationInfo value.
-
withRegistrationInfo
Set the registrationInfo property: The registration info of HostPool.- Parameters:
registrationInfo
- the registrationInfo value to set.- Returns:
- the HostPoolPropertiesInner object itself.
-
vmTemplate
Get the vmTemplate property: VM template for sessionhosts configuration within hostpool.- Returns:
- the vmTemplate value.
-
withVmTemplate
Set the vmTemplate property: VM template for sessionhosts configuration within hostpool.- Parameters:
vmTemplate
- the vmTemplate value to set.- Returns:
- the HostPoolPropertiesInner object itself.
-
applicationGroupReferences
Get the applicationGroupReferences property: List of applicationGroup links.- Returns:
- the applicationGroupReferences value.
-
ssoadfsAuthority
Get the ssoadfsAuthority property: URL to customer ADFS server for signing WVD SSO certificates.- Returns:
- the ssoadfsAuthority value.
-
withSsoadfsAuthority
Set the ssoadfsAuthority property: URL to customer ADFS server for signing WVD SSO certificates.- Parameters:
ssoadfsAuthority
- the ssoadfsAuthority value to set.- Returns:
- the HostPoolPropertiesInner object itself.
-
ssoClientId
Get the ssoClientId property: ClientId for the registered Relying Party used to issue WVD SSO certificates.- Returns:
- the ssoClientId value.
-
withSsoClientId
Set the ssoClientId property: ClientId for the registered Relying Party used to issue WVD SSO certificates.- Parameters:
ssoClientId
- the ssoClientId value to set.- Returns:
- the HostPoolPropertiesInner object itself.
-
ssoClientSecretKeyVaultPath
Get the ssoClientSecretKeyVaultPath property: Path to Azure KeyVault storing the secret used for communication to ADFS.- Returns:
- the ssoClientSecretKeyVaultPath value.
-
withSsoClientSecretKeyVaultPath
Set the ssoClientSecretKeyVaultPath property: Path to Azure KeyVault storing the secret used for communication to ADFS.- Parameters:
ssoClientSecretKeyVaultPath
- the ssoClientSecretKeyVaultPath value to set.- Returns:
- the HostPoolPropertiesInner object itself.
-
ssoSecretType
Get the ssoSecretType property: The type of single sign on Secret Type.- Returns:
- the ssoSecretType value.
-
withSsoSecretType
Set the ssoSecretType property: The type of single sign on Secret Type.- Parameters:
ssoSecretType
- the ssoSecretType value to set.- Returns:
- the HostPoolPropertiesInner object itself.
-
preferredAppGroupType
Get the preferredAppGroupType property: The type of preferred application group type, default to Desktop Application Group.- Returns:
- the preferredAppGroupType value.
-
withPreferredAppGroupType
public HostPoolPropertiesInner withPreferredAppGroupType(PreferredAppGroupType preferredAppGroupType) Set the preferredAppGroupType property: The type of preferred application group type, default to Desktop Application Group.- Parameters:
preferredAppGroupType
- the preferredAppGroupType value to set.- Returns:
- the HostPoolPropertiesInner object itself.
-
startVMOnConnect
Get the startVMOnConnect property: The flag to turn on/off StartVMOnConnect feature.- Returns:
- the startVMOnConnect value.
-
withStartVMOnConnect
Set the startVMOnConnect property: The flag to turn on/off StartVMOnConnect feature.- Parameters:
startVMOnConnect
- the startVMOnConnect value to set.- Returns:
- the HostPoolPropertiesInner object itself.
-
migrationRequest
Get the migrationRequest property: The registration info of HostPool.- Returns:
- the migrationRequest value.
-
withMigrationRequest
Set the migrationRequest property: The registration info of HostPool.- Parameters:
migrationRequest
- the migrationRequest value to set.- Returns:
- the HostPoolPropertiesInner object itself.
-
cloudPcResource
Get the cloudPcResource property: Is cloud pc resource.- Returns:
- the cloudPcResource value.
-
publicNetworkAccess
Get 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.
-
withPublicNetworkAccess
Set 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.- Parameters:
publicNetworkAccess
- the publicNetworkAccess value to set.- Returns:
- the HostPoolPropertiesInner object itself.
-
validate
public void validate()Validates the instance.- Throws:
IllegalArgumentException
- thrown if the instance is not valid.
-