@azure/keyvault-secrets

Package version

Index

Classes

Interfaces

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 SDK_VERSION

SDK_VERSION: string = "4.2.0-beta.2"

Const logger

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

The @azure/logger configuration for this package.

Functions

challengeBasedAuthenticationPolicy

challengeBasedAuthenticationPolicy(credential: TokenCredential): RequestPolicyFactory

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

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

createSpan

createSpan(methodName: string, requestOptions?: RequestOptionsBase): Span

- Defined in keyvault-common/src/tracing.ts:13
Creates a span using the tracer that was set by the user

Parameters
- methodName: string
  
  The name of the method creating the span.
- Default value requestOptions: RequestOptionsBase = {}
Returns Span

getSecretFromSecretBundle

getSecretFromSecretBundle(bundle: SecretBundle | DeletedSecretBundle): KeyVaultSecret

- Defined in keyvault-secrets/src/transformations.ts:12
internal

Shapes the exposed {@link KeyVaultKey} based on either a received secret bundle or deleted secret bundle.

Parameters
- bundle: SecretBundle | DeletedSecretBundle
Returns KeyVaultSecret

parseKeyVaultSecretId

parseKeyVaultSecretId(id: string): KeyVaultSecretId

- Defined in keyvault-secrets/src/identifier.ts:51
Parses the given Key Vault Secret Id. An example is:

https://.vault.azure.net/secrets//

On parsing the above Id, this function returns:
```
  {
     sourceId: "https://<keyvault-name>.vault.azure.net/secrets/<secret-name>/<unique-version-id>",
     vaultUrl: "https://<keyvault-name>.vault.azure.net",
     version: "<unique-version-id>",
     name: "<secret-name>"
  }
```
internal
Parameters
- id: string
  
  The Id of the Key Vault Secret.
Returns KeyVaultSecretId

parseKeyvaultIdentifier

parseKeyvaultIdentifier(collection: string, identifier: string | undefined): ParsedKeyVaultEntityIdentifier

- Defined in keyvault-common/src/parseKeyvaultIdentifier.ts:20
Parameters
- collection: string
- identifier: string | undefined
Returns ParsedKeyVaultEntityIdentifier

parseWWWAuthenticate

parseWWWAuthenticate(wwwAuthenticate: string): ParsedWWWAuthenticate

- Defined in keyvault-common/src/challengeBasedAuthenticationPolicy.ts:94
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

setParentSpan

setParentSpan(span: Span, options?: RequestOptionsBase): RequestOptionsBase

- Defined in keyvault-common/src/tracing.ts:26
Returns updated HTTP options with the given span as the parent of future spans, if applicable.

Parameters
- span: Span
  
  The span for the current operation.
- Default value options: RequestOptionsBase = {}
  
  The options for the underlying HTTP request.
Returns RequestOptionsBase

Generated using TypeDoc