certificate_operations

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

Overview

Name	certificate_operations
Type	Resource
Id	azure.key_vault_certificates.certificate_operations

Fields

The following fields are returned by SELECT queries:

get_certificate_operation

Name	Datatype	Description
id	string	The certificate id.
request_id	string	Identifier for the certificate operation.
cancellation_requested	boolean	Indicates if cancellation was requested on the certificate operation.
csr	string (byte)	The certificate signing request (CSR) that is being used in the certificate operation.
error	object	Error encountered, if any, during the certificate operation.
issuer	object	Parameters for the issuer of the X509 component of a certificate.
preserveCertOrder	boolean	Specifies whether the certificate chain preserves its original order. The default value is false, which sets the leaf certificate at index 0.
status	string	Status of the certificate operation.
status_details	string	The status details of the certificate operation.
target	string	Location which contains the result of the certificate operation.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_certificate_operation	select	certificate_name, vault_name		Gets the creation operation of a certificate. Gets the creation operation associated with a specified certificate. This operation requires the certificates/get permission.
update_certificate_operation	update	certificate_name, vault_name, cancellation_requested		Updates a certificate operation. Updates a certificate creation operation that is already in progress. This operation requires the certificates/update permission.
delete_certificate_operation	delete	certificate_name, vault_name		Deletes the creation operation for a specific certificate. Deletes the creation operation for a specified certificate that is in the process of being created. The certificate is no longer created. This operation requires the certificates/update 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: )

SELECT examples

get_certificate_operation

Gets the creation operation of a certificate. Gets the creation operation associated with a specified certificate. This operation requires the certificates/get permission.

SELECT
id,
request_id,
cancellation_requested,
csr,
error,
issuer,
preserveCertOrder,
status,
status_details,
target
FROM azure.key_vault_certificates.certificate_operations
WHERE certificate_name = '{{ certificate_name }}' -- required
AND vault_name = '{{ vault_name }}' -- required
;

UPDATE examples

update_certificate_operation

Updates a certificate operation. Updates a certificate creation operation that is already in progress. This operation requires the certificates/update permission.

UPDATE azure.key_vault_certificates.certificate_operations
SET 
cancellation_requested = {{ cancellation_requested }}
WHERE 
certificate_name = '{{ certificate_name }}' --required
AND vault_name = '{{ vault_name }}' --required
AND cancellation_requested = {{ cancellation_requested }} --required
RETURNING
id,
request_id,
cancellation_requested,
csr,
error,
issuer,
preserveCertOrder,
status,
status_details,
target;

DELETE examples

delete_certificate_operation

Deletes the creation operation for a specific certificate. Deletes the creation operation for a specified certificate that is in the process of being created. The certificate is no longer created. This operation requires the certificates/update permission.

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