CertificateOperation Class

A certificate operation is returned in case of long running requests.

Constructor

CertificateOperation(cert_operation_id: str | None = None, issuer_name: str | WellKnownIssuerNames | None = None, certificate_type: str | None = None, certificate_transparency: bool | None = False, csr: bytes | None = None, cancellation_requested: bool | None = False, status: str | None = None, status_details: str | None = None, error: CertificateOperationError | None = None, target: str | None = None, request_id: str | None = None)

Parameters

Name	Description
cert_operation_id	str or None The certificate id. Default value: None
issuer_name	str or WellKnownIssuerNames or None Name of the operation's issuer object or reserved names. Default value: None
certificate_type	str or None Type of certificate requested from the issuer provider. Default value: None
certificate_transparency	bool or None Indicates if the certificate this operation is running for is published to certificate transparency logs. Defaults to False. Default value: False
csr	bytes or None The certificate signing request (CSR) that is being used in the certificate operation. Default value: None
cancellation_requested	bool or None Indicates if cancellation was requested on the certificate operation. Defaults to False. Default value: False
status	str or None Status of the certificate operation. Default value: None
status_details	str or None The status details of the certificate operation Default value: None
error	CertificateOperationError or None Error encountered, if any, during the certificate operation. Default value: None
target	str or None Location which contains the result of the certificate operation. Default value: None
request_id	str or None Identifier for the certificate operation. Default value: None

Attributes

cancellation_requested

Whether cancellation was requested on the certificate operation.

Returns

Type	Description
bool, None	True if cancellation was requested; False otherwise.

certificate_transparency

Whether certificates generated under this policy should be published to certificate transparency logs.

Returns

Type	Description
bool, None	True if the certificates should be published to transparency logs; False otherwise.

certificate_type

Type of certificate to be requested from the issuer provider.

Returns

Type	Description
str, None	Type of certificate to be requested from the issuer provider.

csr

The certificate signing request that is being used in this certificate operation.

Returns

Type	Description
bytes, None	The certificate signing request that is being used in this certificate operation.

error

Any error associated with the certificate operation.

Returns

Type	Description
CertificateOperationError, None	Any error associated with the operation, as a CertificateOperationError.

id

The certificate ID.

Returns

Type	Description
str, None	The certificate ID.

issuer_name

The name of the certificate issuer.

Returns

Type	Description
str, WellKnownIssuerNames, None	The name of the certificate issuer.

name

The certificate name.

Returns

Type	Description
str, None	The certificate name.

request_id

Identifier for the certificate operation.

Returns

Type	Description
str, None	Identifier for the certificate operation.

status

The operation status.

Returns

Type	Description
str, None	The operation status.

status_details

Details of the operation status.

Returns

Type	Description
str, None	Details of the operation status.

target

Location which contains the result of the certificate operation.

Returns

Type	Description
str, None	Location which contains the result of the certificate operation.

vault_url

URL of the vault performing the certificate operation.

Returns

Type	Description
str, None	URL of the vault performing the certificate operation.