Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/keyvault-common

Package version

Index

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

BackupOperationState

BackupOperationState: KeyVaultAdminPollOperationState<BackupResult>

An interface representing the publicly available properties of the state of a backup Key Vault's poll operation.

KeyVaultDataAction

KeyVaultDataAction: "Microsoft.KeyVault/managedHsm/keys/read/action" | "Microsoft.KeyVault/managedHsm/keys/write/action" | "Microsoft.KeyVault/managedHsm/keys/deletedKeys/read/action" | "Microsoft.KeyVault/managedHsm/keys/deletedKeys/recover/action" | "Microsoft.KeyVault/managedHsm/keys/backup/action" | "Microsoft.KeyVault/managedHsm/keys/restore/action" | "Microsoft.KeyVault/managedHsm/roleAssignments/delete/action" | "Microsoft.KeyVault/managedHsm/roleAssignments/read/action" | "Microsoft.KeyVault/managedHsm/roleAssignments/write/action" | "Microsoft.KeyVault/managedHsm/roleDefinitions/read/action" | "Microsoft.KeyVault/managedHsm/keys/encrypt/action" | "Microsoft.KeyVault/managedHsm/keys/decrypt/action" | "Microsoft.KeyVault/managedHsm/keys/wrap/action" | "Microsoft.KeyVault/managedHsm/keys/unwrap/action" | "Microsoft.KeyVault/managedHsm/keys/sign/action" | "Microsoft.KeyVault/managedHsm/keys/verify/action" | "Microsoft.KeyVault/managedHsm/keys/create" | "Microsoft.KeyVault/managedHsm/keys/delete" | "Microsoft.KeyVault/managedHsm/keys/export/action" | "Microsoft.KeyVault/managedHsm/keys/import/action" | "Microsoft.KeyVault/managedHsm/keys/deletedKeys/delete" | "Microsoft.KeyVault/managedHsm/securitydomain/download/action" | "Microsoft.KeyVault/managedHsm/securitydomain/upload/action" | "Microsoft.KeyVault/managedHsm/securitydomain/upload/read" | "Microsoft.KeyVault/managedHsm/securitydomain/transferkey/read" | "Microsoft.KeyVault/managedHsm/backup/start/action" | "Microsoft.KeyVault/managedHsm/restore/start/action" | "Microsoft.KeyVault/managedHsm/backup/status/action" | "Microsoft.KeyVault/managedHsm/restore/status/action" | string

A union type representing all possible values for both KeyVaultPermission.dataActions and KeyVaultPermission.notDataActions.

KeyVaultRoleScope

KeyVaultRoleScope: "/" | "/keys" | string

A scope of the role assignment or definition. The valid scopes are: "/", "/keys" and any a specific resource Id followed by a slash, as in "ID/".

ParsedWWWAuthenticate

ParsedWWWAuthenticate: {}

Type declaration

SUPPORTED_API_VERSIONS

SUPPORTED_API_VERSIONS: "7.2"

Supported API versions

ValidParsedWWWAuthenticateProperties

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

Variables

Const LATEST_API_VERSION

LATEST_API_VERSION: "7.2" = "7.2"

The latest supported Key Vault service API version.

Const SDK_VERSION

SDK_VERSION: string = "4.0.0-beta.3"

Current version of the Key Vault Admin SDK.

Const logger

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

The @azure/logger configuration for this package.

Const withTrace

withTrace: TracedFunction = createTraceFunction("Azure.KeyVault.Admin.SelectiveRestorePoller")
internal
internal
internal

Functions

challengeBasedAuthenticationPolicy

  • challengeBasedAuthenticationPolicy(credential: TokenCredential): RequestPolicyFactory

cleanState

createTraceFunction

  • Returns a function that can be used for tracing options.

    example

    const withTrace = createTraceFunction("Azure.KeyVault.Certificates.CertificateClient")

    internal

    Parameters

    • prefix: string

      The prefix to use, likely the name of the class / client.

    Returns TracedFunction

parseKeyvaultIdentifier

parseWWWAuthenticate

  • 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

Object literals

Const mappings

mappings: object

roleAssignment

roleAssignment: object

generatedToPublic

roleDefinition

roleDefinition: object

generatedToPublic

Generated using TypeDoc