@azure/keyvault-secrets

Index

Classes

Type aliases

Variables

Functions

Type aliases

ParsedWWWAuthenticate

ParsedWWWAuthenticate: {}

Type declaration

ValidParsedWWWAuthenticateProperties

ValidParsedWWWAuthenticateProperties: "authorization" | "resource" | "scope"

Variables

Const LATEST_API_VERSION

LATEST_API_VERSION: "7.1" = "7.1"

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): Promise<DeleteSecretPollOperation>

- Defined in keyvault-secrets/src/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
Returns Promise<DeleteSecretPollOperation>

challengeBasedAuthenticationPolicy

challengeBasedAuthenticationPolicy(credential: TokenCredential): RequestPolicyFactory

- Defined in keyvault-common/src/challengeBasedAuthenticationPolicy.ts:67
Creates a new ChallengeBasedAuthenticationPolicy factory.

Parameters
- credential: TokenCredential
  
  The TokenCredential implementation that can supply the challenge token.
Returns RequestPolicyFactory

makeDeleteSecretPollOperation

makeDeleteSecretPollOperation(state: DeleteSecretPollOperationState): DeleteSecretPollOperation

- Defined in keyvault-secrets/src/lro/delete/operation.ts:100
summary

Builds a create secret's poll operation

Parameters
- state: DeleteSecretPollOperationState
Returns DeleteSecretPollOperation

makeRecoverDeletedSecretPollOperation

makeRecoverDeletedSecretPollOperation(state: RecoverDeletedSecretPollOperationState): RecoverDeletedSecretPollOperation

- Defined in keyvault-secrets/src/lro/recover/operation.ts:107
summary

Builds a create secret's poll operation

Parameters
- state: RecoverDeletedSecretPollOperationState
Returns RecoverDeletedSecretPollOperation

parseWWWAuthenticate

parseWWWAuthenticate(wwwAuthenticate: string): ParsedWWWAuthenticate

- Defined in keyvault-common/src/challengeBasedAuthenticationPolicy.ts:93
Parses an WWW-Authenticate response. This transforms a string value like: Bearer authorization="some_authorization", resource="https://some.url" into an object like: { authorization: "some_authorization", resource: "https://some.url" }

Parameters
- wwwAuthenticate: string
  
  string value in the WWW-Authenticate header
Returns ParsedWWWAuthenticate

toString

toString(this: DeleteSecretPollOperation): string

- Defined in keyvault-secrets/src/lro/delete/operation.ts:90
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 keyvault-secrets/src/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>

Index

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

ParsedWWWAuthenticate

Type declaration

ValidParsedWWWAuthenticateProperties

Variables

Const LATEST_API_VERSION

Const logger

Functions

cancel

Parameters

this: DeleteSecretPollOperation

Returns Promise<DeleteSecretPollOperation>

challengeBasedAuthenticationPolicy

Parameters

credential: TokenCredential

Returns RequestPolicyFactory

makeDeleteSecretPollOperation

Parameters

state: DeleteSecretPollOperationState

Returns DeleteSecretPollOperation

makeRecoverDeletedSecretPollOperation

Parameters

state: RecoverDeletedSecretPollOperationState

Returns RecoverDeletedSecretPollOperation

parseWWWAuthenticate

Parameters

wwwAuthenticate: string

Returns ParsedWWWAuthenticate

toString

Parameters

this: DeleteSecretPollOperation

Returns string

update

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>