@azure/keyvault-admin package

Klassen

KeyVaultAccessControlClient	Der KeyVaultAccessControlClient stellt Methoden zum Verwalten von Zugriffssteuerungs- und Rollenzuweisungen in einer beliebigen Azure Key Vault-Instanz bereit. Der Client unterstützt das Erstellen, Abrufen und Löschen von Rollen.
KeyVaultBackupClient	Der KeyVaultBackupClient stellt Methoden bereit, um Sicherungen zu generieren und Sicherungen einer beliebigen Azure Key Vault-Instanz wiederherzustellen. Dieser Client unterstützt das Generieren vollständiger Sicherungen, selektive Wiederherstellungen bestimmter Schlüssel und vollständige Wiederherstellungen von Key Vault-Instanzen.
KeyVaultSettingsClient	Der KeyVaultSettingsClient stellt asynchrone Methoden zum Erstellen, Aktualisieren, Abrufen und Listeneinstellungen für den Azure Key Vault bereit.

Schnittstellen

AccessControlClientOptions	Die optionalen Parameter, die vom AccessControlClient des Key Vault akzeptiert werden
BooleanKeyVaultSetting	Eine Key Vault-Einstellung vom booleschen Typ. Um zu überprüfen, ob ein gegebener KeyVaultSetting ein boolescher Wert ist, verwenden Sie isBooleanSetting.
CreateRoleAssignmentOptions	Eine Schnittstelle, die die optionalen Parameter darstellt, die an createRoleAssignment(string, string, string, string, CreateRoleAssignmentOptions) übergeben werden können
DeleteRoleAssignmentOptions	Eine Schnittstelle, die die optionalen Parameter darstellt, die an deleteRoleAssignment(string, string, DeleteRoleAssignmentOptions) übergeben werden können
DeleteRoleDefinitionOptions	Eine Schnittstelle, die optionale Parameter darstellt, die an deleteRoleDefinition(string, string, DeleteRoleDefinitionOptions)übergeben werden.
GetRoleAssignmentOptions	Eine Schnittstelle, die die optionalen Parameter darstellt, die an getRoleAssignment(string, string, GetRoleAssignmentOptions) übergeben werden können
GetRoleDefinitionOptions	Eine Schnittstelle, die optionale Parameter darstellt, die an getRoleDefinition(string, string, GetRoleDefinitionOptions)übergeben werden.
GetSettingOptions	Eine Schnittstelle, die die optionalen Parameter darstellt, die an getSetting übergeben werden können
KeyVaultAdminPollOperationState	Eine Schnittstelle, die den Status des Vorgangs eines Key Vault-Administrator-Pollers darstellt.
KeyVaultBackupClientOptions	Die optionalen Parameter, die vom KeyVaultBackupClient akzeptiert werden
KeyVaultBackupPollerOptions	Eine Schnittstelle, die die optionalen Parameter darstellt, die an beginBackup(string, string, KeyVaultBeginBackupOptions) übergeben werden können
KeyVaultBackupResult	Eine Schnittstelle, die das Ergebnis eines Sicherungsvorgangs darstellt.
KeyVaultBeginBackupOptions	Eine Schnittstelle, die die optionalen Parameter darstellt, die an beginBackup- übergeben werden können
KeyVaultBeginPreBackupOptions	Eine Schnittstelle, die die optionalen Parameter darstellt, die an beginPreBackup- übergeben werden können
KeyVaultBeginPreRestoreOptions	Eine Schnittstelle, die die optionalen Parameter darstellt, die an beginPreRestore- übergeben werden können
KeyVaultBeginRestoreOptions	Eine Schnittstelle, die die optionalen Parameter darstellt, die an beginRestore- übergeben werden können
KeyVaultBeginSelectiveKeyRestoreOptions	Eine Schnittstelle, die die optionalen Parameter darstellt, die an beginSelectiveKeyRestore übergeben werden können
KeyVaultPermission	Eine Liste der Key Vault-Berechtigungen.
KeyVaultRestoreOperationState	Eine Schnittstelle, die die öffentlich verfügbaren Eigenschaften des Zustands des Abrufvorgangs eines Wiederherstellungsschlüsseltresors darstellt.
KeyVaultRestoreResult	Eine Schnittstelle, die das Ergebnis eines Wiederherstellungsvorgangs darstellt.
KeyVaultRoleAssignment	Eine Schlüsseltresor-Rollenzuweisung.
KeyVaultRoleAssignmentProperties	Rollenzuweisungseigenschaften.
KeyVaultRoleDefinition	Eine Schlüsseltresor-Rollendefinition.
KeyVaultSelectiveKeyRestoreOperationState	Eine Schnittstelle, die die öffentlich verfügbaren Eigenschaften des Zustands des Abrufvorgangs eines Wiederherstellungsschlüsseltresors darstellt.
KeyVaultSelectiveKeyRestoreResult	Eine Schnittstelle, die das Ergebnis eines selektiven Schlüsselwiederherstellungsvorgangs darstellt.
KeyVaultSetting	Eine Key Vault-Einstellung.
ListRoleAssignmentsOptions	Eine Schnittstelle, die optionale Parameter darstellt, die an listRoleAssignments(string, ListRoleAssignmentsOptions)übergeben werden.
ListRoleAssignmentsPageSettings	Argumente zum Abrufen der nächsten Seite der Suchergebnisse.
ListRoleDefinitionsOptions	Eine Schnittstelle, die optionale Parameter darstellt, die an listRoleDefinitions(string, ListRoleDefinitionsOptions)übergeben werden.
ListRoleDefinitionsPageSettings	Argumente zum Abrufen der nächsten Seite der Suchergebnisse.
ListSettingsOptions	Eine Schnittstelle, die die optionalen Parameter darstellt, die an <xref:KeyVaultSettingsClient.listSettings> übergeben werden können
ListSettingsResponse	Eine Schnittstelle, die die von <xref:KeyVaultSettingsClient.listSettings> zurückgegebene Antwort darstellt
PollerLike	Ein einfacher Poller, der zum Abrufen eines vorgangs mit langer Ausführung verwendet werden kann.
SetRoleDefinitionOptions	Eine Schnittstelle, die optionale Parameter darstellt, die an setRoleDefinition(string, SetRoleDefinitionOptions)übergeben werden.
SettingsClientOptions	Die optionalen Parameter, die vom KeyVaultSettingsClient akzeptiert werden.
UpdateSettingOptions	Eine Schnittstelle, die die optionalen Parameter darstellt, die an updateSetting übergeben werden können

Typaliase

KeyVaultBackupOperationState	Eine Schnittstelle, die die öffentlich verfügbaren Eigenschaften des Zustands eines Abrufvorgangs eines Sicherungsschlüsseltresors darstellt.
KeyVaultDataAction	Unterstützte Berechtigungen für Datenaktionen. <xref:KnownDataAction> austauschbar mit DataAction verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden Microsoft.KeyVault/managedHsm/keys/read/action: HSM-Schlüsselmetadaten lesen. Microsoft.KeyVault/managedHsm/keys/write/action: Einen HSM-Schlüssel aktualisieren. Microsoft.KeyVault/managedHsm/keys/deletedKeys/read/action: HSM-Schlüssel lesen. Microsoft.KeyVault/managedHsm/keys/deletedKeys/recover/action: Wiederherstellen des gelöschten HSM-Schlüssels. Microsoft.KeyVault/managedHsm/keys/backup/action: HSM-Schlüssel sichern. Microsoft.KeyVault/managedHsm/keys/restore/action: HSM-Schlüssel wiederherstellen. Microsoft.KeyVault/managedHsm/roleAssignments/delete/action: Rollenzuweisung löschen. Microsoft.KeyVault/managedHsm/roleAssignments/read/action: Rollenzuweisung abrufen. Microsoft.KeyVault/managedHsm/roleAssignments/write/action: Erstellen oder Aktualisieren der Rollenzuweisung. Microsoft.KeyVault/managedHsm/roleDefinitions/read/action: Rollendefinition abrufen. Microsoft.KeyVault/managedHsm/roleDefinitions/write/action: Erstellen oder Aktualisieren der Rollendefinition. Microsoft.KeyVault/managedHsm/roleDefinitions/delete/action: Rollendefinition löschen. Microsoft.KeyVault/managedHsm/keys/encrypt/action: Verschlüsseln mit einem HSM-Schlüssel. Microsoft.KeyVault/managedHsm/keys/decrypt/action: Entschlüsseln mit einem HSM-Schlüssel. Microsoft.KeyVault/managedHsm/keys/wrap/action: Umschließen mit einem HSM-Schlüssel. Microsoft.KeyVault/managedHsm/keys/unwrap/action: Entpacken mit einem HSM-Schlüssel. Microsoft.KeyVault/managedHsm/keys/sign/action: Signieren mit einem HSM-Schlüssel. Microsoft.KeyVault/managedHsm/keys/verify/action: Überprüfen Sie die Verwendung eines HSM-Schlüssels. Microsoft.KeyVault/managedHsm/keys/create: Erstellen sie einen HSM-Schlüssel. Microsoft.KeyVault/managedHsm/keys/delete: Einen HSM-Schlüssel löschen. Microsoft.KeyVault/managedHsm/keys/export/action: Exportieren eines HSM-Schlüssels. Microsoft.KeyVault/managedHsm/keys/release/action: Freigeben eines HSM-Schlüssels mit Secure Key Release. Microsoft.KeyVault/managedHsm/keys/import/action: Einen HSM-Schlüssel importieren. Microsoft.KeyVault/managedHsm/keys/deletedKeys/delete: Löschen eines gelöschten HSM-Schlüssels. Microsoft.KeyVault/managedHsm/securitydomain/download/action: Eine HSM-Sicherheitsdomäne herunterladen. Microsoft.KeyVault/managedHsm/securitydomain/download/read: Überprüfen Sie den Status des HSM-Sicherheitsdomänendownloads. Microsoft.KeyVault/managedHsm/securitydomain/upload/action: Eine HSM-Sicherheitsdomäne hochladen. Microsoft.KeyVault/managedHsm/securitydomain/upload/read: Überprüfen Sie den Status der HSM-Sicherheitsdomänenaustauschdatei. Microsoft.KeyVault/managedHsm/securitydomain/transferkey/read: Herunterladen eines HSM-Sicherheitsdomänenübertragungsschlüssels. Microsoft.KeyVault/managedHsm/backup/start/action: Starten einer HSM-Sicherung. Microsoft.KeyVault/managedHsm/restore/start/action: Starten einer HSM-Wiederherstellung. Microsoft.KeyVault/managedHsm/backup/status/action: Lesen eines HSM-Sicherungsstatus. Microsoft.KeyVault/managedHsm/restore/status/action: Lesen eines HSM-Wiederherstellungsstatus. Microsoft.KeyVault/managedHsm/rng/action: Zufallszahlen generieren.
KeyVaultRoleScope	Der Rollenbereich. <xref:KnownRoleScope> austauschbar mit RoleScope verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden /: Globaler Bereich /keys: Schlüsselbereich
OperationStatus	Der Status eines lange ausgeführten Vorgangs. <xref:KnownOperationStatus> austauschbar mit OperationStatus verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt. Bekannte Werte, die vom Dienst unterstützt werden InProgress: Der Vorgang wird ausgeführt. Erfolgreich: Der Vorgang wurde erfolgreich abgeschlossen. Abgebrochene: Der Vorgang wurde abgebrochen. Fehlgeschlagene: Fehler beim Vorgang.
SUPPORTED_API_VERSIONS	Unterstützte API-Versionen

Enumerationen

KnownKeyVaultDataAction	Unterstützte Berechtigungen für Datenaktionen.
KnownKeyVaultRoleScope	Der Rollenbereich.

Functions

isBooleanSetting(KeyVaultSetting)

Bestimmt, ob ein bestimmtes KeyVaultSetting- ein BooleanKeyVaultSetting-ist, d. h. einen booleschen Wert hat.

Variablen

LATEST_API_VERSION	Die neueste unterstützte Key Vault Service API-Version.
SDK_VERSION	Aktuelle Version des Key Vault Admin SDK.

Details zur Funktion

isBooleanSetting(KeyVaultSetting)

Bestimmt, ob ein bestimmtes KeyVaultSetting- ein BooleanKeyVaultSetting-ist, d. h. einen booleschen Wert hat.

function isBooleanSetting(setting: KeyVaultSetting): setting

Parameter

setting

KeyVaultSetting

Gibt zurück

setting

Variable Details

LATEST_API_VERSION

Die neueste unterstützte Key Vault Service API-Version.

LATEST_API_VERSION: "7.6"

Typ

"7.6"

SDK_VERSION

Aktuelle Version des Key Vault Admin SDK.

SDK_VERSION: string

Typ

string