@azure/keyvault-admin package

Třídy

KeyVaultAccessControlClient

KeyVaultAccessControlClient poskytuje metody pro správu řízení přístupu a přiřazení rolí v libovolné instanci služby Azure Key Vault. Klient podporuje vytváření, načítání a odstraňování rolí.

KeyVaultBackupClient

KeyVaultBackupClient poskytuje metody pro generování záloh a obnovení záloh jakékoli dané instance služby Azure Key Vault. Tento klient podporuje generování úplných záloh, selektivní obnovení konkrétních klíčů a úplné obnovení instancí služby Key Vault.

KeyVaultSettingsClient

KeyVaultSettingsClient poskytuje asynchronní metody pro vytváření, aktualizaci, získávání a výpis nastavení služby Azure Key Vault.

Rozhraní

AccessControlClientOptions

Volitelné parametry akceptované AccessControlClient ve službě Key Vault

BooleanKeyVaultSetting

Nastavení služby Key Vault logického typu Pokud chcete zkontrolovat, jestli je daná hodnota KeyVaultSetting logická hodnota, použijte isBooleanSetting.

CreateRoleAssignmentOptions

Rozhraní představující volitelné parametry, které lze předat createRoleAssignment(string, string, string, string, CreateRoleAssignmentOptions)

DeleteRoleAssignmentOptions

Rozhraní představující volitelné parametry, které lze předat deleteRoleAssignment(string, string, DeleteRoleAssignmentOptions)

DeleteRoleDefinitionOptions

Rozhraní představující volitelné parametry předané deleteRoleDefinition(string, string, DeleteRoleDefinitionOptions).

GetRoleAssignmentOptions

Rozhraní představující volitelné parametry, které lze předat getRoleAssignment(string, string, GetRoleAssignmentOptions)

GetRoleDefinitionOptions

Rozhraní představující volitelné parametry předané getRoleDefinition(string, string, GetRoleDefinitionOptions).

GetSettingOptions

Rozhraní představující volitelné parametry, které lze předat getSetting

KeyVaultAdminPollOperationState

Rozhraní představující stav operace správce služby Key Vault.

KeyVaultBackupClientOptions

Volitelné parametry akceptované klientem KeyVaultBackupClient

KeyVaultBackupPollerOptions

Rozhraní představující volitelné parametry, které lze předat beginBackup(string, string, KeyVaultBeginBackupOptions)

KeyVaultBackupResult

Rozhraní představující výsledek operace zálohování.

KeyVaultBeginBackupOptions

Rozhraní představující volitelné parametry, které lze předat beginBackup

KeyVaultBeginPreBackupOptions

Rozhraní představující volitelné parametry, které lze předat beginPreBackup

KeyVaultBeginPreRestoreOptions

Rozhraní představující volitelné parametry, které lze předat beginPreRestore

KeyVaultBeginRestoreOptions

Rozhraní představující volitelné parametry, které lze předat beginRestore

KeyVaultBeginSelectiveKeyRestoreOptions

Rozhraní představující volitelné parametry, které lze předat beginSelectiveKeyRestore

KeyVaultPermission

Seznam oprávnění služby Key Vault

KeyVaultRestoreOperationState

Rozhraní představující veřejně dostupné vlastnosti stavu operace dotazování služby Key Vault.

KeyVaultRestoreResult

Rozhraní představující výsledek operace obnovení.

KeyVaultRoleAssignment

Přiřazení role služby Key Vault.

KeyVaultRoleAssignmentProperties

Vlastnosti přiřazení role.

KeyVaultRoleDefinition

Definice role služby Key Vault.

KeyVaultSelectiveKeyRestoreOperationState

Rozhraní představující veřejně dostupné vlastnosti stavu operace dotazování služby Key Vault.

KeyVaultSelectiveKeyRestoreResult

Rozhraní představující výsledek operace selektivního obnovení klíče.

KeyVaultSetting

Nastavení služby Key Vault.

ListRoleAssignmentsOptions

Rozhraní představující volitelné parametry předané listRoleAssignments(string, ListRoleAssignmentsOptions).

ListRoleAssignmentsPageSettings

Argumenty pro načtení další stránky výsledků hledání

ListRoleDefinitionsOptions

Rozhraní představující volitelné parametry předané listRoleDefinitions(string, ListRoleDefinitionsOptions).

ListRoleDefinitionsPageSettings

Argumenty pro načtení další stránky výsledků hledání

ListSettingsOptions

Rozhraní představující volitelné parametry, které lze předat <xref:KeyVaultSettingsClient.listSettings>

ListSettingsResponse

Rozhraní představující odpověď vrácenou <xref:KeyVaultSettingsClient.listSettings>

PollerLike

Jednoduchý poller, který lze použít k dotazování dlouhotrvající operace.

SetRoleDefinitionOptions

Rozhraní představující volitelné parametry předané setRoleDefinition(string, SetRoleDefinitionOptions).

SettingsClientOptions

Volitelné parametry akceptované klientem KeyVaultSettingsClient.

UpdateSettingOptions

Rozhraní představující volitelné parametry, které lze předat updateSetting

Aliasy typu

KeyVaultBackupOperationState

Rozhraní představující veřejně dostupné vlastnosti stavu operace dotazování služby Key Vault zálohy.

KeyVaultDataAction

Podporovaná oprávnění pro akce dat
<xref:KnownDataAction> lze použít zaměnitelně s DataAction, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

Microsoft.KeyVault/managedHsm/keys/read/action: Čtení metadat klíčů HSM.
Microsoft.KeyVault/managedHsm/keys/write/action: Aktualizace klíče HSM.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/read/action: Čtení odstraněného klíče HSM
Microsoft.KeyVault/managedHsm/keys/deletedKeys/recover/action: Obnovení odstraněného klíče HSM.
Microsoft.KeyVault/managedHsm/keys/backup/action: Zálohování klíčů HSM.
Microsoft.KeyVault/managedHsm/keys/restore/action: Obnovení klíčů HSM.
Microsoft.KeyVault/managedHsm/roleAssignments/delete/action: Odstranění přiřazení role.
Microsoft.KeyVault/managedHsm/roleAssignments/read/action: Získání přiřazení role.
Microsoft.KeyVault/managedHsm/roleAssignments/write/action: Vytvoření nebo aktualizace přiřazení role.
Microsoft.KeyVault/managedHsm/roleDefinitions/read/action: Získání definice role.
Microsoft.KeyVault/managedHsm/roleDefinitions/write/action: Vytvoření nebo aktualizace definice role.
Microsoft.KeyVault/managedHsm/roleDefinitions/delete/action: Odstranit definici role.
Microsoft.KeyVault/managedHsm/keys/encrypt/action: Šifrování pomocí klíče HSM.
Microsoft.KeyVault/managedHsm/keys/decrypt/action: Dešifrování pomocí klíče HSM.
Microsoft.KeyVault/managedHsm/keys/wrap/action: Zabalení pomocí klíče HSM.
Microsoft.KeyVault/managedHsm/keys/unwrap/action: Rozbalení pomocí klíče HSM.
Microsoft.KeyVault/managedHsm/keys/sign/action: Podepište se pomocí klíče HSM.
Microsoft.KeyVault/managedHsm/keys/verify/action: Ověřte použití klíče HSM.
Microsoft.KeyVault/managedHsm/keys/create: Vytvořte klíč HSM.
Microsoft.KeyVault/managedHsm/keys/delete: Odstraňte klíč HSM.
Microsoft.KeyVault/managedHsm/keys/export/action: Export klíče HSM.
Microsoft.KeyVault/managedHsm/keys/release/action: Uvolněte klíč HSM pomocí funkce Secure Key Release.
Microsoft.KeyVault/managedHsm/keys/import/action: Import klíče HSM.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/delete: Vyprázdnění odstraněného klíče HSM.
Microsoft.KeyVault/managedHsm/securitydomain/download/action: Stáhněte doménu zabezpečení HSM.
Microsoft.KeyVault/managedHsm/securitydomain/download/read: Zkontrolujte stav stahování domény zabezpečení HSM.
Microsoft.KeyVault/managedHsm/securitydomain/upload/action: Nahrajte doménu zabezpečení HSM.
Microsoft.KeyVault/managedHsm/securitydomain/upload/read: Zkontrolujte stav souboru exchange domény zabezpečení HSM.
Microsoft.KeyVault/managedHsm/securitydomain/transferkey/read: Stáhněte si klíč přenosu domény zabezpečení HSM.
Microsoft.KeyVault/managedHsm/backup/start/action: Spusťte zálohování HSM.
Microsoft.KeyVault/managedHsm/restore/start/action: Spusťte obnovení HSM.
Microsoft.KeyVault/managedHsm/backup/status/action: Přečtěte si stav zálohování HSM.
Microsoft.KeyVault/managedHsm/restore/status/action: Přečtěte si stav obnovení HSM.
Microsoft.KeyVault/managedHsm/rng/action: Generování náhodných čísel

KeyVaultRoleScope

Obor role.
<xref:KnownRoleScope> lze použít zaměnitelně s RolíScope, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

/: Globální rozsah
/keys: Rozsah klíčů

OperationStatus

Stav dlouhotrvající operace.
<xref:KnownOperationStatus> lze zaměnitelně s OperationStatus, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

InProgress: Probíhá operace.
úspěšné: Operace byla úspěšně dokončena.
Zrušeno: Operace byla zrušena.
selhalo: Operace se nezdařila.

SUPPORTED_API_VERSIONS

Podporované verze rozhraní API

Výčty

KnownKeyVaultDataAction

Podporovaná oprávnění pro akce dat

KnownKeyVaultRoleScope

Obor role.

Funkce

isBooleanSetting(KeyVaultSetting)

Určuje, jestli je daná KeyVaultSetting BooleanKeyVaultSetting, tj. má logickou hodnotu.

Proměnné

LATEST_API_VERSION

Nejnovější podporovaná verze API služby Key Vault.

SDK_VERSION

Aktuální verze Key Vault Admin SDK.

Podrobnosti funkce

isBooleanSetting(KeyVaultSetting)

Určuje, jestli je daná KeyVaultSetting BooleanKeyVaultSetting, tj. má logickou hodnotu.

function isBooleanSetting(setting: KeyVaultSetting): setting

Parametry

setting
KeyVaultSetting

Návraty

setting

Podrobnosti proměnné

LATEST_API_VERSION

Nejnovější podporovaná verze API služby Key Vault.

LATEST_API_VERSION: "2025-07-01"

Typ

"2025-07-01"

SDK_VERSION

Aktuální verze Key Vault Admin SDK.

SDK_VERSION: string

Typ

string