Class HostPoolPatch
java.lang.Object
com.azure.core.management.ProxyResource
com.azure.resourcemanager.desktopvirtualization.models.HostPoolPatch
public final class HostPoolPatch
extends com.azure.core.management.ProxyResource
HostPool properties that can be patched.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGet 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 loadBalancerType property: The type of the load balancer.Get the maxSessionLimit property: The max session limit 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 to allow this resource to be access from the public network.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.tags()
Get the tags property: tags to be updated.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.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.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 to allow this resource to be access from the public network.withRegistrationInfo
(RegistrationInfoPatch 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.Set the tags property: tags to be updated.withValidationEnvironment
(Boolean validationEnvironment) Set the validationEnvironment property: Is validation environment.withVmTemplate
(String vmTemplate) Set the vmTemplate property: VM template for sessionhosts configuration within hostpool.Methods inherited from class com.azure.core.management.ProxyResource
id, name, type
-
Constructor Details
-
HostPoolPatch
public HostPoolPatch()
-
-
Method Details
-
tags
Get the tags property: tags to be updated.- Returns:
- the tags value.
-
withTags
Set the tags property: tags to be updated.- Parameters:
tags
- the tags value to set.- Returns:
- the HostPoolPatch object itself.
-
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 HostPoolPatch 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 HostPoolPatch 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 HostPoolPatch 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 HostPoolPatch object itself.
-
personalDesktopAssignmentType
Get the personalDesktopAssignmentType property: PersonalDesktopAssignment type for HostPool.- Returns:
- the personalDesktopAssignmentType value.
-
withPersonalDesktopAssignmentType
public HostPoolPatch withPersonalDesktopAssignmentType(PersonalDesktopAssignmentType personalDesktopAssignmentType) Set the personalDesktopAssignmentType property: PersonalDesktopAssignment type for HostPool.- Parameters:
personalDesktopAssignmentType
- the personalDesktopAssignmentType value to set.- Returns:
- the HostPoolPatch 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 HostPoolPatch 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 HostPoolPatch 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 HostPoolPatch 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 HostPoolPatch 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 HostPoolPatch object itself.
-
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 HostPoolPatch 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 HostPoolPatch 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 HostPoolPatch 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 HostPoolPatch object itself.
-
preferredAppGroupType
Get the preferredAppGroupType property: The type of preferred application group type, default to Desktop Application Group.- Returns:
- the preferredAppGroupType value.
-
withPreferredAppGroupType
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 HostPoolPatch 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 HostPoolPatch object itself.
-
publicNetworkAccess
Get the publicNetworkAccess property: Enabled to allow this resource to be access from the public network.- Returns:
- the publicNetworkAccess value.
-
withPublicNetworkAccess
Set the publicNetworkAccess property: Enabled to allow this resource to be access from the public network.- Parameters:
publicNetworkAccess
- the publicNetworkAccess value to set.- Returns:
- the HostPoolPatch object itself.
-
validate
public void validate()Validates the instance.- Throws:
IllegalArgumentException
- thrown if the instance is not valid.
-