HostPoolInner Class

Package:

com.azure.resourcemanager.desktopvirtualization.fluent.models

Maven Artifact:

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

• java.lang.Object
• • com.azure.core.management.ProxyResource
  • • com.azure.core.management.Resource
    • • com.azure.resourcemanager.desktopvirtualization.models.ResourceModelWithAllowedPropertySet
      • • com.azure.resourcemanager.desktopvirtualization.fluent.models.HostPoolInner

public final class HostPoolInner
extends ResourceModelWithAllowedPropertySet

Represents a HostPool definition.

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
AgentUpdateProperties	agentUpdate() Get the agentUpdate property: The session host configuration for updating agent, monitoring agent, and stack component.
List<String>	appAttachPackageReferences() Get the appAttachPackageReferences property: List of App Attach Package links.
List<String>	applicationGroupReferences() Get the applicationGroupReferences property: List of applicationGroup links.
Boolean	cloudPcResource() Get the cloudPcResource property: Is cloud pc resource.
String	customRdpProperty() Get the customRdpProperty property: Custom rdp property of HostPool.
String	description() Get the description property: Description of HostPool.
String	etag() Get the etag property: The etag field is *not* required.
String	friendlyName() Get the friendlyName property: Friendly name of HostPool.
static HostPoolInner	fromJson(JsonReader jsonReader) Reads an instance of HostPoolInner from the JsonReader.
HostPoolType	hostPoolType() Get the hostPoolType property: HostPool type for desktop.
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.
String	objectId() Get the objectId property: ObjectId 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.
List<PrivateEndpointConnection>	privateEndpointConnections() Get the privateEndpointConnections property: List of private endpoint connection associated with the specified resource.
HostpoolPublicNetworkAccess	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.
RegistrationInfoInner	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.
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.
HostPoolInner	withAgentUpdate(AgentUpdateProperties agentUpdate) Set the agentUpdate property: The session host configuration for updating agent, monitoring agent, and stack component.
HostPoolInner	withCustomRdpProperty(String customRdpProperty) Set the customRdpProperty property: Custom rdp property of HostPool.
HostPoolInner	withDescription(String description) Set the description property: Description of HostPool.
HostPoolInner	withFriendlyName(String friendlyName) Set the friendlyName property: Friendly name of HostPool.
HostPoolInner	withHostPoolType(HostPoolType hostPoolType) Set the hostPoolType property: HostPool type for desktop.
HostPoolInner	withIdentity(ResourceModelWithAllowedPropertySetIdentity identity) Set the identity property: The identity property.
HostPoolInner	withKind(String kind) Set the kind property: Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type.
HostPoolInner	withLoadBalancerType(LoadBalancerType loadBalancerType) Set the loadBalancerType property: The type of the load balancer.
HostPoolInner	withLocation(String location)
HostPoolInner	withManagedBy(String managedBy) Set the managedBy property: The fully qualified resource ID of the resource that manages this resource.
HostPoolInner	withMaxSessionLimit(Integer maxSessionLimit) Set the maxSessionLimit property: The max session limit of HostPool.
HostPoolInner	withPersonalDesktopAssignmentType(PersonalDesktopAssignmentType personalDesktopAssignmentType) Set the personalDesktopAssignmentType property: PersonalDesktopAssignment type for HostPool.
HostPoolInner	withPlan(ResourceModelWithAllowedPropertySetPlan plan) Set the plan property: The plan property.
HostPoolInner	withPreferredAppGroupType(PreferredAppGroupType preferredAppGroupType) Set the preferredAppGroupType property: The type of preferred application group type, default to Desktop Application Group.
HostPoolInner	withPublicNetworkAccess(HostpoolPublicNetworkAccess 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.
HostPoolInner	withRegistrationInfo(RegistrationInfoInner registrationInfo) Set the registrationInfo property: The registration info of HostPool.
HostPoolInner	withRing(Integer ring) Set the ring property: The ring number of HostPool.
HostPoolInner	withSku(ResourceModelWithAllowedPropertySetSku sku) Set the sku property: The sku property.
HostPoolInner	withSsoadfsAuthority(String ssoadfsAuthority) Set the ssoadfsAuthority property: URL to customer ADFS server for signing WVD SSO certificates.
HostPoolInner	withSsoClientId(String ssoClientId) Set the ssoClientId property: ClientId for the registered Relying Party used to issue WVD SSO certificates.
HostPoolInner	withSsoClientSecretKeyVaultPath(String ssoClientSecretKeyVaultPath) Set the ssoClientSecretKeyVaultPath property: Path to Azure KeyVault storing the secret used for communication to ADFS.
HostPoolInner	withSsoSecretType(SsoSecretType ssoSecretType) Set the ssoSecretType property: The type of single sign on Secret Type.
HostPoolInner	withStartVMOnConnect(Boolean startVMOnConnect) Set the startVMOnConnect property: The flag to turn on/off StartVMOnConnect feature.
HostPoolInner	withTags(Map<String,String> tags)
HostPoolInner	withValidationEnvironment(Boolean validationEnvironment) Set the validationEnvironment property: Is validation environment.
HostPoolInner	withVmTemplate(String vmTemplate) Set the vmTemplate property: VM template for sessionhosts configuration within hostpool.

Methods inherited from Resource

location tags

Methods inherited from ResourceModelWithAllowedPropertySet

etag fromJson id identity kind managedBy name plan sku systemData toJson type validate withIdentity withKind withLocation withManagedBy withPlan withSku withTags

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

HostPoolInner

public HostPoolInner()

Creates an instance of HostPoolInner class.

Method Details

agentUpdate

public AgentUpdateProperties agentUpdate()

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

Returns:

the agentUpdate value.

appAttachPackageReferences

public List<String> appAttachPackageReferences()

Get the appAttachPackageReferences property: List of App Attach Package links.

Returns:

the appAttachPackageReferences value.

applicationGroupReferences

public List<String> applicationGroupReferences()

Get the applicationGroupReferences property: List of applicationGroup links.

Returns:

the applicationGroupReferences value.

cloudPcResource

public Boolean cloudPcResource()

Get the cloudPcResource property: Is cloud pc resource.

Returns:

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

etag

public String etag()

Get the etag property: The etag field is *not* required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.

Overrides:

HostPoolInner.etag()

Returns:

the etag value.

friendlyName

public String friendlyName()

Get the friendlyName property: Friendly name of HostPool.

Returns:

the friendlyName value.

fromJson

public static HostPoolInner fromJson(JsonReader jsonReader)

Reads an instance of HostPoolInner from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of HostPoolInner 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.

hostPoolType

public HostPoolType hostPoolType()

Get the hostPoolType property: HostPool type for desktop.

Returns:

the hostPoolType value.

id

public String id()

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

Overrides:

HostPoolInner.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:

HostPoolInner.name()

Returns:

the name value.

objectId

public String objectId()

Get the objectId property: ObjectId of HostPool. (internal use).

Returns:

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

privateEndpointConnections

public List<PrivateEndpointConnection> privateEndpointConnections()

Get the privateEndpointConnections property: List of private endpoint connection associated with the specified resource.

Returns:

the privateEndpointConnections value.

publicNetworkAccess

public HostpoolPublicNetworkAccess 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.

registrationInfo

public RegistrationInfoInner 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.

Overrides:

HostPoolInner.systemData()

Returns:

the systemData value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

HostPoolInner.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

type

public String type()

Get the type property: The type of the resource.

Overrides:

HostPoolInner.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

Overrides:

HostPoolInner.validate()

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 HostPoolInner withAgentUpdate(AgentUpdateProperties 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 HostPoolInner object itself.

withCustomRdpProperty

public HostPoolInner withCustomRdpProperty(String customRdpProperty)

Set the customRdpProperty property: Custom rdp property of HostPool.

Parameters:

customRdpProperty - the customRdpProperty value to set.

Returns:

the HostPoolInner object itself.

withDescription

public HostPoolInner withDescription(String description)

Set the description property: Description of HostPool.

Parameters:

description - the description value to set.

Returns:

the HostPoolInner object itself.

withFriendlyName

public HostPoolInner withFriendlyName(String friendlyName)

Set the friendlyName property: Friendly name of HostPool.

Parameters:

friendlyName - the friendlyName value to set.

Returns:

the HostPoolInner object itself.

withHostPoolType

public HostPoolInner withHostPoolType(HostPoolType hostPoolType)

Set the hostPoolType property: HostPool type for desktop.

Parameters:

hostPoolType - the hostPoolType value to set.

Returns:

the HostPoolInner object itself.

withIdentity

public HostPoolInner withIdentity(ResourceModelWithAllowedPropertySetIdentity identity)

Set the identity property: The identity property.

Overrides:

HostPoolInner.withIdentity(ResourceModelWithAllowedPropertySetIdentity identity)

Parameters:

identity

withKind

public HostPoolInner withKind(String kind)

Set the kind property: Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. E.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.

Overrides:

HostPoolInner.withKind(String kind)

Parameters:

kind

withLoadBalancerType

public HostPoolInner withLoadBalancerType(LoadBalancerType loadBalancerType)

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

Parameters:

loadBalancerType - the loadBalancerType value to set.

Returns:

the HostPoolInner object itself.

withLocation

public HostPoolInner withLocation(String location)

Overrides:

HostPoolInner.withLocation(String location)

Parameters:

location

withManagedBy

public HostPoolInner withManagedBy(String managedBy)

Set the managedBy property: The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.

Overrides:

HostPoolInner.withManagedBy(String managedBy)

Parameters:

managedBy

withMaxSessionLimit

public HostPoolInner withMaxSessionLimit(Integer maxSessionLimit)

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

Parameters:

maxSessionLimit - the maxSessionLimit value to set.

Returns:

the HostPoolInner object itself.

withPersonalDesktopAssignmentType

public HostPoolInner withPersonalDesktopAssignmentType(PersonalDesktopAssignmentType personalDesktopAssignmentType)

Set the personalDesktopAssignmentType property: PersonalDesktopAssignment type for HostPool.

Parameters:

personalDesktopAssignmentType - the personalDesktopAssignmentType value to set.

Returns:

the HostPoolInner object itself.

withPlan

public HostPoolInner withPlan(ResourceModelWithAllowedPropertySetPlan plan)

Set the plan property: The plan property.

Overrides:

HostPoolInner.withPlan(ResourceModelWithAllowedPropertySetPlan plan)

Parameters:

plan

withPreferredAppGroupType

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

withPublicNetworkAccess

public HostPoolInner withPublicNetworkAccess(HostpoolPublicNetworkAccess 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.

Parameters:

publicNetworkAccess - the publicNetworkAccess value to set.

Returns:

the HostPoolInner object itself.

withRegistrationInfo

public HostPoolInner withRegistrationInfo(RegistrationInfoInner registrationInfo)

Set the registrationInfo property: The registration info of HostPool.

Parameters:

registrationInfo - the registrationInfo value to set.

Returns:

the HostPoolInner object itself.

withRing

public HostPoolInner withRing(Integer ring)

Set the ring property: The ring number of HostPool.

Parameters:

ring - the ring value to set.

Returns:

the HostPoolInner object itself.

withSku

public HostPoolInner withSku(ResourceModelWithAllowedPropertySetSku sku)

Set the sku property: The sku property.

Overrides:

HostPoolInner.withSku(ResourceModelWithAllowedPropertySetSku sku)

Parameters:

sku

withSsoadfsAuthority

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

withSsoClientId

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

withSsoClientSecretKeyVaultPath

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

withSsoSecretType

public HostPoolInner withSsoSecretType(SsoSecretType ssoSecretType)

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

Parameters:

ssoSecretType - the ssoSecretType value to set.

Returns:

the HostPoolInner object itself.

withStartVMOnConnect

public HostPoolInner withStartVMOnConnect(Boolean startVMOnConnect)

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

Parameters:

startVMOnConnect - the startVMOnConnect value to set.

Returns:

the HostPoolInner object itself.

withTags

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

Overrides:

HostPoolInner.withTags(Map<String,String> tags)

Parameters:

tags

withValidationEnvironment

public HostPoolInner withValidationEnvironment(Boolean validationEnvironment)

Set the validationEnvironment property: Is validation environment.

Parameters:

validationEnvironment - the validationEnvironment value to set.

Returns:

the HostPoolInner object itself.

withVmTemplate

public HostPoolInner withVmTemplate(String vmTemplate)

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

Parameters:

vmTemplate - the vmTemplate value to set.

Returns:

the HostPoolInner object itself.