@azure/keyvault-common

Index

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

mappings

Type aliases

ParsedWWWAuthenticate

ParsedWWWAuthenticate: {}

Type declaration

RoleAssignmentScope

RoleAssignmentScope: "/" | "/keys" | string

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

SUPPORTED_API_VERSIONS

SUPPORTED_API_VERSIONS: "7.2-preview"

Supported API versions

ValidParsedWWWAuthenticateProperties

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

Variables

Const LATEST_API_VERSION

LATEST_API_VERSION: "7.2-preview" = "7.2-preview"

The latest supported Key Vault service API version.

Const SDK_VERSION

SDK_VERSION: string = "4.0.0-beta.1"

Current version of the Key Vault Admin SDK.

Const logger

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

The @azure/logger configuration for this package.

Functions

cancel

cancel(this: BackupPollOperation): Promise<BackupPollOperation>

- Defined in keyvault-admin/src/lro/backup/operation.ts:224
summary

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

Parameters
- this: BackupPollOperation
Returns Promise<BackupPollOperation>

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

fullBackup

fullBackup(client: KeyVaultClient, vaultUrl: string, options: KeyVaultClientFullBackupOptionalParams): Promise<KeyVaultClientFullBackupResponse>

- Defined in keyvault-admin/src/lro/backup/operation.ts:97
Tracing the fullBackup operation

Parameters
- client: KeyVaultClient
- vaultUrl: string
- options: KeyVaultClientFullBackupOptionalParams
Returns Promise<KeyVaultClientFullBackupResponse>

fullBackupStatus

fullBackupStatus(client: KeyVaultClient, vaultUrl: string, jobId: string, options: BeginBackupOptions): Promise<KeyVaultClientFullBackupStatusResponse>

- Defined in keyvault-admin/src/lro/backup/operation.ts:113
Tracing the fullBackupStatus operation

Parameters
- client: KeyVaultClient
- vaultUrl: string
- jobId: string
- options: BeginBackupOptions
Returns Promise<KeyVaultClientFullBackupStatusResponse>

fullRestore

fullRestore(client: KeyVaultClient, vaultUrl: string, options: KeyVaultClientFullRestoreOperationOptionalParams): Promise<KeyVaultClientFullRestoreOperationResponse>

- Defined in keyvault-admin/src/lro/restore/operation.ts:100
Tracing the fullRestore operation

Parameters
- client: KeyVaultClient
- vaultUrl: string
- options: KeyVaultClientFullRestoreOperationOptionalParams
Returns Promise<KeyVaultClientFullRestoreOperationResponse>

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

restoreStatus

restoreStatus(client: KeyVaultClient, vaultUrl: string, jobId: string, options: OperationOptions): Promise<KeyVaultClientRestoreStatusResponse>

- Defined in keyvault-admin/src/lro/restore/operation.ts:116
Tracing the restoreStatus operation.

Parameters
- client: KeyVaultClient
- vaultUrl: string
- jobId: string
- options: OperationOptions
Returns Promise<KeyVaultClientRestoreStatusResponse>

selectiveRestore

selectiveRestore(client: KeyVaultClient, vaultUrl: string, keyName: string, options: KeyVaultClientSelectiveKeyRestoreOperationOptionalParams): Promise<KeyVaultClientSelectiveKeyRestoreOperationResponse>

- Defined in keyvault-admin/src/lro/selectiveRestore/operation.ts:109
Tracing the selectiveRestore operation

Parameters
- client: KeyVaultClient
- vaultUrl: string
- keyName: string
- options: KeyVaultClientSelectiveKeyRestoreOperationOptionalParams
Returns Promise<KeyVaultClientSelectiveKeyRestoreOperationResponse>

toString

toString(this: BackupPollOperation): string

- Defined in keyvault-admin/src/lro/backup/operation.ts:231
summary

Serializes the create key's poll operation

Parameters
- this: BackupPollOperation
Returns string

update

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

- Defined in keyvault-admin/src/lro/backup/operation.ts:131
summary

Reaches to the service and updates the backup's poll operation.

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

Object literals

Const mappings

mappings: object

roleAssignment

roleAssignment: object

generatedToPublic

generatedToPublic(roleAssignment: RoleAssignment): KeyVaultRoleAssignment

- Defined in keyvault-admin/src/mappings.ts:13
Parameters
- roleAssignment: RoleAssignment
Returns KeyVaultRoleAssignment

roleDefinition

roleDefinition: object

generatedToPublic

generatedToPublic(roleDefinition: RoleDefinition): KeyVaultRoleDefinition

- Defined in keyvault-admin/src/mappings.ts:29
Parameters
- roleDefinition: RoleDefinition
Returns KeyVaultRoleDefinition

Index

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

ParsedWWWAuthenticate

Type declaration

RoleAssignmentScope

SUPPORTED_API_VERSIONS

ValidParsedWWWAuthenticateProperties

Variables

Const LATEST_API_VERSION

Const SDK_VERSION

Const logger

Functions

cancel

Parameters

this: BackupPollOperation

Returns Promise<BackupPollOperation>

challengeBasedAuthenticationPolicy

Parameters

credential: TokenCredential

Returns RequestPolicyFactory

fullBackup

Parameters

client: KeyVaultClient

vaultUrl: string

options: KeyVaultClientFullBackupOptionalParams

Returns Promise<KeyVaultClientFullBackupResponse>

fullBackupStatus

Parameters

client: KeyVaultClient

vaultUrl: string

jobId: string

options: BeginBackupOptions

Returns Promise<KeyVaultClientFullBackupStatusResponse>

fullRestore

Parameters

client: KeyVaultClient

vaultUrl: string

options: KeyVaultClientFullRestoreOperationOptionalParams

Returns Promise<KeyVaultClientFullRestoreOperationResponse>

makeBackupPollOperation

Parameters

state: BackupPollOperationState

Returns BackupPollOperation

makeRestorePollOperation

Parameters

state: RestorePollOperationState

Returns RestorePollOperation

makeSelectiveRestorePollOperation

Parameters

state: SelectiveRestorePollOperationState

Returns SelectiveRestorePollOperation

parseWWWAuthenticate

Parameters

wwwAuthenticate: string

Returns ParsedWWWAuthenticate

restoreStatus

Parameters

client: KeyVaultClient

vaultUrl: string

jobId: string

options: OperationOptions

Returns Promise<KeyVaultClientRestoreStatusResponse>

selectiveRestore

Parameters

client: KeyVaultClient

vaultUrl: string

keyName: string

options: KeyVaultClientSelectiveKeyRestoreOperationOptionalParams

Returns Promise<KeyVaultClientSelectiveKeyRestoreOperationResponse>

toString

Parameters

this: BackupPollOperation

Returns string

update