@azure/keyvault-admin package

The KeyVaultAccessControlClient provides methods to manage access control and role assignments in any given Azure Key Vault instance. The client supports creating, retrieving and deleting roles.

The KeyVaultBackupClient provides methods to generate backups and restore backups of any given Azure Key Vault instance. This client supports generating full backups, selective restores of specific keys and full restores of Key Vault instances.

The KeyVaultSettingsClient provides asynchronous methods to create, update, get and list settings for the Azure Key Vault.

The optional parameters accepted by the Key Vault's AccessControlClient

A Key Vault setting of boolean type. To check if a given KeyVaultSetting is a boolean, use isBooleanSetting.

An interface representing the optional parameters that can be passed to createRoleAssignment(string, string, string, string, CreateRoleAssignmentOptions)

An interface representing the optional parameters that can be passed to deleteRoleAssignment(string, string, DeleteRoleAssignmentOptions)

An interface representing optional parameters passed to deleteRoleDefinition(string, string, DeleteRoleDefinitionOptions).

An interface representing the optional parameters that can be passed to getRoleAssignment(string, string, GetRoleAssignmentOptions)

An interface representing optional parameters passed to getRoleDefinition(string, string, GetRoleDefinitionOptions).

An interface representing the optional parameters that can be passed to getSetting

An interface representing the state of a Key Vault Admin Poller's operation.

The optional parameters accepted by the KeyVaultBackupClient

An interface representing the optional parameters that can be passed to beginBackup(string, string, KeyVaultBeginBackupOptions)

An interface representing the result of a backup operation.

An interface representing the optional parameters that can be passed to beginBackup(string, string, KeyVaultBeginBackupOptions)

An interface representing the optional parameters that can be passed to beginRestore(string, string, KeyVaultBeginRestoreOptions)

An interface representing the optional parameters that can be passed to beginSelectiveKeyRestore(string, string, string, KeyVaultBeginSelectiveKeyRestoreOptions)

A list of Key Vault permissions.

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

An interface representing the result of a restore operation.

A Key Vault role assignment.

Role assignment properties.

A Key Vault role definition.

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

An interface representing the result of a selective key restore operation.

A Key Vault setting.

An interface representing optional parameters passed to listRoleAssignments(string, ListRoleAssignmentsOptions).

Arguments for retrieving the next page of search results.

An interface representing optional parameters passed to listRoleDefinitions(string, ListRoleDefinitionsOptions).

Arguments for retrieving the next page of search results.

An interface representing the optional parameters that can be passed to <xref:KeyVaultSettingsClient.listSettings>

An interface representing the response returned by <xref:KeyVaultSettingsClient.listSettings>

An interface representing optional parameters passed to setRoleDefinition(string, SetRoleDefinitionOptions).

The optional parameters accepted by the KeyVaultSettingsClient.

An interface representing the optional parameters that can be passed to updateSetting

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

Defines values for DataAction.
<xref:KnownDataAction> can be used interchangeably with DataAction, this enum contains the known values that the service supports.

Known values supported by the service

Microsoft.KeyVault/managedHsm/keys/read/action: Read HSM key metadata.
Microsoft.KeyVault/managedHsm/keys/write/action: Update an HSM key.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/read/action: Read deleted HSM key.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/recover/action: Recover deleted HSM key.
Microsoft.KeyVault/managedHsm/keys/backup/action: Backup HSM keys.
Microsoft.KeyVault/managedHsm/keys/restore/action: Restore HSM keys.
Microsoft.KeyVault/managedHsm/roleAssignments/delete/action: Delete role assignment.
Microsoft.KeyVault/managedHsm/roleAssignments/read/action: Get role assignment.
Microsoft.KeyVault/managedHsm/roleAssignments/write/action: Create or update role assignment.
Microsoft.KeyVault/managedHsm/roleDefinitions/read/action: Get role definition.
Microsoft.KeyVault/managedHsm/roleDefinitions/write/action: Create or update role definition.
Microsoft.KeyVault/managedHsm/roleDefinitions/delete/action: Delete role definition.
Microsoft.KeyVault/managedHsm/keys/encrypt/action: Encrypt using an HSM key.
Microsoft.KeyVault/managedHsm/keys/decrypt/action: Decrypt using an HSM key.
Microsoft.KeyVault/managedHsm/keys/wrap/action: Wrap using an HSM key.
Microsoft.KeyVault/managedHsm/keys/unwrap/action: Unwrap using an HSM key.
Microsoft.KeyVault/managedHsm/keys/sign/action: Sign using an HSM key.
Microsoft.KeyVault/managedHsm/keys/verify/action: Verify using an HSM key.
Microsoft.KeyVault/managedHsm/keys/create: Create an HSM key.
Microsoft.KeyVault/managedHsm/keys/delete: Delete an HSM key.
Microsoft.KeyVault/managedHsm/keys/export/action: Export an HSM key.
Microsoft.KeyVault/managedHsm/keys/release/action: Release an HSM key using Secure Key Release.
Microsoft.KeyVault/managedHsm/keys/import/action: Import an HSM key.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/delete: Purge a deleted HSM key.
Microsoft.KeyVault/managedHsm/securitydomain/download/action: Download an HSM security domain.
Microsoft.KeyVault/managedHsm/securitydomain/download/read: Check status of HSM security domain download.
Microsoft.KeyVault/managedHsm/securitydomain/upload/action: Upload an HSM security domain.
Microsoft.KeyVault/managedHsm/securitydomain/upload/read: Check the status of the HSM security domain exchange file.
Microsoft.KeyVault/managedHsm/securitydomain/transferkey/read: Download an HSM security domain transfer key.
Microsoft.KeyVault/managedHsm/backup/start/action: Start an HSM backup.
Microsoft.KeyVault/managedHsm/restore/start/action: Start an HSM restore.
Microsoft.KeyVault/managedHsm/backup/status/action: Read an HSM backup status.
Microsoft.KeyVault/managedHsm/restore/status/action: Read an HSM restore status.
Microsoft.KeyVault/managedHsm/rng/action: Generate random numbers.

Defines values for RoleScope.
<xref:KnownRoleScope> can be used interchangeably with RoleScope, this enum contains the known values that the service supports.

Known values supported by the service

/: Global scope
/keys: Keys scope

Supported API versions

Known values of KeyVaultDataAction that the service accepts.

Known values of KeyVaultRoleScope that the service accepts.

Determines whether a given KeyVaultSetting is a BooleanKeyVaultSetting, i.e. has a boolean value.