HostPoolPatchProperties Class

Package:

com.azure.resourcemanager.desktopvirtualization.fluent.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-desktopvirtualization:1.2.0

• java.lang.Object
• • com.azure.resourcemanager.desktopvirtualization.fluent.models.HostPoolPatchProperties

Implements

JsonSerializable<HostPoolPatchProperties>

public final class HostPoolPatchProperties
implements JsonSerializable<HostPoolPatchProperties>

Properties of HostPool.

Constructor Summary

Constructor	Description
HostPoolPatchProperties()	Creates an instance of HostPoolPatchProperties class.

Method Summary

Modifier and Type	Method and Description
AgentUpdatePatchProperties	agentUpdate() Get the agentUpdate property: The session host configuration for updating agent, monitoring agent, and stack component.
String	customRdpProperty() Get the customRdpProperty property: Custom rdp property of HostPool.
String	description() Get the description property: Description of HostPool.
String	friendlyName() Get the friendlyName property: Friendly name of HostPool.
static HostPoolPatchProperties	fromJson(JsonReader jsonReader) Reads an instance of HostPoolPatchProperties from the JsonReader.
LoadBalancerType	loadBalancerType() Get the loadBalancerType property: The type of the load balancer.
Integer	maxSessionLimit() Get the maxSessionLimit property: The max session limit of HostPool.
PersonalDesktopAssignmentType	personalDesktopAssignmentType() Get the personalDesktopAssignmentType property: PersonalDesktopAssignment type for HostPool.
PreferredAppGroupType	preferredAppGroupType() Get the preferredAppGroupType property: The type of preferred application group type, default to Desktop Application Group.
HostpoolPublicNetworkAccess	publicNetworkAccess() Get the publicNetworkAccess property: Enabled to allow this resource to be access from the public network.
RegistrationInfoPatch	registrationInfo() Get the registrationInfo property: The registration info of HostPool.
Integer	ring() Get the ring property: The ring number of HostPool.
String	ssoadfsAuthority() Get the ssoadfsAuthority property: URL to customer ADFS server for signing WVD SSO certificates.
String	ssoClientId() Get the ssoClientId property: ClientId for the registered Relying Party used to issue WVD SSO certificates.
String	ssoClientSecretKeyVaultPath() Get the ssoClientSecretKeyVaultPath property: Path to Azure KeyVault storing the secret used for communication to ADFS.
SsoSecretType	ssoSecretType() Get the ssoSecretType property: The type of single sign on Secret Type.
Boolean	startVMOnConnect() Get the startVMOnConnect property: The flag to turn on/off StartVMOnConnect feature.
JsonWriter	toJson(JsonWriter jsonWriter)
void	validate() Validates the instance.
Boolean	validationEnvironment() Get the validationEnvironment property: Is validation environment.
String	vmTemplate() Get the vmTemplate property: VM template for sessionhosts configuration within hostpool.
HostPoolPatchProperties	withAgentUpdate(AgentUpdatePatchProperties agentUpdate) Set the agentUpdate property: The session host configuration for updating agent, monitoring agent, and stack component.
HostPoolPatchProperties	withCustomRdpProperty(String customRdpProperty) Set the customRdpProperty property: Custom rdp property of HostPool.
HostPoolPatchProperties	withDescription(String description) Set the description property: Description of HostPool.
HostPoolPatchProperties	withFriendlyName(String friendlyName) Set the friendlyName property: Friendly name of HostPool.
HostPoolPatchProperties	withLoadBalancerType(LoadBalancerType loadBalancerType) Set the loadBalancerType property: The type of the load balancer.
HostPoolPatchProperties	withMaxSessionLimit(Integer maxSessionLimit) Set the maxSessionLimit property: The max session limit of HostPool.
HostPoolPatchProperties	withPersonalDesktopAssignmentType(PersonalDesktopAssignmentType personalDesktopAssignmentType) Set the personalDesktopAssignmentType property: PersonalDesktopAssignment type for HostPool.
HostPoolPatchProperties	withPreferredAppGroupType(PreferredAppGroupType preferredAppGroupType) Set the preferredAppGroupType property: The type of preferred application group type, default to Desktop Application Group.
HostPoolPatchProperties	withPublicNetworkAccess(HostpoolPublicNetworkAccess publicNetworkAccess) Set the publicNetworkAccess property: Enabled to allow this resource to be access from the public network.
HostPoolPatchProperties	withRegistrationInfo(RegistrationInfoPatch registrationInfo) Set the registrationInfo property: The registration info of HostPool.
HostPoolPatchProperties	withRing(Integer ring) Set the ring property: The ring number of HostPool.
HostPoolPatchProperties	withSsoadfsAuthority(String ssoadfsAuthority) Set the ssoadfsAuthority property: URL to customer ADFS server for signing WVD SSO certificates.
HostPoolPatchProperties	withSsoClientId(String ssoClientId) Set the ssoClientId property: ClientId for the registered Relying Party used to issue WVD SSO certificates.
HostPoolPatchProperties	withSsoClientSecretKeyVaultPath(String ssoClientSecretKeyVaultPath) Set the ssoClientSecretKeyVaultPath property: Path to Azure KeyVault storing the secret used for communication to ADFS.
HostPoolPatchProperties	withSsoSecretType(SsoSecretType ssoSecretType) Set the ssoSecretType property: The type of single sign on Secret Type.
HostPoolPatchProperties	withStartVMOnConnect(Boolean startVMOnConnect) Set the startVMOnConnect property: The flag to turn on/off StartVMOnConnect feature.
HostPoolPatchProperties	withValidationEnvironment(Boolean validationEnvironment) Set the validationEnvironment property: Is validation environment.
HostPoolPatchProperties	withVmTemplate(String vmTemplate) Set the vmTemplate property: VM template for sessionhosts configuration within hostpool.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

HostPoolPatchProperties

public HostPoolPatchProperties()

Creates an instance of HostPoolPatchProperties class.

Method Details

agentUpdate

public AgentUpdatePatchProperties agentUpdate()

Get the agentUpdate property: The session host configuration for updating agent, monitoring agent, and stack component.

Returns:

the agentUpdate value.

customRdpProperty

public String customRdpProperty()

Get the customRdpProperty property: Custom rdp property of HostPool.

Returns:

the customRdpProperty value.

description

public String description()

Get the description property: Description of HostPool.

Returns:

the description value.

friendlyName

public String friendlyName()

Get the friendlyName property: Friendly name of HostPool.

Returns:

the friendlyName value.

fromJson

public static HostPoolPatchProperties fromJson(JsonReader jsonReader)

Reads an instance of HostPoolPatchProperties from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of HostPoolPatchProperties if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If an error occurs while reading the HostPoolPatchProperties.

loadBalancerType

public LoadBalancerType loadBalancerType()

Get the loadBalancerType property: The type of the load balancer.

Returns:

the loadBalancerType value.

maxSessionLimit

public Integer maxSessionLimit()

Get the maxSessionLimit property: The max session limit of HostPool.

Returns:

the maxSessionLimit value.

personalDesktopAssignmentType

public PersonalDesktopAssignmentType personalDesktopAssignmentType()

Get the personalDesktopAssignmentType property: PersonalDesktopAssignment type for HostPool.

Returns:

the personalDesktopAssignmentType value.

preferredAppGroupType

public PreferredAppGroupType preferredAppGroupType()

Get the preferredAppGroupType property: The type of preferred application group type, default to Desktop Application Group.

Returns:

the preferredAppGroupType value.

publicNetworkAccess

public HostpoolPublicNetworkAccess publicNetworkAccess()

Get the publicNetworkAccess property: Enabled to allow this resource to be access from the public network.

Returns:

the publicNetworkAccess value.

registrationInfo

public RegistrationInfoPatch registrationInfo()

Get the registrationInfo property: The registration info of HostPool.

Returns:

the registrationInfo value.

ring

public Integer ring()

Get the ring property: The ring number of HostPool.

Returns:

the ring value.

ssoadfsAuthority

public String ssoadfsAuthority()

Get the ssoadfsAuthority property: URL to customer ADFS server for signing WVD SSO certificates.

Returns:

the ssoadfsAuthority value.

ssoClientId

public String ssoClientId()

Get the ssoClientId property: ClientId for the registered Relying Party used to issue WVD SSO certificates.

Returns:

the ssoClientId value.

ssoClientSecretKeyVaultPath

public String ssoClientSecretKeyVaultPath()

Get the ssoClientSecretKeyVaultPath property: Path to Azure KeyVault storing the secret used for communication to ADFS.

Returns:

the ssoClientSecretKeyVaultPath value.

ssoSecretType

public SsoSecretType ssoSecretType()

Get the ssoSecretType property: The type of single sign on Secret Type.

Returns:

the ssoSecretType value.

startVMOnConnect

public Boolean startVMOnConnect()

Get the startVMOnConnect property: The flag to turn on/off StartVMOnConnect feature.

Returns:

the startVMOnConnect value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

validate

public void validate()

Validates the instance.

validationEnvironment

public Boolean validationEnvironment()

Get the validationEnvironment property: Is validation environment.

Returns:

the validationEnvironment value.

vmTemplate

public String vmTemplate()

Get the vmTemplate property: VM template for sessionhosts configuration within hostpool.

Returns:

the vmTemplate value.

withAgentUpdate

public HostPoolPatchProperties withAgentUpdate(AgentUpdatePatchProperties agentUpdate)

Set the agentUpdate property: The session host configuration for updating agent, monitoring agent, and stack component.

Parameters:

agentUpdate - the agentUpdate value to set.

Returns:

the HostPoolPatchProperties object itself.

withCustomRdpProperty

public HostPoolPatchProperties withCustomRdpProperty(String customRdpProperty)

Set the customRdpProperty property: Custom rdp property of HostPool.

Parameters:

customRdpProperty - the customRdpProperty value to set.

Returns:

the HostPoolPatchProperties object itself.

withDescription

public HostPoolPatchProperties withDescription(String description)

Set the description property: Description of HostPool.

Parameters:

description - the description value to set.

Returns:

the HostPoolPatchProperties object itself.

withFriendlyName

public HostPoolPatchProperties withFriendlyName(String friendlyName)

Set the friendlyName property: Friendly name of HostPool.

Parameters:

friendlyName - the friendlyName value to set.

Returns:

the HostPoolPatchProperties object itself.

withLoadBalancerType

public HostPoolPatchProperties withLoadBalancerType(LoadBalancerType loadBalancerType)

Set the loadBalancerType property: The type of the load balancer.

Parameters:

loadBalancerType - the loadBalancerType value to set.

Returns:

the HostPoolPatchProperties object itself.

withMaxSessionLimit

public HostPoolPatchProperties withMaxSessionLimit(Integer maxSessionLimit)

Set the maxSessionLimit property: The max session limit of HostPool.

Parameters:

maxSessionLimit - the maxSessionLimit value to set.

Returns:

the HostPoolPatchProperties object itself.

withPersonalDesktopAssignmentType

public HostPoolPatchProperties withPersonalDesktopAssignmentType(PersonalDesktopAssignmentType personalDesktopAssignmentType)

Set the personalDesktopAssignmentType property: PersonalDesktopAssignment type for HostPool.

Parameters:

personalDesktopAssignmentType - the personalDesktopAssignmentType value to set.

Returns:

the HostPoolPatchProperties object itself.

withPreferredAppGroupType

public HostPoolPatchProperties 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 HostPoolPatchProperties object itself.

withPublicNetworkAccess

public HostPoolPatchProperties withPublicNetworkAccess(HostpoolPublicNetworkAccess publicNetworkAccess)

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 HostPoolPatchProperties object itself.

withRegistrationInfo

public HostPoolPatchProperties withRegistrationInfo(RegistrationInfoPatch registrationInfo)

Set the registrationInfo property: The registration info of HostPool.

Parameters:

registrationInfo - the registrationInfo value to set.

Returns:

the HostPoolPatchProperties object itself.

withRing

public HostPoolPatchProperties withRing(Integer ring)

Set the ring property: The ring number of HostPool.

Parameters:

ring - the ring value to set.

Returns:

the HostPoolPatchProperties object itself.

withSsoadfsAuthority

public HostPoolPatchProperties withSsoadfsAuthority(String ssoadfsAuthority)

Set the ssoadfsAuthority property: URL to customer ADFS server for signing WVD SSO certificates.

Parameters:

ssoadfsAuthority - the ssoadfsAuthority value to set.

Returns:

the HostPoolPatchProperties object itself.

withSsoClientId

public HostPoolPatchProperties withSsoClientId(String ssoClientId)

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 HostPoolPatchProperties object itself.

withSsoClientSecretKeyVaultPath

public HostPoolPatchProperties withSsoClientSecretKeyVaultPath(String ssoClientSecretKeyVaultPath)

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 HostPoolPatchProperties object itself.

withSsoSecretType

public HostPoolPatchProperties withSsoSecretType(SsoSecretType ssoSecretType)

Set the ssoSecretType property: The type of single sign on Secret Type.

Parameters:

ssoSecretType - the ssoSecretType value to set.

Returns:

the HostPoolPatchProperties object itself.

withStartVMOnConnect

public HostPoolPatchProperties withStartVMOnConnect(Boolean startVMOnConnect)

Set the startVMOnConnect property: The flag to turn on/off StartVMOnConnect feature.

Parameters:

startVMOnConnect - the startVMOnConnect value to set.

Returns:

the HostPoolPatchProperties object itself.

withValidationEnvironment

public HostPoolPatchProperties withValidationEnvironment(Boolean validationEnvironment)

Set the validationEnvironment property: Is validation environment.

Parameters:

validationEnvironment - the validationEnvironment value to set.

Returns:

the HostPoolPatchProperties object itself.

withVmTemplate

public HostPoolPatchProperties withVmTemplate(String vmTemplate)

Set the vmTemplate property: VM template for sessionhosts configuration within hostpool.

Parameters:

vmTemplate - the vmTemplate value to set.

Returns:

the HostPoolPatchProperties object itself.