@azure/keyvault-admin package

Classes

KeyVaultAccessControlClient	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.
KeyVaultBackupClient	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.
KeyVaultSettingsClient	The KeyVaultSettingsClient provides asynchronous methods to create, update, get and list settings for the Azure Key Vault.

Interfaces

AccessControlClientOptions	The optional parameters accepted by the Key Vault's AccessControlClient
BooleanKeyVaultSetting	A Key Vault setting of boolean type. To check if a given KeyVaultSetting is a boolean, use isBooleanSetting.
CreateRoleAssignmentOptions	An interface representing the optional parameters that can be passed to createRoleAssignment(string, string, string, string, CreateRoleAssignmentOptions)
DeleteRoleAssignmentOptions	An interface representing the optional parameters that can be passed to deleteRoleAssignment(string, string, DeleteRoleAssignmentOptions)
DeleteRoleDefinitionOptions	An interface representing optional parameters passed to deleteRoleDefinition(string, string, DeleteRoleDefinitionOptions).
GetRoleAssignmentOptions	An interface representing the optional parameters that can be passed to getRoleAssignment(string, string, GetRoleAssignmentOptions)
GetRoleDefinitionOptions	An interface representing optional parameters passed to getRoleDefinition(string, string, GetRoleDefinitionOptions).
GetSettingOptions	An interface representing the optional parameters that can be passed to getSetting
KeyVaultAdminPollOperationState	An interface representing the state of a Key Vault Admin Poller's operation.
KeyVaultBackupClientOptions	The optional parameters accepted by the KeyVaultBackupClient
KeyVaultBackupPollerOptions	An interface representing the optional parameters that can be passed to beginBackup(string, string, KeyVaultBeginBackupOptions)
KeyVaultBackupResult	An interface representing the result of a backup operation.
KeyVaultBeginBackupOptions	An interface representing the optional parameters that can be passed to beginBackup
KeyVaultBeginPreBackupOptions	An interface representing the optional parameters that can be passed to beginPreBackup
KeyVaultBeginPreRestoreOptions	An interface representing the optional parameters that can be passed to beginPreRestore
KeyVaultBeginRestoreOptions	An interface representing the optional parameters that can be passed to beginRestore
KeyVaultBeginSelectiveKeyRestoreOptions	An interface representing the optional parameters that can be passed to beginSelectiveKeyRestore
KeyVaultPermission	A list of Key Vault permissions.
KeyVaultRestoreOperationState	An interface representing the publicly available properties of the state of a restore Key Vault's poll operation.
KeyVaultRestoreResult	An interface representing the result of a restore operation.
KeyVaultRoleAssignment	A Key Vault role assignment.
KeyVaultRoleAssignmentProperties	Role assignment properties.
KeyVaultRoleDefinition	A Key Vault role definition.
KeyVaultSelectiveKeyRestoreOperationState	An interface representing the publicly available properties of the state of a restore Key Vault's poll operation.
KeyVaultSelectiveKeyRestoreResult	An interface representing the result of a selective key restore operation.
KeyVaultSetting	A Key Vault setting.
ListRoleAssignmentsOptions	An interface representing optional parameters passed to listRoleAssignments(string, ListRoleAssignmentsOptions).
ListRoleAssignmentsPageSettings	Arguments for retrieving the next page of search results.
ListRoleDefinitionsOptions	An interface representing optional parameters passed to listRoleDefinitions(string, ListRoleDefinitionsOptions).
ListRoleDefinitionsPageSettings	Arguments for retrieving the next page of search results.
ListSettingsOptions	An interface representing the optional parameters that can be passed to <xref:KeyVaultSettingsClient.listSettings>
ListSettingsResponse	An interface representing the response returned by <xref:KeyVaultSettingsClient.listSettings>
PollerLike	A simple poller that can be used to poll a long running operation.
SetRoleDefinitionOptions	An interface representing optional parameters passed to setRoleDefinition(string, SetRoleDefinitionOptions).
SettingsClientOptions	The optional parameters accepted by the KeyVaultSettingsClient.
UpdateSettingOptions	An interface representing the optional parameters that can be passed to updateSetting

Type Aliases

KeyVaultBackupOperationState	An interface representing the publicly available properties of the state of a backup Key Vault's poll operation.
KeyVaultDataAction	Supported permissions for data actions. <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.
KeyVaultRoleScope	The role scope. <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
OperationStatus	The status of a long-running operation. <xref:KnownOperationStatus> can be used interchangeably with OperationStatus, this enum contains the known values that the service supports. Known values supported by the service InProgress: The operation is in progress. Succeeded: The operation successfully completed. Canceled: The operation was canceled. Failed: The operation failed.
SUPPORTED_API_VERSIONS	Supported API versions

Enums

KnownKeyVaultDataAction	Supported permissions for data actions.
KnownKeyVaultRoleScope	The role scope.

Functions

isBooleanSetting(KeyVaultSetting)

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

Function Details

isBooleanSetting(KeyVaultSetting)

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

function isBooleanSetting(setting: KeyVaultSetting): setting

Parameters

setting

KeyVaultSetting

Returns

setting