CertificateOperationPollOperation | @azure/keyvault-certificates

An interface representing the active operation of a certificate's creation, which is represented locally as the "operation" of an active LRO Poller.

Hierarchy

KeyVaultCertificatePollOperation<CertificateOperationState, KeyVaultCertificateWithPolicy>
- CertificateOperationPollOperation

Implements

Index

Constructors

constructor

Properties

state

Methods

Constructors

constructor

new CertificateOperationPollOperation(state: CertificateOperationState, vaultUrl: string, client: KeyVaultClient, operationOptions?: OperationOptions): CertificateOperationPollOperation

Overrides KeyVaultCertificatePollOperation.constructor
- Defined in keyvault-certificates/src/lro/operation/operation.ts:43
Parameters
- state: CertificateOperationState
- vaultUrl: string
- client: KeyVaultClient
- Default value operationOptions: OperationOptions = {}
Returns CertificateOperationPollOperation

Properties

state

state: CertificateOperationState

Methods

cancel

cancel(this: CertificateOperationPollOperation, options?: { abortSignal?: AbortSignal }): Promise<CertificateOperationPollOperation>

Overrides KeyVaultCertificatePollOperation.cancel
- Defined in keyvault-certificates/src/lro/operation/operation.ts:158
Reaches to the service and cancels the certificate's operation, also updating the poll operation.

Parameters
- this: CertificateOperationPollOperation
- Default value options: { abortSignal?: AbortSignal } = {}
  - Optional abortSignal?: AbortSignal
Returns Promise<CertificateOperationPollOperation>

toString

toString(): string

Overrides KeyVaultCertificatePollOperation.toString
- Defined in keyvault-certificates/src/lro/operation/operation.ts:181
Serializes the certificate's poll operation

Returns string

update

update(options?: { abortSignal?: AbortSignalLike; fireProgress?: undefined | ((state: CertificateOperationState) => void) }): Promise<CertificateOperationPollOperation>

Overrides KeyVaultCertificatePollOperation.update
- Defined in keyvault-certificates/src/lro/operation/operation.ts:117
Reaches to the service and updates the poll operation.

Parameters
- Default value options: { abortSignal?: AbortSignalLike; fireProgress?: undefined | ((state: CertificateOperationState) => void) } = {}
  - Optional abortSignal?: AbortSignalLike
  - Optional fireProgress?: undefined | ((state: CertificateOperationState) => void)
Returns Promise<CertificateOperationPollOperation>

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

state: CertificateOperationState

vaultUrl: string

client: KeyVaultClient

Default value operationOptions: OperationOptions = {}

Returns CertificateOperationPollOperation

Properties

state

Methods

cancel

Parameters

this: CertificateOperationPollOperation

Default value options: { abortSignal?: AbortSignal } = {}

Optional abortSignal?: AbortSignal

Returns Promise<CertificateOperationPollOperation>

toString

Returns string

update

Parameters

Default value options: { abortSignal?: AbortSignalLike; fireProgress?: undefined | ((state: CertificateOperationState) => void) } = {}

Optional abortSignal?: AbortSignalLike

Optional fireProgress?: undefined | ((state: CertificateOperationState) => void)

Returns Promise<CertificateOperationPollOperation>