deleted_certificates

Creates, updates, deletes, gets or lists a deleted_certificates resource.

Overview

Name	deleted_certificates
Type	Resource
Id	azure.key_vault_certificates.deleted_certificates

Fields

The following fields are returned by SELECT queries:

get_deleted_certificate

Name	Datatype	Description
id	string	The certificate id.
attributes	object	The certificate attributes.
cer	string (byte)	CER contents of x509 certificate.
contentType	string	The content type of the secret. eg. 'application/x-pem-file' or 'application/x-pkcs12'.
deletedDate	string (date-time)	The time when the certificate was deleted, in UTC.
kid	string	The key id.
policy	object	The management policy.
preserveCertOrder	boolean	Specifies whether the certificate chain preserves its original order. The default value is false, which sets the leaf certificate at index 0.
recoveryId	string	The url of the recovery object, used to identify and recover the deleted certificate.
scheduledPurgeDate	string (date-time)	The time when the certificate is scheduled to be purged, in UTC.
sid	string	The secret id.
tags	object	Application specific metadata in the form of key-value pairs.
x5t	string (byte)	Thumbprint of the certificate.

get_deleted_certificates

Name	Datatype	Description
id	string	Certificate identifier.
attributes	object	The certificate management attributes.
deletedDate	string (date-time)	The time when the certificate was deleted, in UTC.
recoveryId	string	The url of the recovery object, used to identify and recover the deleted certificate.
scheduledPurgeDate	string (date-time)	The time when the certificate is scheduled to be purged, in UTC.
tags	object	Application specific metadata in the form of key-value pairs.
x5t	string (byte)	Thumbprint of the certificate.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_deleted_certificate	select	certificate_name, vault_name		Retrieves information about the specified deleted certificate. The GetDeletedCertificate operation retrieves the deleted certificate information plus its attributes, such as retention interval, scheduled permanent deletion and the current deletion recovery level. This operation requires the certificates/get permission.
get_deleted_certificates	select	vault_name	maxresults, includePending	Lists the deleted certificates in the specified vault currently available for recovery. The GetDeletedCertificates operation retrieves the certificates in the current vault which are in a deleted state and ready for recovery or purging. This operation includes deletion-specific information. This operation requires the certificates/get/list permission. This operation can only be enabled on soft-delete enabled vaults.
purge_deleted_certificate	delete	certificate_name, vault_name		Permanently deletes the specified deleted certificate. The PurgeDeletedCertificate operation performs an irreversible deletion of the specified certificate, without possibility for recovery. The operation is not available if the recovery level does not specify 'Purgeable'. This operation requires the certificate/purge permission.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
certificate_name	string	The name of the certificate. Required.
vault_name	string	Key vault name. (default: )
includePending	boolean	Specifies whether to include certificates which are not completely provisioned. Default value is None.
maxresults	integer	Maximum number of results to return in a page. If not specified the service will return up to 25 results. Default value is None.

SELECT examples

get_deleted_certificate

Retrieves information about the specified deleted certificate. The GetDeletedCertificate operation retrieves the deleted certificate information plus its attributes, such as retention interval, scheduled permanent deletion and the current deletion recovery level. This operation requires the certificates/get permission.

SELECT
id,
attributes,
cer,
contentType,
deletedDate,
kid,
policy,
preserveCertOrder,
recoveryId,
scheduledPurgeDate,
sid,
tags,
x5t
FROM azure.key_vault_certificates.deleted_certificates
WHERE certificate_name = '{{ certificate_name }}' -- required
AND vault_name = '{{ vault_name }}' -- required
;

get_deleted_certificates

Lists the deleted certificates in the specified vault currently available for recovery. The GetDeletedCertificates operation retrieves the certificates in the current vault which are in a deleted state and ready for recovery or purging. This operation includes deletion-specific information. This operation requires the certificates/get/list permission. This operation can only be enabled on soft-delete enabled vaults.

SELECT
id,
attributes,
deletedDate,
recoveryId,
scheduledPurgeDate,
tags,
x5t
FROM azure.key_vault_certificates.deleted_certificates
WHERE vault_name = '{{ vault_name }}' -- required
AND maxresults = '{{ maxresults }}'
AND includePending = '{{ includePending }}'
;

DELETE examples

purge_deleted_certificate

Permanently deletes the specified deleted certificate. The PurgeDeletedCertificate operation performs an irreversible deletion of the specified certificate, without possibility for recovery. The operation is not available if the recovery level does not specify 'Purgeable'. This operation requires the certificate/purge permission.

DELETE FROM azure.key_vault_certificates.deleted_certificates
WHERE certificate_name = '{{ certificate_name }}' --required
AND vault_name = '{{ vault_name }}' --required
;