Package com.azure.resourcemanager.azurestackhci.models

Interface Cluster

  • public interface Cluster
    An immutable client-side representation of Cluster.

    • Method Detail

      • 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.

      • systemData

        com.azure.core.management.SystemData systemData()
        Gets the systemData property: System data of Cluster resource.
        Returns:
        the systemData value.

      • provisioningState

        ProvisioningState provisioningState()
        Gets the provisioningState property: Provisioning state.
        Returns:
        the provisioningState value.

      • status

        Status status()
        Gets the status property: Status of the cluster agent.
        Returns:
        the status value.

      • cloudId

        String cloudId()
        Gets the cloudId property: Unique, immutable resource id.
        Returns:
        the cloudId value.

      • cloudManagementEndpoint

        String cloudManagementEndpoint()
        Gets the cloudManagementEndpoint property: Endpoint configured for management from the Azure portal.
        Returns:
        the cloudManagementEndpoint value.

      • aadClientId

        String aadClientId()
        Gets the aadClientId property: App id of cluster AAD identity.
        Returns:
        the aadClientId value.

      • aadTenantId

        String aadTenantId()
        Gets the aadTenantId property: Tenant id of cluster AAD identity.
        Returns:
        the aadTenantId value.

      • aadApplicationObjectId

        String aadApplicationObjectId()
        Gets the aadApplicationObjectId property: Object id of cluster AAD identity.
        Returns:
        the aadApplicationObjectId value.

      • aadServicePrincipalObjectId

        String aadServicePrincipalObjectId()
        Gets the aadServicePrincipalObjectId property: Id of cluster identity service principal.
        Returns:
        the aadServicePrincipalObjectId value.

      • desiredProperties

        ClusterDesiredProperties desiredProperties()
        Gets the desiredProperties property: Desired properties of the cluster.
        Returns:
        the desiredProperties value.

      • reportedProperties

        ClusterReportedProperties reportedProperties()
        Gets the reportedProperties property: Properties reported by cluster agent.
        Returns:
        the reportedProperties value.

      • trialDaysRemaining

        Float trialDaysRemaining()
        Gets the trialDaysRemaining property: Number of days remaining in the trial period.
        Returns:
        the trialDaysRemaining value.

      • billingModel

        String billingModel()
        Gets the billingModel property: Type of billing applied to the resource.
        Returns:
        the billingModel value.

      • registrationTimestamp

        OffsetDateTime registrationTimestamp()
        Gets the registrationTimestamp property: First cluster sync timestamp.
        Returns:
        the registrationTimestamp value.

      • lastSyncTimestamp

        OffsetDateTime lastSyncTimestamp()
        Gets the lastSyncTimestamp property: Most recent cluster sync timestamp.
        Returns:
        the lastSyncTimestamp value.

      • lastBillingTimestamp

        OffsetDateTime lastBillingTimestamp()
        Gets the lastBillingTimestamp property: Most recent billing meter timestamp.
        Returns:
        the lastBillingTimestamp value.

      • serviceEndpoint

        String serviceEndpoint()
        Gets the serviceEndpoint property: Region specific DataPath Endpoint of the cluster.
        Returns:
        the serviceEndpoint 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

        ClusterInner innerModel()
        Gets the inner com.azure.resourcemanager.azurestackhci.fluent.models.ClusterInner object.
        Returns:
        the inner object.

      • update

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

      • refresh

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

      • refresh

        Cluster 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.

      • uploadCertificate

        void uploadCertificate​(UploadCertificateRequest uploadCertificateRequest)
        Upload certificate.
        Parameters:
        uploadCertificateRequest - Upload certificate request.
        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.

      • uploadCertificate

        void uploadCertificate​(UploadCertificateRequest uploadCertificateRequest,
                       com.azure.core.util.Context context)
        Upload certificate.
        Parameters:
        uploadCertificateRequest - Upload certificate request.
        context - The context to associate with this operation.
        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.

      • createIdentity

        ClusterIdentityResponse createIdentity()
        Create cluster identity.
        Returns:
        cluster Identity details.
        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.

      • createIdentity

        ClusterIdentityResponse createIdentity​(com.azure.core.util.Context context)
        Create cluster identity.
        Parameters:
        context - The context to associate with this operation.
        Returns:
        cluster Identity details.
        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.