Udostępnij za pośrednictwem


@azure/keyvault-admin package

Klasy

KeyVaultAccessControlClient

Obiekt KeyVaultAccessControlClient udostępnia metody zarządzania kontrolą dostępu i przypisaniami ról w dowolnym wystąpieniu usługi Azure Key Vault. Klient obsługuje tworzenie, pobieranie i usuwanie ról.

KeyVaultBackupClient

Klasa KeyVaultBackupClient udostępnia metody generowania kopii zapasowych i przywracania kopii zapasowych dowolnego wystąpienia usługi Azure Key Vault. Ten klient obsługuje generowanie pełnych kopii zapasowych, selektywne przywracanie określonych kluczy i pełne przywracanie wystąpień usługi Key Vault.

KeyVaultSettingsClient

Obiekt KeyVaultSettingsClient udostępnia metody asynchroniczne służące do tworzenia, aktualizowania, pobierania i wyświetlania listy ustawień usługi Azure Key Vault.

Interfejsów

AccessControlClientOptions

Opcjonalne parametry akceptowane przez element AccessControlClient usługi Key Vault

BooleanKeyVaultSetting

Ustawienie usługi Key Vault typu logicznego. Aby sprawdzić, czy dany parametr KeyVaultSetting jest wartością logiczną, użyj isBooleanSetting.

CreateRoleAssignmentOptions

Interfejs reprezentujący parametry opcjonalne, które można przekazać do createRoleAssignment(string, string, string, string, CreateRoleAssignmentOptions)

DeleteRoleAssignmentOptions

Interfejs reprezentujący parametry opcjonalne, które można przekazać do deleteRoleAssignment(string, string, DeleteRoleAssignmentOptions)

DeleteRoleDefinitionOptions

Interfejs reprezentujący parametry opcjonalne przekazane do deleteRoleDefinition(string, string, DeleteRoleDefinitionOptions).

GetRoleAssignmentOptions

Interfejs reprezentujący parametry opcjonalne, które można przekazać do getRoleAssignment(string, string, GetRoleAssignmentOptions)

GetRoleDefinitionOptions

Interfejs reprezentujący parametry opcjonalne przekazane do getRoleDefinition(string, string, GetRoleDefinitionOptions).

GetSettingOptions

Interfejs reprezentujący parametry opcjonalne, które można przekazać do getSetting

KeyVaultAdminPollOperationState

Interfejs reprezentujący stan operacji administratora usługi Key Vault.

KeyVaultBackupClientOptions

Opcjonalne parametry akceptowane przez element KeyVaultBackupClient

KeyVaultBackupPollerOptions

Interfejs reprezentujący parametry opcjonalne, które można przekazać do beginBackup(string, string, KeyVaultBeginBackupOptions)

KeyVaultBackupResult

Interfejs reprezentujący wynik operacji tworzenia kopii zapasowej.

KeyVaultBeginBackupOptions

Interfejs reprezentujący opcjonalne parametry, które można przekazać do beginBackup

KeyVaultBeginPreBackupOptions

Interfejs reprezentujący parametry opcjonalne, które można przekazać do beginPreBackup

KeyVaultBeginPreRestoreOptions

Interfejs reprezentujący parametry opcjonalne, które można przekazać do beginPreRestore

KeyVaultBeginRestoreOptions

Interfejs reprezentujący parametry opcjonalne, które można przekazać do beginRestore

KeyVaultBeginSelectiveKeyRestoreOptions

Interfejs reprezentujący opcjonalne parametry, które można przekazać do beginSelectiveKeyRestore

KeyVaultPermission

Lista uprawnień usługi Key Vault.

KeyVaultRestoreOperationState

Interfejs reprezentujący publicznie dostępne właściwości stanu operacji sondowania usługi Key Vault.

KeyVaultRestoreResult

Interfejs reprezentujący wynik operacji przywracania.

KeyVaultRoleAssignment

Przypisanie roli usługi Key Vault.

KeyVaultRoleAssignmentProperties

Właściwości przypisania roli.

KeyVaultRoleDefinition

Definicja roli usługi Key Vault.

KeyVaultSelectiveKeyRestoreOperationState

Interfejs reprezentujący publicznie dostępne właściwości stanu operacji sondowania usługi Key Vault.

KeyVaultSelectiveKeyRestoreResult

Interfejs reprezentujący wynik operacji przywracania klucza selektywnego.

KeyVaultSetting

Ustawienie usługi Key Vault.

ListRoleAssignmentsOptions

Interfejs reprezentujący parametry opcjonalne przekazane do listRoleAssignments(string, ListRoleAssignmentsOptions).

ListRoleAssignmentsPageSettings

Argumenty pobierania następnej strony wyników wyszukiwania.

ListRoleDefinitionsOptions

Interfejs reprezentujący parametry opcjonalne przekazane do listRoleDefinitions(string, ListRoleDefinitionsOptions).

ListRoleDefinitionsPageSettings

Argumenty pobierania następnej strony wyników wyszukiwania.

ListSettingsOptions

Interfejs reprezentujący parametry opcjonalne, które można przekazać do <xref:KeyVaultSettingsClient.listSettings>

ListSettingsResponse

Interfejs reprezentujący odpowiedź zwróconą przez <xref:KeyVaultSettingsClient.listSettings>

PollerLike

Prosty poller, który może służyć do sondowania długotrwałej operacji.

SetRoleDefinitionOptions

Interfejs reprezentujący parametry opcjonalne przekazane do setRoleDefinition(string, SetRoleDefinitionOptions).

SettingsClientOptions

Opcjonalne parametry akceptowane przez element KeyVaultSettingsClient.

UpdateSettingOptions

Interfejs reprezentujący parametry opcjonalne, które można przekazać do updateSetting

Aliasy typu

KeyVaultBackupOperationState

Interfejs reprezentujący publicznie dostępne właściwości stanu operacji sondowania usługi Key Vault kopii zapasowej.

KeyVaultDataAction

Obsługiwane uprawnienia dla akcji danych.
<xref:KnownDataAction> można używać zamiennie z funkcją DataAction, wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

Microsoft.KeyVault/managedHsm/keys/read/action: Odczyt metadanych klucza HSM.
Microsoft.KeyVault/managedHsm/keys/write/action: Zaktualizuj klucz HSM.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/read/action: Odczyt usunięty klucz HSM.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/recover/action: Odzyskaj usunięty klucz HSM.
Microsoft.KeyVault/managedHsm/keys/backup/action: Tworzenie kopii zapasowych kluczy HSM.
Microsoft.KeyVault/managedHsm/keys/restore/action: Przywracanie kluczy HSM.
Microsoft.KeyVault/managedHsm/roleAssignments/delete/action: Usuń przypisanie roli.
Microsoft.KeyVault/managedHsm/roleAssignments/read/action: Pobierz przypisanie roli.
Microsoft.KeyVault/managedHsm/roleAssignments/write/action: Tworzenie lub aktualizowanie przypisania roli.
Microsoft.KeyVault/managedHsm/roleDefinitions/read/action: Pobierz definicję roli.
Microsoft.KeyVault/managedHsm/roleDefinitions/write/action: Tworzenie lub aktualizowanie definicji roli.
Microsoft.KeyVault/managedHsm/roleDefinitions/delete/action: Usuń definicję roli.
Microsoft.KeyVault/managedHsm/keys/encrypt/action: Szyfruj przy użyciu klucza HSM.
Microsoft.KeyVault/managedHsm/keys/decrypt/action: Odszyfruj przy użyciu klucza HSM.
Microsoft.KeyVault/managedHsm/keys/wrap/action: Zawijaj przy użyciu klucza HSM.
Microsoft.KeyVault/managedHsm/keys/unwrap/action: Odpakowywanie przy użyciu klucza HSM.
Microsoft.KeyVault/managedHsm/keys/sign/action: Podpisywanie przy użyciu klucza HSM.
Microsoft.KeyVault/managedHsm/keys/verify/action: Sprawdź przy użyciu klucza HSM.
Microsoft.KeyVault/managedHsm/keys/create: Utwórz klucz HSM.
Microsoft.KeyVault/managedHsm/keys/delete: Usuń klucz HSM.
Microsoft.KeyVault/managedHsm/keys/export/action: Eksportuj klucz HSM.
Microsoft.KeyVault/managedHsm/keys/release/action: Zwolnij klucz HSM przy użyciu bezpiecznego wydania klucza.
Microsoft.KeyVault/managedHsm/keys/import/action: Zaimportuj klucz HSM.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/delete: Przeczyść usunięty klucz HSM.
Microsoft.KeyVault/managedHsm/securitydomain/download/action: Pobierz domenę zabezpieczeń modułu HSM.
Microsoft.KeyVault/managedHsm/securitydomain/download/read: Sprawdź stan pobierania domeny zabezpieczeń modułu HSM.
Microsoft.KeyVault/managedHsm/securitydomain/upload/action: Przekaż domenę zabezpieczeń modułu HSM.
Microsoft.KeyVault/managedHsm/securitydomain/upload/read: Sprawdź stan pliku wymiany domeny zabezpieczeń modułu HSM.
Microsoft.KeyVault/managedHsm/securitydomain/transferkey/read: pobierz klucz transferu domeny zabezpieczeń HSM.
Microsoft.KeyVault/managedHsm/backup/start/action: Uruchamianie kopii zapasowej modułu HSM.
Microsoft.KeyVault/managedHsm/restore/start/action: Uruchom przywracanie modułu HSM.
Microsoft.KeyVault/managedHsm/backup/status/action: Odczyt stanu kopii zapasowej modułu HSM.
Microsoft.KeyVault/managedHsm/restore/status/action: Odczyt stanu przywracania modułu HSM.
Microsoft.KeyVault/managedHsm/rng/action: Generuj liczby losowe.

KeyVaultRoleScope

Zakres roli.
<xref:KnownRoleScope> można używać zamiennie z RoleScope, wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

/: zakres globalny
/keys: Zakres kluczy

OperationStatus

Stan długotrwałej operacji.
<xref:KnownOperationStatus> można używać zamiennie z operacją OperationStatus, wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

InProgress: operacja jest w toku.
Powodzenie: operacja została ukończona pomyślnie.
anulowane: operacja została anulowana.
Niepowodzenie: operacja nie powiodła się.

SUPPORTED_API_VERSIONS

Obsługiwane wersje interfejsu API

Enums

KnownKeyVaultDataAction

Obsługiwane uprawnienia dla akcji danych.

KnownKeyVaultRoleScope

Zakres roli.

Functions

isBooleanSetting(KeyVaultSetting)

Określa, czy dana KeyVaultSetting jest wartością logiczną Wartość logicznaKeyVaultSetting, tj. ma wartość logiczną.

Zmiennych

LATEST_API_VERSION

Najnowsza obsługiwana wersja API usługi Key Vault.

SDK_VERSION

Aktualna wersja Key Vault Admin SDK.

Szczegóły funkcji

isBooleanSetting(KeyVaultSetting)

Określa, czy dana KeyVaultSetting jest wartością logiczną Wartość logicznaKeyVaultSetting, tj. ma wartość logiczną.

function isBooleanSetting(setting: KeyVaultSetting): setting

Parametry

setting
KeyVaultSetting

Zwraca

setting

Variable Details

LATEST_API_VERSION

Najnowsza obsługiwana wersja API usługi Key Vault.

LATEST_API_VERSION: "7.6"

Typ

"7.6"

SDK_VERSION

Aktualna wersja Key Vault Admin SDK.

SDK_VERSION: string

Typ

string