Package com.azure.resourcemanager.desktopvirtualization.models

Interface HostPool

public interface HostPool
An immutable client-side representation of HostPool.

  • Method Details

    • id

      String id()
      Gets the id property: Fully qualified resource Id for the resource.
      Returns:
      the id value.

    • name

      String name()
      Gets the name property: The name of the resource.
      Returns:
      the name value.

    • type

      String type()
      Gets the type property: The type of the resource.
      Returns:
      the type value.

    • location

      String location()
      Gets the location property: The geo-location where the resource lives.
      Returns:
      the location value.

    • tags

      Map<String,String> tags()
      Gets the tags property: Resource tags.
      Returns:
      the tags value.

    • managedBy

      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:
      the managedBy value.

    • kind

      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:
      the kind value.

    • etag

      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:
      the etag value.

    • identity

      ResourceModelWithAllowedPropertySetIdentity identity()
      Gets the identity property: The identity property.
      Returns:
      the identity value.

    • sku

      ResourceModelWithAllowedPropertySetSku sku()
      Gets the sku property: The sku property.
      Returns:
      the sku value.

    • plan

      ResourceModelWithAllowedPropertySetPlan plan()
      Gets the plan property: The plan property.
      Returns:
      the plan value.

    • systemData

      com.azure.core.management.SystemData systemData()
      Gets the systemData property: Metadata pertaining to creation and last modification of the resource.
      Returns:
      the systemData value.

    • objectId

      String objectId()
      Gets the objectId property: ObjectId of HostPool. (internal use).
      Returns:
      the objectId value.

    • friendlyName

      String friendlyName()
      Gets the friendlyName property: Friendly name of HostPool.
      Returns:
      the friendlyName value.

    • description

      String description()
      Gets the description property: Description of HostPool.
      Returns:
      the description value.

    • hostPoolType

      HostPoolType hostPoolType()
      Gets the hostPoolType property: HostPool type for desktop.
      Returns:
      the hostPoolType value.

    • personalDesktopAssignmentType

      PersonalDesktopAssignmentType personalDesktopAssignmentType()
      Gets the personalDesktopAssignmentType property: PersonalDesktopAssignment type for HostPool.
      Returns:
      the personalDesktopAssignmentType value.

    • customRdpProperty

      String customRdpProperty()
      Gets the customRdpProperty property: Custom rdp property of HostPool.
      Returns:
      the customRdpProperty value.

    • maxSessionLimit

      Integer maxSessionLimit()
      Gets the maxSessionLimit property: The max session limit of HostPool.
      Returns:
      the maxSessionLimit value.

    • loadBalancerType

      LoadBalancerType loadBalancerType()
      Gets the loadBalancerType property: The type of the load balancer.
      Returns:
      the loadBalancerType value.

    • ring

      Integer ring()
      Gets the ring property: The ring number of HostPool.
      Returns:
      the ring value.

    • validationEnvironment

      Boolean validationEnvironment()
      Gets the validationEnvironment property: Is validation environment.
      Returns:
      the validationEnvironment value.

    • registrationInfo

      RegistrationInfo registrationInfo()
      Gets the registrationInfo property: The registration info of HostPool.
      Returns:
      the registrationInfo value.

    • vmTemplate

      String vmTemplate()
      Gets the vmTemplate property: VM template for sessionhosts configuration within hostpool.
      Returns:
      the vmTemplate value.

    • applicationGroupReferences

      List<String> applicationGroupReferences()
      Gets the applicationGroupReferences property: List of applicationGroup links.
      Returns:
      the applicationGroupReferences value.

    • ssoadfsAuthority

      String ssoadfsAuthority()
      Gets the ssoadfsAuthority property: URL to customer ADFS server for signing WVD SSO certificates.
      Returns:
      the ssoadfsAuthority value.

    • ssoClientId

      String ssoClientId()
      Gets the ssoClientId property: ClientId for the registered Relying Party used to issue WVD SSO certificates.
      Returns:
      the ssoClientId value.

    • ssoClientSecretKeyVaultPath

      String ssoClientSecretKeyVaultPath()
      Gets the ssoClientSecretKeyVaultPath property: Path to Azure KeyVault storing the secret used for communication to ADFS.
      Returns:
      the ssoClientSecretKeyVaultPath value.

    • ssoSecretType

      SsoSecretType ssoSecretType()
      Gets the ssoSecretType property: The type of single sign on Secret Type.
      Returns:
      the ssoSecretType value.

    • preferredAppGroupType

      PreferredAppGroupType preferredAppGroupType()
      Gets the preferredAppGroupType property: The type of preferred application group type, default to Desktop Application Group.
      Returns:
      the preferredAppGroupType value.

    • startVMOnConnect

      Boolean startVMOnConnect()
      Gets the startVMOnConnect property: The flag to turn on/off StartVMOnConnect feature.
      Returns:
      the startVMOnConnect value.

    • migrationRequest

      MigrationRequestProperties migrationRequest()
      Gets the migrationRequest property: The registration info of HostPool.
      Returns:
      the migrationRequest value.

    • cloudPcResource

      Boolean cloudPcResource()
      Gets the cloudPcResource property: Is cloud pc resource.
      Returns:
      the cloudPcResource value.

    • publicNetworkAccess

      PublicNetworkAccess 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:
      the publicNetworkAccess value.

    • region

      com.azure.core.management.Region region()
      Gets the region of the resource.
      Returns:
      the region of the resource.

    • regionName

      String regionName()
      Gets the name of the resource region.
      Returns:
      the name of the resource region.

    • resourceGroupName

      String resourceGroupName()
      Gets the name of the resource group.
      Returns:
      the name of the resource group.

    • innerModel

      HostPoolInner innerModel()
      Gets the inner com.azure.resourcemanager.desktopvirtualization.fluent.models.HostPoolInner object.
      Returns:
      the inner object.

    • update

      HostPool.Update update()
      Begins update for the HostPool resource.
      Returns:
      the stage of resource update.

    • refresh

      HostPool refresh()
      Refreshes the resource to sync with Azure.
      Returns:
      the refreshed resource.

    • refresh

      HostPool refresh(com.azure.core.util.Context context)
      Refreshes the resource to sync with Azure.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      the refreshed resource.

    • retrieveRegistrationToken

      RegistrationInfo retrieveRegistrationToken()
      Registration token of the host pool.
      Returns:
      represents a RegistrationInfo definition.
      Throws:
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • retrieveRegistrationTokenWithResponse

      com.azure.core.http.rest.Response<RegistrationInfo> retrieveRegistrationTokenWithResponse(com.azure.core.util.Context context)
      Registration token of the host pool.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      represents a RegistrationInfo definition along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.