@azure/keyvault-admin package

Classes

KeyVaultAccessControlClient	KeyVaultAccessControlClient fournit des méthodes pour gérer le contrôle d’accès et les attributions de rôles dans n’importe quelle instance Azure Key Vault donnée. Le client prend en charge la création, la récupération et la suppression de rôles.
KeyVaultBackupClient	KeyVaultBackupClient fournit des méthodes pour générer des sauvegardes et restaurer des sauvegardes d’une instance Azure Key Vault donnée. Ce client prend en charge la génération de sauvegardes complètes, de restaurations sélectives de clés spécifiques et de restaurations complètes d’instances Key Vault.
KeyVaultSettingsClient	KeyVaultSettingsClient fournit des méthodes asynchrones pour créer, mettre à jour, obtenir et répertorier des paramètres pour Azure Key Vault.

Interfaces

AccessControlClientOptions	Paramètres facultatifs acceptés par AccessControlClient du coffre de clés
BooleanKeyVaultSetting	Paramètre Key Vault de type booléen. Pour vérifier si un KeyVaultSetting donné est un booléen, utilisez isBooleanSetting.
CreateRoleAssignmentOptions	Interface représentant les paramètres facultatifs qui peuvent être passés à createRoleAssignment(string, string, string, string, CreateRoleAssignmentOptions)
DeleteRoleAssignmentOptions	Interface représentant les paramètres facultatifs qui peuvent être passés à deleteRoleAssignment(string, string, DeleteRoleAssignmentOptions)
DeleteRoleDefinitionOptions	Interface représentant des paramètres facultatifs passés à deleteRoleDefinition(string, string, DeleteRoleDefinitionOptions).
GetRoleAssignmentOptions	Interface représentant les paramètres facultatifs qui peuvent être passés à getRoleAssignment(string, string, GetRoleAssignmentOptions)
GetRoleDefinitionOptions	Interface représentant des paramètres facultatifs passés à getRoleDefinition(string, string, GetRoleDefinitionOptions).
GetSettingOptions	Interface représentant les paramètres facultatifs qui peuvent être passés à getSetting
KeyVaultAdminPollOperationState	Interface représentant l’état de l’opération d’un polleur d’administration Key Vault.
KeyVaultBackupClientOptions	Paramètres facultatifs acceptés par KeyVaultBackupClient
KeyVaultBackupPollerOptions	Interface représentant les paramètres facultatifs qui peuvent être passés à beginBackup(string, string, KeyVaultBeginBackupOptions)
KeyVaultBackupResult	Interface représentant le résultat d’une opération de sauvegarde.
KeyVaultBeginBackupOptions	Interface représentant les paramètres facultatifs qui peuvent être passés à beginBackup
KeyVaultBeginPreBackupOptions	Interface représentant les paramètres facultatifs qui peuvent être passés à beginPreBackup
KeyVaultBeginPreRestoreOptions	Interface représentant les paramètres facultatifs qui peuvent être passés à beginPreRestore
KeyVaultBeginRestoreOptions	Interface représentant les paramètres facultatifs qui peuvent être passés à beginRestore
KeyVaultBeginSelectiveKeyRestoreOptions	Interface représentant les paramètres facultatifs qui peuvent être passés à beginSelectiveKeyRestore
KeyVaultPermission	Liste des autorisations Key Vault.
KeyVaultRestoreOperationState	Interface représentant les propriétés publiquement disponibles de l’état de l’opération de sondage d’un coffre de clés de restauration.
KeyVaultRestoreResult	Interface représentant le résultat d’une opération de restauration.
KeyVaultRoleAssignment	Attribution de rôle Key Vault.
KeyVaultRoleAssignmentProperties	Propriétés d’attribution de rôle.
KeyVaultRoleDefinition	Définition de rôle Key Vault.
KeyVaultSelectiveKeyRestoreOperationState	Interface représentant les propriétés publiquement disponibles de l’état de l’opération de sondage d’un coffre de clés de restauration.
KeyVaultSelectiveKeyRestoreResult	Interface représentant le résultat d’une opération de restauration de clé sélective.
KeyVaultSetting	Paramètre Key Vault.
ListRoleAssignmentsOptions	Interface représentant des paramètres facultatifs passés à listRoleAssignments(string, ListRoleAssignmentsOptions).
ListRoleAssignmentsPageSettings	Arguments pour récupérer la page suivante des résultats de recherche.
ListRoleDefinitionsOptions	Interface représentant des paramètres facultatifs passés à listRoleDefinitions(string, ListRoleDefinitionsOptions).
ListRoleDefinitionsPageSettings	Arguments pour récupérer la page suivante des résultats de recherche.
ListSettingsOptions	Interface représentant les paramètres facultatifs qui peuvent être passés à <xref:KeyVaultSettingsClient.listSettings>
ListSettingsResponse	Interface représentant la réponse retournée par <xref:KeyVaultSettingsClient.listSettings>
PollerLike	Un polleur simple qui peut être utilisé pour interroger une opération de longue durée.
SetRoleDefinitionOptions	Interface représentant des paramètres facultatifs passés à setRoleDefinition(string, SetRoleDefinitionOptions).
SettingsClientOptions	Paramètres facultatifs acceptés par KeyVaultSettingsClient.
UpdateSettingOptions	Interface représentant les paramètres facultatifs qui peuvent être passés à updateSetting

Alias de type

KeyVaultBackupOperationState	Interface représentant les propriétés publiquement disponibles de l’état de l’opération de sondage d’un coffre de clés de sauvegarde.
KeyVaultDataAction	Autorisations prises en charge pour les actions de données. <xref:KnownDataAction> pouvez être utilisé de manière interchangeable avec DataAction, cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service Microsoft.KeyVault/managedHsm/keys/read/action: lire les métadonnées de clé HSM. Microsoft.KeyVault/managedHsm/keys/write/action: Mettez à jour une clé HSM. Microsoft.KeyVault/managedHsm/keys/deletedKeys/read/action: clé HSM supprimée en lecture. Microsoft.KeyVault/managedHsm/keys/deletedKeys/recover/action: récupérer la clé HSM supprimée. Microsoft.KeyVault/managedHsm/keys/backup/action: sauvegarder des clés HSM. Microsoft.KeyVault/managedHsm/keys/restore/action: restaurer des clés HSM. Microsoft.KeyVault/managedHsm/roleAssignments/delete/action: Supprimer l’attribution de rôle. Microsoft.KeyVault/managedHsm/roleAssignments/read/action: Obtenir l’attribution de rôle. Microsoft.KeyVault/managedHsm/roleAssignments/write/action: Créer ou mettre à jour l’attribution de rôle. Microsoft.KeyVault/managedHsm/roleDefinitions/read/action: Obtenir la définition de rôle. Microsoft.KeyVault/managedHsm/roleDefinitions/write/action: Créer ou mettre à jour la définition de rôle. Microsoft.KeyVault/managedHsm/roleDefinitions/delete/action: supprimer la définition de rôle. Microsoft.KeyVault/managedHsm/keys/encrypt/action: chiffrer à l’aide d’une clé HSM. Microsoft.KeyVault/managedHsm/keys/decrypt/action: déchiffrer à l’aide d’une clé HSM. Microsoft.KeyVault/managedHsm/keys/wrap/action: encapsuler à l’aide d’une clé HSM. Microsoft.KeyVault/managedHsm/keys/unwrap/action: Annuler lewrap à l’aide d’une clé HSM. Microsoft.KeyVault/managedHsm/keys/sign/action: signer à l’aide d’une clé HSM. Microsoft.KeyVault/managedHsm/keys/verify/action: vérifier à l’aide d’une clé HSM. Microsoft.KeyVault/managedHsm/keys/create: créer une clé HSM. Microsoft.KeyVault/managedHsm/keys/delete: supprimer une clé HSM. Microsoft.KeyVault/managedHsm/keys/export/action: exporter une clé HSM. Microsoft.KeyVault/managedHsm/keys/release/action: relâchez une clé HSM à l’aide de la version sécurisée de la clé. Microsoft.KeyVault/managedHsm/keys/import/action: importer une clé HSM. Microsoft.KeyVault/managedHsm/keys/deletedKeys/delete: vider une clé HSM supprimée. Microsoft.KeyVault/managedHsm/securitydomain/download/action: télécharger un domaine de sécurité HSM. Microsoft.KeyVault/managedHsm/securitydomain/download/read: vérifier l’état du téléchargement du domaine de sécurité HSM. Microsoft.KeyVault/managedHsm/securitydomain/upload/action: charger un domaine de sécurité HSM. Microsoft.KeyVault/managedHsm/securitydomain/upload/read: vérifiez l’état du fichier d’échange de domaine de sécurité HSM. Microsoft.KeyVault/managedHsm/securitydomain/transferkey/read: téléchargez une clé de transfert de domaine de sécurité HSM. Microsoft.KeyVault/managedHsm/backup/start/action: démarrer une sauvegarde HSM. Microsoft.KeyVault/managedHsm/restore/start/action: démarrer une restauration HSM. Microsoft.KeyVault/managedHsm/backup/status/action: lire un état de sauvegarde HSM. Microsoft.KeyVault/managedHsm/restore/status/action: lire un état de restauration HSM. Microsoft.KeyVault/managedHsm/rng/action: générer des nombres aléatoires.
KeyVaultRoleScope	Étendue du rôle. <xref:KnownRoleScope> pouvez être utilisé de manière interchangeable avec RoleScope, cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service /: étendue globale /keys: étendue des clés
OperationStatus	État d’une opération longue. <xref:KnownOperationStatus> pouvez être utilisé de manière interchangeable avec OperationStatus, cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service InProgress: l’opération est en cours. Réussi: l’opération s’est terminée correctement. annulé : l’opération a été annulée. échec: échec de l’opération.
SUPPORTED_API_VERSIONS	Versions d’API prises en charge

Énumérations

KnownKeyVaultDataAction	Autorisations prises en charge pour les actions de données.
KnownKeyVaultRoleScope	Étendue du rôle.

Functions

isBooleanSetting(KeyVaultSetting)

Détermine si un KeyVaultSetting donné est un BooleanKeyVaultSetting, c’est-à-dire qu’il a une valeur booléenne.

Variables

LATEST_API_VERSION	La dernière version prise en charge de l’API du service Key Vault.
SDK_VERSION	Version actuelle du SDK Key Vault Admin SDK.

Informations relatives à la fonction

isBooleanSetting(KeyVaultSetting)

Détermine si un KeyVaultSetting donné est un BooleanKeyVaultSetting, c’est-à-dire qu’il a une valeur booléenne.

function isBooleanSetting(setting: KeyVaultSetting): setting

Paramètres

setting

KeyVaultSetting

Retours

setting

Variable Details

LATEST_API_VERSION

La dernière version prise en charge de l’API du service Key Vault.

LATEST_API_VERSION: "7.6"

Type

"7.6"

SDK_VERSION

Version actuelle du SDK Key Vault Admin SDK.

SDK_VERSION: string

Type

string