HostPool Interface
public interface HostPool
An immutable client-side representation of HostPool.
Method Summary
| Modifier and Type | Method and Description |
|---|---|
|
abstract
Agent |
agentUpdate()
Gets the agent |
| abstract List<String> |
appAttachPackageReferences()
Gets the app |
| abstract List<String> |
applicationGroupReferences()
Gets the application |
| abstract Boolean |
cloudPcResource()
Gets the cloud |
| abstract String |
customRdpProperty()
Gets the custom |
| abstract String |
description()
Gets the description property: Description of Host |
| abstract String |
etag()
Gets the etag property: The etag field is *not* required. |
| abstract String |
friendlyName()
Gets the friendly |
|
abstract
Host |
hostPoolType()
Gets the host |
| abstract String |
id()
Gets the id property: Fully qualified resource Id for the resource. |
|
abstract
Resource |
identity()
Gets the identity property: The identity property. |
|
abstract
Host |
innerModel()
Gets the inner com. |
| abstract String |
kind()
Gets the kind property: Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. |
|
abstract
Registration |
listRegistrationTokens()
Operation to list the Registration |
|
abstract
Response<Registration |
listRegistrationTokensWithResponse(Context context)
Operation to list the Registration |
|
abstract
Load |
loadBalancerType()
Gets the load |
| abstract String |
location()
Gets the location property: The geo-location where the resource lives. |
| abstract String |
managedBy()
Gets the managed |
| abstract Integer |
maxSessionLimit()
Gets the max |
| abstract String |
name()
Gets the name property: The name of the resource. |
| abstract String |
objectId()
Gets the object |
|
abstract
Personal |
personalDesktopAssignmentType()
Gets the personal |
|
abstract
Resource |
plan()
Gets the plan property: The plan property. |
|
abstract
Preferred |
preferredAppGroupType()
Gets the preferred |
|
abstract
List<Private |
privateEndpointConnections()
Gets the private |
|
abstract
Hostpool |
publicNetworkAccess()
Gets the public |
|
abstract
Host |
refresh()
Refreshes the resource to sync with Azure. |
|
abstract
Host |
refresh(Context context)
Refreshes the resource to sync with Azure. |
| abstract Region |
region()
Gets the region of the resource. |
| abstract String |
regionName()
Gets the name of the resource region. |
|
abstract
Registration |
registrationInfo()
Gets the registration |
| abstract String |
resourceGroupName()
Gets the name of the resource group. |
|
abstract
Registration |
retrieveRegistrationToken()
Registration token of the host pool. |
|
abstract
Response<Registration |
retrieveRegistrationTokenWithResponse(Context context)
Registration token of the host pool. |
| abstract Integer |
ring()
Gets the ring property: The ring number of Host |
|
abstract
Resource |
sku()
Gets the sku property: The sku property. |
| abstract String |
ssoadfsAuthority()
Gets the ssoadfs |
| abstract String |
ssoClientId()
Gets the sso |
| abstract String |
ssoClientSecretKeyVaultPath()
Gets the sso |
|
abstract
Sso |
ssoSecretType()
Gets the sso |
| abstract Boolean |
startVMOnConnect()
Gets the start |
|
abstract
System |
systemData()
Gets the system |
| abstract Map<String,String> |
tags()
Gets the tags property: Resource tags. |
| abstract String |
type()
Gets the type property: The type of the resource. |
| abstract Update |
update()
Begins update for the Host |
| abstract Boolean |
validationEnvironment()
Gets the validation |
| abstract String |
vmTemplate()
Gets the vm |
Method Details
agentUpdate
public abstract AgentUpdateProperties agentUpdate()
Gets the agentUpdate property: The session host configuration for updating agent, monitoring agent, and stack component.
Returns:
appAttachPackageReferences
public abstract List<String> appAttachPackageReferences()
Gets the appAttachPackageReferences property: List of App Attach Package links.
Returns:
applicationGroupReferences
public abstract List<String> applicationGroupReferences()
Gets the applicationGroupReferences property: List of applicationGroup links.
Returns:
cloudPcResource
public abstract Boolean cloudPcResource()
Gets the cloudPcResource property: Is cloud pc resource.
Returns:
customRdpProperty
public abstract String customRdpProperty()
Gets the customRdpProperty property: Custom rdp property of HostPool.
Returns:
description
public abstract String description()
Gets the description property: Description of HostPool.
Returns:
etag
public abstract String etag()
Gets 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.
Returns:
friendlyName
public abstract String friendlyName()
Gets the friendlyName property: Friendly name of HostPool.
Returns:
hostPoolType
public abstract HostPoolType hostPoolType()
Gets the hostPoolType property: HostPool type for desktop.
Returns:
id
public abstract String id()
Gets the id property: Fully qualified resource Id for the resource.
Returns:
identity
public abstract ResourceModelWithAllowedPropertySetIdentity identity()
Gets the identity property: The identity property.
Returns:
innerModel
public abstract HostPoolInner innerModel()
Gets the inner com.azure.resourcemanager.desktopvirtualization.fluent.models.HostPoolInner object.
Returns:
kind
public abstract String kind()
Gets 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.
Returns:
listRegistrationTokens
public abstract RegistrationTokenList listRegistrationTokens()
Operation to list the RegistrationTokens associated with the HostPool.
Returns:
listRegistrationTokensWithResponse
public abstract Response<RegistrationTokenList> listRegistrationTokensWithResponse(Context context)
Operation to list the RegistrationTokens associated with the HostPool.
Parameters:
Returns:
loadBalancerType
public abstract LoadBalancerType loadBalancerType()
Gets the loadBalancerType property: The type of the load balancer.
Returns:
location
public abstract String location()
Gets the location property: The geo-location where the resource lives.
Returns:
managedBy
public abstract String managedBy()
Gets 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.
Returns:
maxSessionLimit
public abstract Integer maxSessionLimit()
Gets the maxSessionLimit property: The max session limit of HostPool.
Returns:
name
public abstract String name()
Gets the name property: The name of the resource.
Returns:
objectId
public abstract String objectId()
Gets the objectId property: ObjectId of HostPool. (internal use).
Returns:
personalDesktopAssignmentType
public abstract PersonalDesktopAssignmentType personalDesktopAssignmentType()
Gets the personalDesktopAssignmentType property: PersonalDesktopAssignment type for HostPool.
Returns:
plan
public abstract ResourceModelWithAllowedPropertySetPlan plan()
Gets the plan property: The plan property.
Returns:
preferredAppGroupType
public abstract PreferredAppGroupType preferredAppGroupType()
Gets the preferredAppGroupType property: The type of preferred application group type, default to Desktop Application Group.
Returns:
privateEndpointConnections
public abstract List<PrivateEndpointConnection> privateEndpointConnections()
Gets the privateEndpointConnections property: List of private endpoint connection associated with the specified resource.
Returns:
publicNetworkAccess
public abstract HostpoolPublicNetworkAccess publicNetworkAccess()
Gets 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:
refresh
public abstract HostPool refresh()
Refreshes the resource to sync with Azure.
Returns:
refresh
public abstract HostPool refresh(Context context)
Refreshes the resource to sync with Azure.
Parameters:
Returns:
region
public abstract Region region()
Gets the region of the resource.
Returns:
regionName
public abstract String regionName()
Gets the name of the resource region.
Returns:
registrationInfo
public abstract RegistrationInfo registrationInfo()
Gets the registrationInfo property: The registration info of HostPool.
Returns:
resourceGroupName
public abstract String resourceGroupName()
Gets the name of the resource group.
Returns:
retrieveRegistrationToken
public abstract RegistrationInfo retrieveRegistrationToken()
Registration token of the host pool.
Returns:
retrieveRegistrationTokenWithResponse
public abstract Response<RegistrationInfo> retrieveRegistrationTokenWithResponse(Context context)
Registration token of the host pool.
Parameters:
Returns:
ring
public abstract Integer ring()
Gets the ring property: The ring number of HostPool.
Returns:
sku
public abstract ResourceModelWithAllowedPropertySetSku sku()
Gets the sku property: The sku property.
Returns:
ssoadfsAuthority
public abstract String ssoadfsAuthority()
Gets the ssoadfsAuthority property: URL to customer ADFS server for signing WVD SSO certificates.
Returns:
ssoClientId
public abstract String ssoClientId()
Gets the ssoClientId property: ClientId for the registered Relying Party used to issue WVD SSO certificates.
Returns:
ssoClientSecretKeyVaultPath
public abstract String ssoClientSecretKeyVaultPath()
Gets the ssoClientSecretKeyVaultPath property: Path to Azure KeyVault storing the secret used for communication to ADFS.
Returns:
ssoSecretType
public abstract SsoSecretType ssoSecretType()
Gets the ssoSecretType property: The type of single sign on Secret Type.
Returns:
startVMOnConnect
public abstract Boolean startVMOnConnect()
Gets the startVMOnConnect property: The flag to turn on/off StartVMOnConnect feature.
Returns:
systemData
public abstract SystemData systemData()
Gets the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.
Returns:
tags
public abstract Map<String,String> tags()
Gets the tags property: Resource tags.
Returns:
type
public abstract String type()
Gets the type property: The type of the resource.
Returns:
update
public abstract HostPool.Update update()
Begins update for the HostPool resource.
Returns:
validationEnvironment
public abstract Boolean validationEnvironment()
Gets the validationEnvironment property: Is validation environment.
Returns:
vmTemplate
public abstract String vmTemplate()
Gets the vmTemplate property: VM template for sessionhosts configuration within hostpool.
Returns:
