@azure/keyvault-admin package

Klasserna

KeyVaultAccessControlClient	KeyVaultAccessControlClient innehåller metoder för att hantera åtkomstkontroll- och rolltilldelningar i en viss Azure Key Vault-instans. Klienten har stöd för att skapa, hämta och ta bort roller.
KeyVaultBackupClient	KeyVaultBackupClient innehåller metoder för att generera säkerhetskopior och återställa säkerhetskopior av en viss Azure Key Vault-instans. Den här klienten stöder generering av fullständiga säkerhetskopior, selektiva återställningar av specifika nycklar och fullständiga återställningar av Key Vault-instanser.
KeyVaultSettingsClient	KeyVaultSettingsClient innehåller asynkrona metoder för att skapa, uppdatera, hämta och lista inställningar för Azure Key Vault.

Gränssnitt

AccessControlClientOptions	De valfria parametrar som godkänts av Key Vaults AccessControlClient
BooleanKeyVaultSetting	En Key Vault-inställning av boolesk typ. Om du vill kontrollera om en viss KeyVaultSetting är ett booleskt värde använder du isBooleanSetting.
CreateRoleAssignmentOptions	Ett gränssnitt som representerar de valfria parametrar som kan skickas till createRoleAssignment(string, string, string, string, CreateRoleAssignmentOptions)
DeleteRoleAssignmentOptions	Ett gränssnitt som representerar de valfria parametrar som kan skickas till deleteRoleAssignment(string, string, DeleteRoleAssignmentOptions)
DeleteRoleDefinitionOptions	Ett gränssnitt som representerar valfria parametrar som skickas till deleteRoleDefinition(string, string, DeleteRoleDefinitionOptions).
GetRoleAssignmentOptions	Ett gränssnitt som representerar de valfria parametrar som kan skickas till getRoleAssignment(string, string, GetRoleAssignmentOptions)
GetRoleDefinitionOptions	Ett gränssnitt som representerar valfria parametrar som skickas till getRoleDefinition(string, string, GetRoleDefinitionOptions).
GetSettingOptions	Ett gränssnitt som representerar de valfria parametrar som kan skickas till getSetting-
KeyVaultAdminPollOperationState	Ett gränssnitt som representerar tillståndet för en Key Vault Admin Poller-åtgärd.
KeyVaultBackupClientOptions	De valfria parametrar som godkänts av KeyVaultBackupClient
KeyVaultBackupPollerOptions	Ett gränssnitt som representerar de valfria parametrar som kan skickas till beginBackup(string, string, KeyVaultBeginBackupOptions)
KeyVaultBackupResult	Ett gränssnitt som representerar resultatet av en säkerhetskopieringsåtgärd.
KeyVaultBeginBackupOptions	Ett gränssnitt som representerar de valfria parametrar som kan skickas till beginBackup
KeyVaultBeginPreBackupOptions	Ett gränssnitt som representerar de valfria parametrar som kan skickas till beginPreBackup
KeyVaultBeginPreRestoreOptions	Ett gränssnitt som representerar de valfria parametrar som kan skickas till beginPreRestore
KeyVaultBeginRestoreOptions	Ett gränssnitt som representerar de valfria parametrar som kan skickas till beginRestore
KeyVaultBeginSelectiveKeyRestoreOptions	Ett gränssnitt som representerar de valfria parametrar som kan skickas till beginSelectiveKeyRestore
KeyVaultPermission	En lista över Key Vault-behörigheter.
KeyVaultRestoreOperationState	Ett gränssnitt som representerar de offentligt tillgängliga egenskaperna för tillståndet för en återställning av Key Vault-avsökningsåtgärden.
KeyVaultRestoreResult	Ett gränssnitt som representerar resultatet av en återställningsåtgärd.
KeyVaultRoleAssignment	En Key Vault-rolltilldelning.
KeyVaultRoleAssignmentProperties	Egenskaper för rolltilldelning.
KeyVaultRoleDefinition	En rolldefinition för Key Vault.
KeyVaultSelectiveKeyRestoreOperationState	Ett gränssnitt som representerar de offentligt tillgängliga egenskaperna för tillståndet för en återställning av Key Vault-avsökningsåtgärden.
KeyVaultSelectiveKeyRestoreResult	Ett gränssnitt som representerar resultatet av en selektiv nyckelåterställningsåtgärd.
KeyVaultSetting	En Key Vault-inställning.
ListRoleAssignmentsOptions	Ett gränssnitt som representerar valfria parametrar som skickas till listRoleAssignments(string, ListRoleAssignmentsOptions).
ListRoleAssignmentsPageSettings	Argument för att hämta nästa sida med sökresultat.
ListRoleDefinitionsOptions	Ett gränssnitt som representerar valfria parametrar som skickas till listRoleDefinitions(string, ListRoleDefinitionsOptions).
ListRoleDefinitionsPageSettings	Argument för att hämta nästa sida med sökresultat.
ListSettingsOptions	Ett gränssnitt som representerar de valfria parametrar som kan skickas till <xref:KeyVaultSettingsClient.listSettings>
ListSettingsResponse	Ett gränssnitt som representerar svaret som returnerades av <xref:KeyVaultSettingsClient.listSettings>
PollerLike	En enkel pollerare som kan användas för att avsöka en tidskrävande åtgärd.
SetRoleDefinitionOptions	Ett gränssnitt som representerar valfria parametrar som skickas till setRoleDefinition(string, SetRoleDefinitionOptions).
SettingsClientOptions	De valfria parametrarna som godkänts av KeyVaultSettingsClient.
UpdateSettingOptions	Ett gränssnitt som representerar de valfria parametrar som kan skickas till updateSetting

Typaliaser

KeyVaultBackupOperationState	Ett gränssnitt som representerar de offentligt tillgängliga egenskaperna för tillståndet för en nyckelvalvs avsökningsåtgärd för säkerhetskopiering.
KeyVaultDataAction	Behörigheter som stöds för dataåtgärder. <xref:KnownDataAction> kan användas utbytbart med DataAction innehåller den här uppräkningen de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten Microsoft.KeyVault/managedHsm/keys/read/action: Läs HSM-nyckelmetadata. Microsoft.KeyVault/managedHsm/keys/write/action: Uppdatera en HSM-nyckel. Microsoft.KeyVault/managedHsm/keys/deletedKeys/read/action: Läs borttagen HSM-nyckel. Microsoft.KeyVault/managedHsm/keys/deletedKeys/recover/action: Återställ borttagen HSM-nyckel. Microsoft.KeyVault/managedHsm/keys/backup/action: Säkerhetskopiera HSM-nycklar. Microsoft.KeyVault/managedHsm/keys/restore/action: Återställ HSM-nycklar. Microsoft.KeyVault/managedHsm/roleAssignments/delete/action: Ta bort rolltilldelning. Microsoft.KeyVault/managedHsm/roleAssignments/read/action: Hämta rolltilldelning. Microsoft.KeyVault/managedHsm/roleAssignments/write/action: Skapa eller uppdatera rolltilldelning. Microsoft.KeyVault/managedHsm/roleDefinitions/read/action: Hämta rolldefinition. Microsoft.KeyVault/managedHsm/roleDefinitions/write/action: Skapa eller uppdatera rolldefinition. Microsoft.KeyVault/managedHsm/roleDefinitions/delete/action: Ta bort rolldefinition. Microsoft.KeyVault/managedHsm/keys/encrypt/action: Kryptera med en HSM-nyckel. Microsoft.KeyVault/managedHsm/keys/decrypt/action: Dekryptera med en HSM-nyckel. Microsoft.KeyVault/managedHsm/keys/wrap/action: Wrap med en HSM-nyckel. Microsoft.KeyVault/managedHsm/keys/unwrap/action: Packa upp med en HSM-nyckel. Microsoft.KeyVault/managedHsm/keys/sign/action: Sign using an HSM key (Signera med en HSM-nyckel). Microsoft.KeyVault/managedHsm/keys/verify/action: Verifiera med en HSM-nyckel. Microsoft.KeyVault/managedHsm/keys/create: Skapa en HSM-nyckel. Microsoft.KeyVault/managedHsm/keys/delete: Ta bort en HSM-nyckel. Microsoft.KeyVault/managedHsm/keys/export/action: Exportera en HSM-nyckel. Microsoft.KeyVault/managedHsm/keys/release/action: Släpp en HSM-nyckel med säker nyckelversion. Microsoft.KeyVault/managedHsm/keys/import/action: Importera en HSM-nyckel. Microsoft.KeyVault/managedHsm/keys/deletedKeys/delete: Rensa en borttagen HSM-nyckel. Microsoft.KeyVault/managedHsm/securitydomain/download/action: Ladda ned en HSM-säkerhetsdomän. Microsoft.KeyVault/managedHsm/securitydomain/download/read: Kontrollera status för nedladdning av HSM-säkerhetsdomän. Microsoft.KeyVault/managedHsm/securitydomain/upload/action: Ladda upp en HSM-säkerhetsdomän. Microsoft.KeyVault/managedHsm/securitydomain/upload/read: Kontrollera statusen för exchange-filen för HSM-säkerhetsdomänen. Microsoft.KeyVault/managedHsm/securitydomain/transferkey/read: Ladda ned en HSM-säkerhetsdomänöverföringsnyckel. Microsoft.KeyVault/managedHsm/backup/start/action: Starta en HSM-säkerhetskopiering. Microsoft.KeyVault/managedHsm/restore/start/action: Starta en HSM-återställning. Microsoft.KeyVault/managedHsm/backup/status/action: Läs status för HSM-säkerhetskopiering. Microsoft.KeyVault/managedHsm/restore/status/action: Läs en HSM-återställningsstatus. Microsoft.KeyVault/managedHsm/rng/action: Generera slumptal.
KeyVaultRoleScope	Rollomfånget. <xref:KnownRoleScope> kan användas utbytbart med RoleScope innehåller den här uppräkningen de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten /: Globalt omfång /keys: Nyckelomfång
OperationStatus	Status för en tidskrävande åtgärd. <xref:KnownOperationStatus> kan användas omväxlande med OperationStatus innehåller den här uppräkningen de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten InProgress: Åtgärden pågår. Lyckades: Åtgärden har slutförts. Avbröts: Åtgärden avbröts. Misslyckades: Åtgärden misslyckades.
SUPPORTED_API_VERSIONS	API-versioner som stöds

Enums

KnownKeyVaultDataAction	Behörigheter som stöds för dataåtgärder.
KnownKeyVaultRoleScope	Rollomfånget.

Funktioner

isBooleanSetting(KeyVaultSetting)

Avgör om en viss KeyVaultSetting- är en BooleanKeyVaultSetting, d.v.s. har ett booleskt värde.

Variabler

LATEST_API_VERSION	Den senaste stödda versionen av Key Vault-tjänsten API.
SDK_VERSION	Nuvarande version av Key Vault Admin SDK.

Funktionsdetaljer

isBooleanSetting(KeyVaultSetting)

Avgör om en viss KeyVaultSetting- är en BooleanKeyVaultSetting, d.v.s. har ett booleskt värde.

function isBooleanSetting(setting: KeyVaultSetting): setting

Parametrar

setting

KeyVaultSetting

Returnerar

setting

Variable Details

LATEST_API_VERSION

Den senaste stödda versionen av Key Vault-tjänsten API.

LATEST_API_VERSION: "7.6"

Typ

"7.6"

SDK_VERSION

Nuvarande version av Key Vault Admin SDK.

SDK_VERSION: string

Typ

string