@azure/keyvault-common package
Interfaces
| AdditionalPolicyConfig |
Used to configure additional policies added to the pipeline at construction. |
| CommonClientOptions |
The common set of options that high level clients are expected to expose. |
| KeepAliveOptions |
Options for keep alive behavior of HTTP connections. |
| KeyVaultAuthenticationPolicyOptions |
Additional options for the challenge based authentication policy. |
| KeyVaultEntityIdentifier |
The parsed components of a Key Vault entity identifier. |
| RedirectOptions |
Options for how redirect responses are handled. |
Type Aliases
| ExtendedCommonClientOptions |
Extended common client options that include keep alive and redirect options. This type combines the standard CommonClientOptions with additional options for controlling HTTP connection keep-alive and redirect behavior. |
Functions
| key |
A custom implementation of the bearer-token authentication policy that handles Key Vault and CAE challenges. Key Vault supports other authentication schemes, but we ensure challenge authentication is used by first sending a copy of the request, without authorization or content. when the challenge is received, it will be authenticated and used to send the original request with authorization. Following the first request of a client, follow-up requests will get the cached token if possible. |
| parse |
Parses a Key Vault identifier into its components. |
Variables
| key |
Name of the Key Vault authentication policy. |
Function Details
keyVaultAuthenticationPolicy(TokenCredential, KeyVaultAuthenticationPolicyOptions)
A custom implementation of the bearer-token authentication policy that handles Key Vault and CAE challenges.
Key Vault supports other authentication schemes, but we ensure challenge authentication is used by first sending a copy of the request, without authorization or content.
when the challenge is received, it will be authenticated and used to send the original request with authorization.
Following the first request of a client, follow-up requests will get the cached token if possible.
function keyVaultAuthenticationPolicy(credential: TokenCredential, options?: KeyVaultAuthenticationPolicyOptions): PipelinePolicyParameters
- credential
- TokenCredential
Returns
parseKeyVaultIdentifier(string, undefined | string)
Parses a Key Vault identifier into its components.
function parseKeyVaultIdentifier(collection: string, identifier: undefined | string): KeyVaultEntityIdentifierParameters
- collection
-
string
The collection of the Key Vault identifier.
- identifier
-
undefined | string
The Key Vault identifier to be parsed.
Returns
Variable Details
keyVaultAuthenticationPolicyName
Name of the Key Vault authentication policy.
keyVaultAuthenticationPolicyName: "keyVaultAuthenticationPolicy"Type
"keyVaultAuthenticationPolicy"