CertificateOperationState interface

  • Reference
Package:
@azure/keyvault-certificates

An interface representing the publicly available properties of the state of the CertificateOperationPoller.

Extends

KeyVaultCertificatePollOperationState<KeyVaultCertificateWithPolicy>

Properties

certificateOperation

The operation of the certificate

Inherited Properties

certificateName

The name of the certificate.
error

Will exist if the operation encountered any error.
isCancelled

True if the operation has been cancelled.
isCompleted

True if the operation has been completed.
isStarted

True if the operation has started.
result

Will exist if the operation concluded in a result of an expected type.

Property Details

certificateOperation

The operation of the certificate

certificateOperation?: CertificateOperation

Property Value

CertificateOperation

Inherited Property Details

certificateName

The name of the certificate.

certificateName: string

Property Value

string

Inherited From KeyVaultCertificatePollOperationState.certificateName

error

Will exist if the operation encountered any error.

error?: Error

Property Value

Error

Inherited From KeyVaultCertificatePollOperationState.error

isCancelled

True if the operation has been cancelled.

isCancelled?: boolean

Property Value

boolean

Inherited From KeyVaultCertificatePollOperationState.isCancelled

isCompleted

True if the operation has been completed.

isCompleted?: boolean

Property Value

boolean

Inherited From KeyVaultCertificatePollOperationState.isCompleted

isStarted

True if the operation has started.

isStarted?: boolean

Property Value

boolean

Inherited From KeyVaultCertificatePollOperationState.isStarted

result

Will exist if the operation concluded in a result of an expected type.

result?: KeyVaultCertificateWithPolicy

Property Value

KeyVaultCertificateWithPolicy

Inherited From KeyVaultCertificatePollOperationState.result