Share via


Certificate Interface

public interface Certificate

An immutable client-side representation of Certificate.

Method Summary

Modifier and Type Method and Description
abstract Certificate cancelDeletion()

Cancels a failed deletion of a certificate from the specified account.

abstract Response<Certificate> cancelDeletionWithResponse(Context context)

Cancels a failed deletion of a certificate from the specified account.

abstract DeleteCertificateError deleteCertificateError()

Gets the deleteCertificateError property: This is only returned when the certificate provisioningState is 'Failed'.

abstract String etag()

Gets the etag property: The ETag of the resource, used for concurrency statements.

abstract CertificateFormat format()

Gets the format property: The format of the certificate - either Pfx or Cer.

abstract String id()

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

abstract CertificateInner innerModel()

Gets the inner com.azure.resourcemanager.batch.fluent.models.CertificateInner object.

abstract String name()

Gets the name property: The name of the resource.

abstract CertificateProvisioningState previousProvisioningState()

Gets the previousProvisioningState property: The previous provisioned state of the resource.

abstract OffsetDateTime previousProvisioningStateTransitionTime()

Gets the previousProvisioningStateTransitionTime property: The time at which the certificate entered its previous state.

abstract CertificateProvisioningState provisioningState()

Gets the provisioningState property: The provisioningState property.

abstract OffsetDateTime provisioningStateTransitionTime()

Gets the provisioningStateTransitionTime property: The time at which the certificate entered its current state.

abstract String publicData()

Gets the publicData property: The public key of the certificate.

abstract Certificate refresh()

Refreshes the resource to sync with Azure.

abstract Certificate refresh(Context context)

Refreshes the resource to sync with Azure.

abstract String resourceGroupName()

Gets the name of the resource group.

abstract Map<String,String> tags()

Gets the tags property: The tags of the resource.

abstract String thumbprint()

Gets the thumbprint property: This must match the thumbprint from the name.

abstract String thumbprintAlgorithm()

Gets the thumbprintAlgorithm property: This must match the first portion of the certificate name.

abstract String type()

Gets the type property: The type of the resource.

abstract Update update()

Begins update for the Certificate resource.

Method Details

cancelDeletion

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

cancelDeletionWithResponse

public abstract Response<Certificate> cancelDeletionWithResponse(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.

deleteCertificateError

public abstract DeleteCertificateError deleteCertificateError()

Gets the deleteCertificateError property: This is only returned when the certificate provisioningState is 'Failed'.

Returns:

the deleteCertificateError value.

etag

public abstract String etag()

Gets the etag property: The ETag of the resource, used for concurrency statements.

Returns:

the etag value.

format

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

id

public abstract String id()

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

Returns:

the id value.

innerModel

public abstract CertificateInner innerModel()

Gets the inner com.azure.resourcemanager.batch.fluent.models.CertificateInner object.

Returns:

the inner object.

name

public abstract String name()

Gets the name property: The name of the resource.

Returns:

the name value.

previousProvisioningState

public abstract CertificateProvisioningState previousProvisioningState()

Gets the previousProvisioningState property: The previous provisioned state of the resource.

Returns:

the previousProvisioningState value.

previousProvisioningStateTransitionTime

public abstract OffsetDateTime previousProvisioningStateTransitionTime()

Gets the previousProvisioningStateTransitionTime property: The time at which the certificate entered its previous state.

Returns:

the previousProvisioningStateTransitionTime value.

provisioningState

public abstract CertificateProvisioningState provisioningState()

Gets the provisioningState property: The provisioningState property.

Returns:

the provisioningState value.

provisioningStateTransitionTime

public abstract OffsetDateTime provisioningStateTransitionTime()

Gets the provisioningStateTransitionTime property: The time at which the certificate entered its current state.

Returns:

the provisioningStateTransitionTime value.

publicData

public abstract String publicData()

Gets the publicData property: The public key of the certificate.

Returns:

the publicData value.

refresh

public abstract Certificate refresh()

Refreshes the resource to sync with Azure.

Returns:

the refreshed resource.

refresh

public abstract Certificate refresh(Context context)

Refreshes the resource to sync with Azure.

Parameters:

context - The context to associate with this operation.

Returns:

the refreshed resource.

resourceGroupName

public abstract String resourceGroupName()

Gets the name of the resource group.

Returns:

the name of the resource group.

tags

public abstract Map<String,String> tags()

Gets the tags property: The tags of the resource.

Returns:

the tags value.

thumbprint

public abstract String thumbprint()

Gets the thumbprint property: This must match the thumbprint from the name.

Returns:

the thumbprint value.

thumbprintAlgorithm

public abstract String thumbprintAlgorithm()

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

Returns:

the thumbprintAlgorithm value.

type

public abstract String type()

Gets the type property: The type of the resource.

Returns:

the type value.

update

public abstract Certificate.Update update()

Begins update for the Certificate resource.

Returns:

the stage of resource update.

Applies to