HostPoolPatch Class

Package:
com.azure.resourcemanager.desktopvirtualization.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-desktopvirtualization:1.2.0

public final class HostPoolPatch
extends ProxyResource

HostPool properties that can be patched.

Constructor Summary

Constructor Description
HostPoolPatch()

Creates an instance of HostPoolPatch 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 HostPoolPatch fromJson(JsonReader jsonReader)

Reads an instance of HostPoolPatch from the JsonReader.
String id()

Get the id property: Fully qualified resource Id for the resource.
LoadBalancerType loadBalancerType()

Get the loadBalancerType property: The type of the load balancer.
Integer maxSessionLimit()

Get the maxSessionLimit property: The max session limit of HostPool.
String name()

Get the name property: The name of the resource.
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.
SystemData systemData()

Get the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.
Map<String,String> tags()

Get the tags property: tags to be updated.
JsonWriter toJson(JsonWriter jsonWriter)
String type()

Get the type property: The type of the resource.
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.
HostPoolPatch withAgentUpdate(AgentUpdatePatchProperties agentUpdate)

Set the agentUpdate property: The session host configuration for updating agent, monitoring agent, and stack component.
HostPoolPatch withCustomRdpProperty(String customRdpProperty)

Set the customRdpProperty property: Custom rdp property of HostPool.
HostPoolPatch withDescription(String description)

Set the description property: Description of HostPool.
HostPoolPatch withFriendlyName(String friendlyName)

Set the friendlyName property: Friendly name of HostPool.
HostPoolPatch withLoadBalancerType(LoadBalancerType loadBalancerType)

Set the loadBalancerType property: The type of the load balancer.
HostPoolPatch withMaxSessionLimit(Integer maxSessionLimit)

Set the maxSessionLimit property: The max session limit of HostPool.
HostPoolPatch withPersonalDesktopAssignmentType(PersonalDesktopAssignmentType personalDesktopAssignmentType)

Set the personalDesktopAssignmentType property: PersonalDesktopAssignment type for HostPool.
HostPoolPatch withPreferredAppGroupType(PreferredAppGroupType preferredAppGroupType)

Set the preferredAppGroupType property: The type of preferred application group type, default to Desktop Application Group.
HostPoolPatch withPublicNetworkAccess(HostpoolPublicNetworkAccess publicNetworkAccess)

Set the publicNetworkAccess property: Enabled to allow this resource to be access from the public network.
HostPoolPatch withRegistrationInfo(RegistrationInfoPatch registrationInfo)

Set the registrationInfo property: The registration info of HostPool.
HostPoolPatch withRing(Integer ring)

Set the ring property: The ring number of HostPool.
HostPoolPatch withSsoadfsAuthority(String ssoadfsAuthority)

Set the ssoadfsAuthority property: URL to customer ADFS server for signing WVD SSO certificates.
HostPoolPatch withSsoClientId(String ssoClientId)

Set the ssoClientId property: ClientId for the registered Relying Party used to issue WVD SSO certificates.
HostPoolPatch withSsoClientSecretKeyVaultPath(String ssoClientSecretKeyVaultPath)

Set the ssoClientSecretKeyVaultPath property: Path to Azure KeyVault storing the secret used for communication to ADFS.
HostPoolPatch withSsoSecretType(SsoSecretType ssoSecretType)

Set the ssoSecretType property: The type of single sign on Secret Type.
HostPoolPatch withStartVMOnConnect(Boolean startVMOnConnect)

Set the startVMOnConnect property: The flag to turn on/off StartVMOnConnect feature.
HostPoolPatch withTags(Map<String,String> tags)

Set the tags property: tags to be updated.
HostPoolPatch withValidationEnvironment(Boolean validationEnvironment)

Set the validationEnvironment property: Is validation environment.
HostPoolPatch withVmTemplate(String vmTemplate)

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

Methods inherited from ProxyResource

fromJson id name toJson type

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

HostPoolPatch

public HostPoolPatch()

Creates an instance of HostPoolPatch 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 HostPoolPatch fromJson(JsonReader jsonReader)

Reads an instance of HostPoolPatch from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

Throws:

IOException

 - If the deserialized JSON object was missing any required properties.

id

public String id()

Get the id property: Fully qualified resource Id for the resource.

Overrides:

HostPoolPatch.id()

Returns:

the id value.

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.

name

public String name()

Get the name property: The name of the resource.

Overrides:

HostPoolPatch.name()

Returns:

the name 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.

systemData

public SystemData systemData()

Get the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.

Returns:

the systemData value.

tags

public Map<String,String> tags()

Get the tags property: tags to be updated.

Returns:

the tags value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

HostPoolPatch.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

type

public String type()

Get the type property: The type of the resource.

Overrides:

HostPoolPatch.type()

Returns:

the type value.

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

withCustomRdpProperty

public HostPoolPatch withCustomRdpProperty(String customRdpProperty)

Set the customRdpProperty property: Custom rdp property of HostPool.

Parameters:

customRdpProperty - the customRdpProperty value to set.

Returns:

the HostPoolPatch object itself.

withDescription

public HostPoolPatch withDescription(String description)

Set the description property: Description of HostPool.

Parameters:

description - the description value to set.

Returns:

the HostPoolPatch object itself.

withFriendlyName

public HostPoolPatch withFriendlyName(String friendlyName)

Set the friendlyName property: Friendly name of HostPool.

Parameters:

friendlyName - the friendlyName value to set.

Returns:

the HostPoolPatch object itself.

withLoadBalancerType

public HostPoolPatch withLoadBalancerType(LoadBalancerType loadBalancerType)

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

Parameters:

loadBalancerType - the loadBalancerType value to set.

Returns:

the HostPoolPatch object itself.

withMaxSessionLimit

public HostPoolPatch withMaxSessionLimit(Integer maxSessionLimit)

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

Parameters:

maxSessionLimit - the maxSessionLimit value to set.

Returns:

the HostPoolPatch object itself.

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.

withPreferredAppGroupType

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

withPublicNetworkAccess

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

withRegistrationInfo

public HostPoolPatch withRegistrationInfo(RegistrationInfoPatch registrationInfo)

Set the registrationInfo property: The registration info of HostPool.

Parameters:

registrationInfo - the registrationInfo value to set.

Returns:

the HostPoolPatch object itself.

withRing

public HostPoolPatch withRing(Integer ring)

Set the ring property: The ring number of HostPool.

Parameters:

ring - the ring value to set.

Returns:

the HostPoolPatch object itself.

withSsoadfsAuthority

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

withSsoClientId

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

withSsoClientSecretKeyVaultPath

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

withSsoSecretType

public HostPoolPatch withSsoSecretType(SsoSecretType ssoSecretType)

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

Parameters:

ssoSecretType - the ssoSecretType value to set.

Returns:

the HostPoolPatch object itself.

withStartVMOnConnect

public HostPoolPatch withStartVMOnConnect(Boolean startVMOnConnect)

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

Parameters:

startVMOnConnect - the startVMOnConnect value to set.

Returns:

the HostPoolPatch object itself.

withTags

public HostPoolPatch withTags(Map<String,String> tags)

Set the tags property: tags to be updated.

Parameters:

tags - the tags value to set.

Returns:

the HostPoolPatch object itself.

withValidationEnvironment

public HostPoolPatch withValidationEnvironment(Boolean validationEnvironment)

Set the validationEnvironment property: Is validation environment.

Parameters:

validationEnvironment - the validationEnvironment value to set.

Returns:

the HostPoolPatch object itself.

withVmTemplate

public HostPoolPatch withVmTemplate(String vmTemplate)

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

Parameters:

vmTemplate - the vmTemplate value to set.

Returns:

the HostPoolPatch object itself.

Applies to