Package com.azure.resourcemanager.batch.models

Interface Certificate

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

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

    • etag

      String etag()
      Gets the etag property: The ETag of the resource, used for concurrency statements.
      Returns:
      the etag value.

    • provisioningState

      CertificateProvisioningState provisioningState()
      Gets the provisioningState property: The provisioningState property.
      Returns:
      the provisioningState value.

    • provisioningStateTransitionTime

      OffsetDateTime provisioningStateTransitionTime()
      Gets the provisioningStateTransitionTime property: The time at which the certificate entered its current state.
      Returns:
      the provisioningStateTransitionTime value.

    • previousProvisioningState

      CertificateProvisioningState previousProvisioningState()
      Gets the previousProvisioningState property: The previous provisioned state of the resource.
      Returns:
      the previousProvisioningState value.

    • previousProvisioningStateTransitionTime

      OffsetDateTime previousProvisioningStateTransitionTime()
      Gets the previousProvisioningStateTransitionTime property: The time at which the certificate entered its previous state.
      Returns:
      the previousProvisioningStateTransitionTime value.

    • publicData

      String publicData()
      Gets the publicData property: The public key of the certificate.
      Returns:
      the publicData value.

    • deleteCertificateError

      DeleteCertificateError deleteCertificateError()
      Gets the deleteCertificateError property: This is only returned when the certificate provisioningState is 'Failed'.
      Returns:
      the deleteCertificateError value.

    • thumbprintAlgorithm

      String thumbprintAlgorithm()
      Gets the thumbprintAlgorithm property: The algorithm of the certificate thumbprint.

      This must match the first portion of the certificate name. Currently required to be 'SHA1'.

      Returns:
      the thumbprintAlgorithm value.

    • thumbprint

      String thumbprint()
      Gets the thumbprint property: The thumbprint of the certificate.

      This must match the thumbprint from the name.

      Returns:
      the thumbprint value.

    • format

      CertificateFormat format()
      Gets the format property: The format of the certificate - either Pfx or Cer. If omitted, the default is Pfx.
      Returns:
      the format value.

    • resourceGroupName

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

    • innerModel

      CertificateInner innerModel()
      Gets the inner com.azure.resourcemanager.batch.fluent.models.CertificateInner object.
      Returns:
      the inner object.

    • update

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

    • refresh

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

    • refresh

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

    • cancelDeletionWithResponse

      com.azure.core.http.rest.Response<Certificate> cancelDeletionWithResponse(com.azure.core.util.Context context)
      Cancels a failed deletion of a certificate from the specified account.

      If you try to delete a certificate that is being used by a pool or compute node, the status of the certificate changes to deleteFailed. If you decide that you want to continue using the certificate, you can use this operation to set the status of the certificate back to active. If you intend to delete the certificate, you do not need to run this operation after the deletion failed. You must make sure that the certificate is not being used by any resources, and then you can try again to delete the certificate.

      Warning: This operation is deprecated and will be removed after February, 2024. Please use the [Azure KeyVault Extension](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide) instead.

      Parameters:
      context - The context to associate with this operation.
      Returns:
      contains information about a certificate.
      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.

    • cancelDeletion

      Certificate cancelDeletion()
      Cancels a failed deletion of a certificate from the specified account.

      If you try to delete a certificate that is being used by a pool or compute node, the status of the certificate changes to deleteFailed. If you decide that you want to continue using the certificate, you can use this operation to set the status of the certificate back to active. If you intend to delete the certificate, you do not need to run this operation after the deletion failed. You must make sure that the certificate is not being used by any resources, and then you can try again to delete the certificate.

      Warning: This operation is deprecated and will be removed after February, 2024. Please use the [Azure KeyVault Extension](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide) instead.

      Returns:
      contains information about a certificate.
      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.