@azure/keyvault-secrets

Package version

Index

Classes

Variables

Functions

Variables

Const LATEST_API_VERSION

LATEST_API_VERSION: "7.1-preview" = "7.1-preview"

The latest supported KeyVault service API version

Const logger

logger: any = createClientLogger("keyvault-secrets")

The @azure/logger configuration for this package.

Functions

cancel

cancel(this: DeleteSecretPollOperation, _?: { abortSignal?: AbortSignal }): Promise<DeleteSecretPollOperation>

- Defined in lro/delete/operation.ts:83
summary

Reaches to the service and cancels the secret's operation, also updating the secret's poll operation

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

makeDeleteSecretPollOperation

makeDeleteSecretPollOperation(state: DeleteSecretPollOperationState): DeleteSecretPollOperation

- Defined in lro/delete/operation.ts:103
summary

Builds a create secret's poll operation

Parameters
- state: DeleteSecretPollOperationState
Returns DeleteSecretPollOperation

makeRecoverDeletedSecretPollOperation

makeRecoverDeletedSecretPollOperation(state: RecoverDeletedSecretPollOperationState): RecoverDeletedSecretPollOperation

- Defined in lro/recover/operation.ts:106
summary

Builds a create secret's poll operation

Parameters
- state: RecoverDeletedSecretPollOperationState
Returns RecoverDeletedSecretPollOperation

toString

toString(this: DeleteSecretPollOperation): string

- Defined in lro/delete/operation.ts:93
summary

Serializes the create secret's poll operation

Parameters
- this: DeleteSecretPollOperation
Returns string

update

update(this: DeleteSecretPollOperation, options?: { abortSignal?: AbortSignalLike; fireProgress?: undefined | ((state: DeleteSecretPollOperationState) => void) }): Promise<DeleteSecretPollOperation>

- Defined in lro/delete/operation.ts:37
summary

Reaches to the service and updates the delete secret's poll operation.

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

Generated using TypeDoc