@azure/keyvault-keys

Index

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

EncryptionAlgorithm

EncryptionAlgorithm: "RSA-OAEP" | "RSA-OAEP-256" | "RSA1_5"

Defines values for EncryptionAlgorithm. Possible values include: 'RSA-OAEP', 'RSA-OAEP-256', 'RSA1_5'

readonly

KeyCurveName

KeyCurveName: "P-256" | "P-384" | "P-521" | "P-256K"

Defines values for KeyCurveName. Possible values include: 'P-256', 'P-384', 'P-521', 'P-256K'

readonly

KeyOperation

Defines values for KeyOperation. Possible values include: 'encrypt', 'decrypt', 'sign', 'verify', 'wrapKey', 'unwrapKey', 'import'

readonly

KeyType

KeyType: "EC" | "EC-HSM" | "RSA" | "RSA-HSM" | "oct"

Defines values for KeyType. Possible values include: 'EC', 'EC-HSM', 'RSA', 'RSA-HSM', 'oct'

readonly

KeyWrapAlgorithm

KeyWrapAlgorithm: "RSA-OAEP" | "RSA-OAEP-256" | "RSA1_5"

Supported algorithms for key wrapping/unwrapping

ParsedWWWAuthenticate

ParsedWWWAuthenticate: {}

Type declaration

SignatureAlgorithm

SignatureAlgorithm: "PS256" | "PS384" | "PS512" | "RS256" | "RS384" | "RS512" | "ES256" | "ES384" | "ES512" | "ES256K"

Defines values for SignatureAlgorithm. Possible values include: 'PS256', 'PS384', 'PS512', 'RS256', 'RS384', 'RS512', 'ES256', 'ES384', 'ES512', 'ES256K'

readonly

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-keys")

The @azure/logger configuration for this package.

Functions

cancel

cancel(this: DeleteKeyPollOperation): Promise<DeleteKeyPollOperation>

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

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

Parameters
- this: DeleteKeyPollOperation
Returns Promise<DeleteKeyPollOperation>

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

makeDeleteKeyPollOperation

makeDeleteKeyPollOperation(state: DeleteKeyPollOperationState): DeleteKeyPollOperation

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

Builds a create key's poll operation

Parameters
- state: DeleteKeyPollOperationState
Returns DeleteKeyPollOperation

makeRecoverDeletedKeyPollOperation

makeRecoverDeletedKeyPollOperation(state: RecoverDeletedKeyPollOperationState): RecoverDeletedKeyPollOperation

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

Builds a create key's poll operation

Parameters
- state: RecoverDeletedKeyPollOperationState
Returns RecoverDeletedKeyPollOperation

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: DeleteKeyPollOperation): string

- Defined in keyvault-keys/src/lro/delete/operation.ts:90
summary

Serializes the create key's poll operation

Parameters
- this: DeleteKeyPollOperation
Returns string

update

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

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

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

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

Index

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

EncryptionAlgorithm

KeyCurveName

KeyOperation

KeyType

KeyWrapAlgorithm

ParsedWWWAuthenticate

Type declaration

SignatureAlgorithm

ValidParsedWWWAuthenticateProperties

Variables

Const LATEST_API_VERSION

Const logger

Functions

cancel

Parameters

this: DeleteKeyPollOperation

Returns Promise<DeleteKeyPollOperation>

challengeBasedAuthenticationPolicy

Parameters

credential: TokenCredential

Returns RequestPolicyFactory

makeDeleteKeyPollOperation

Parameters

state: DeleteKeyPollOperationState

Returns DeleteKeyPollOperation

makeRecoverDeletedKeyPollOperation

Parameters

state: RecoverDeletedKeyPollOperationState

Returns RecoverDeletedKeyPollOperation

parseWWWAuthenticate

Parameters

wwwAuthenticate: string

Returns ParsedWWWAuthenticate

toString

Parameters

this: DeleteKeyPollOperation

Returns string

update

Parameters

this: DeleteKeyPollOperation

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

Optional abortSignal?: AbortSignalLike

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

Returns Promise<DeleteKeyPollOperation>