@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 Známé hodnoty podporované službou
Microsoft.KeyVault/managedHsm/keys/read/action: Čtení metadat klíčů HSM. |
| KeyVaultRoleScope |
Obor role. Známé hodnoty podporované službou
/: Globální rozsah |
| OperationStatus |
Stav dlouhotrvající operace. Známé hodnoty podporované službou
InProgress: Probíhá operace. |
| SUPPORTED_API_VERSIONS |
Podporované verze rozhraní API |
Výčty
| KnownKeyVaultDataAction |
Podporovaná oprávnění pro akce dat |
| KnownKeyVaultRoleScope |
Obor role. |
Funkce
| is |
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