Delen via


@azure/keyvault-admin package

Klassen

KeyVaultAccessControlClient

KeyVaultAccessControlClient biedt methoden voor het beheren van toegangsbeheer en roltoewijzingen in een bepaald Azure Key Vault-exemplaar. De client ondersteunt het maken, ophalen en verwijderen van rollen.

KeyVaultBackupClient

KeyVaultBackupClient biedt methoden voor het genereren van back-ups en het herstellen van back-ups van een bepaald Azure Key Vault-exemplaar. Deze client ondersteunt het genereren van volledige back-ups, selectieve herstelbewerkingen van specifieke sleutels en volledige herstelbewerkingen van Key Vault-exemplaren.

KeyVaultSettingsClient

KeyVaultSettingsClient biedt asynchrone methoden voor het maken, bijwerken, ophalen en weergeven van instellingen voor Azure Key Vault.

Interfaces

AccessControlClientOptions

De optionele parameters die worden geaccepteerd door de AccessControlClient van Key Vault

BooleanKeyVaultSetting

Een Key Vault-instelling van het booleaanse type. Als u wilt controleren of een bepaalde KeyVaultSetting een Booleaanse waarde is, gebruikt u BooleaanseSetting-.

CreateRoleAssignmentOptions

Een interface die de optionele parameters vertegenwoordigt die kunnen worden doorgegeven aan createRoleAssignment(string, string, string, string, CreateRoleAssignmentOptions)

DeleteRoleAssignmentOptions

Een interface die de optionele parameters vertegenwoordigt die kunnen worden doorgegeven aan deleteRoleAssignment(string, string, DeleteRoleAssignmentOptions)

DeleteRoleDefinitionOptions

Een interface die optionele parameters vertegenwoordigt die worden doorgegeven aan deleteRoleDefinition(string, string, DeleteRoleDefinitionOptions).

GetRoleAssignmentOptions

Een interface die de optionele parameters vertegenwoordigt die kunnen worden doorgegeven aan getRoleAssignment(string, string, GetRoleAssignmentOptions)

GetRoleDefinitionOptions

Een interface die optionele parameters vertegenwoordigt die worden doorgegeven aan getRoleDefinition(string, string, GetRoleDefinitionOptions).

GetSettingOptions

Een interface die de optionele parameters vertegenwoordigt die kunnen worden doorgegeven aan getSetting-

KeyVaultAdminPollOperationState

Een interface die de status van de bewerking van een Key Vault-beheerder poller vertegenwoordigt.

KeyVaultBackupClientOptions

De optionele parameters die door de KeyVaultBackupClient worden geaccepteerd

KeyVaultBackupPollerOptions

Een interface die de optionele parameters vertegenwoordigt die kunnen worden doorgegeven aan beginBackup(string, string, KeyVaultBeginBackupOptions)

KeyVaultBackupResult

Een interface die het resultaat van een back-upbewerking weergeeft.

KeyVaultBeginBackupOptions

Een interface die de optionele parameters vertegenwoordigt die kunnen worden doorgegeven aan beginBackup(string, string, KeyVaultBeginBackupOptions)

KeyVaultBeginRestoreOptions

Een interface die de optionele parameters vertegenwoordigt die kunnen worden doorgegeven aan beginRestore(string, string, KeyVaultBeginRestoreOptions)

KeyVaultBeginSelectiveKeyRestoreOptions

Een interface die de optionele parameters vertegenwoordigt die kunnen worden doorgegeven aan beginSelectiveKeyRestore(string, string, string, KeyVaultBeginSelectiveKeyRestoreOptions)

KeyVaultPermission

Een lijst met Key Vault-machtigingen.

KeyVaultRestoreOperationState

Een interface die de openbaar beschikbare eigenschappen van de status van de poll-bewerking van een herstelsleutelkluis vertegenwoordigt.

KeyVaultRestoreResult

Een interface die het resultaat van een herstelbewerking weergeeft.

KeyVaultRoleAssignment

Een Key Vault-roltoewijzing.

KeyVaultRoleAssignmentProperties

Eigenschappen van roltoewijzing.

KeyVaultRoleDefinition

Een Key Vault-roldefinitie.

KeyVaultSelectiveKeyRestoreOperationState

Een interface die de openbaar beschikbare eigenschappen van de status van de poll-bewerking van een herstelsleutelkluis vertegenwoordigt.

KeyVaultSelectiveKeyRestoreResult

Een interface die het resultaat van een herstelbewerking voor selectieve sleutels weergeeft.

KeyVaultSetting

Een Key Vault-instelling.

ListRoleAssignmentsOptions

Een interface die optionele parameters vertegenwoordigt die worden doorgegeven aan listRoleAssignments(string, ListRoleAssignmentsOptions).

ListRoleAssignmentsPageSettings

Argumenten voor het ophalen van de volgende pagina met zoekresultaten.

ListRoleDefinitionsOptions

Een interface die optionele parameters vertegenwoordigt die worden doorgegeven aan listRoleDefinitions(string, ListRoleDefinitionsOptions).

ListRoleDefinitionsPageSettings

Argumenten voor het ophalen van de volgende pagina met zoekresultaten.

ListSettingsOptions

Een interface die de optionele parameters vertegenwoordigt die kunnen worden doorgegeven aan <xref:KeyVaultSettingsClient.listSettings>

ListSettingsResponse

Een interface die het antwoord vertegenwoordigt dat wordt geretourneerd door <xref:KeyVaultSettingsClient.listSettings>

SetRoleDefinitionOptions

Een interface die optionele parameters vertegenwoordigt die worden doorgegeven aan setRoleDefinition(string, SetRoleDefinitionOptions).

SettingsClientOptions

De optionele parameters die worden geaccepteerd door de KeyVaultSettingsClient.

UpdateSettingOptions

Een interface die de optionele parameters vertegenwoordigt die kunnen worden doorgegeven aan updateSetting-

Type-aliassen

KeyVaultBackupOperationState

Een interface die de openbaar beschikbare eigenschappen van de status van de poll-bewerking van een back-upsleutelkluis vertegenwoordigt.

KeyVaultDataAction

Definieert waarden voor DataAction.
<xref:KnownDataAction> kan door elkaar worden gebruikt met DataAction, bevat dit enum de bekende waarden die door de service worden ondersteund.

Bekende waarden die door de service worden ondersteund

Microsoft.KeyVault/managedHsm/keys/read/action: metagegevens van HSM-sleutels lezen.
Microsoft.KeyVault/managedHsm/keys/write/action: Een HSM-sleutel bijwerken.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/read/action: Verwijderde HSM-sleutel lezen.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/recover/action: Verwijderde HSM-sleutel herstellen.
Microsoft.KeyVault/managedHsm/keys/backup/action: Back-up van HSM-sleutels.
Microsoft.KeyVault/managedHsm/keys/restore/action: HSM-sleutels herstellen.
Microsoft.KeyVault/managedHsm/roleAssignments/delete/action: Roltoewijzing verwijderen.
Microsoft.KeyVault/managedHsm/roleAssignments/read/action: Roltoewijzing ophalen.
Microsoft.KeyVault/managedHsm/roleAssignments/write/action: Roltoewijzing maken of bijwerken.
Microsoft.KeyVault/managedHsm/roleDefinitions/read/action: Roldefinitie ophalen.
Microsoft.KeyVault/managedHsm/roleDefinitions/write/action: Roldefinitie maken of bijwerken.
Microsoft.KeyVault/managedHsm/roleDefinitions/delete/action: Roldefinitie verwijderen.
Microsoft.KeyVault/managedHsm/keys/encrypt/action: Versleutelen met behulp van een HSM-sleutel.
Microsoft.KeyVault/managedHsm/keys/decrypt/action: Ontsleutelen met behulp van een HSM-sleutel.
Microsoft.KeyVault/managedHsm/keys/wrap/action: Verpakken met behulp van een HSM-sleutel.
Microsoft.KeyVault/managedHsm/keys/unwrap/action: Uitpakken met behulp van een HSM-sleutel.
Microsoft.KeyVault/managedHsm/keys/sign/action: Sign using an HSM key.
Microsoft.KeyVault/managedHsm/keys/verify/action: Verifiëren met behulp van een HSM-sleutel.
Microsoft.KeyVault/managedHsm/keys/create: Maak een HSM-sleutel.
Microsoft.KeyVault/managedHsm/keys/delete: Een HSM-sleutel verwijderen.
Microsoft.KeyVault/managedHsm/keys/export/action: Een HSM-sleutel exporteren.
Microsoft.KeyVault/managedHsm/keys/release/action: Een HSM-sleutel vrijgeven met behulp van Secure Key Release.
Microsoft.KeyVault/managedHsm/keys/import/action: Een HSM-sleutel importeren.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/delete: Verwijder een verwijderde HSM-sleutel.
Microsoft.KeyVault/managedHsm/securitydomain/download/action: Een HSM-beveiligingsdomein downloaden.
Microsoft.KeyVault/managedHsm/securitydomain/download/read: Controleer de status van het downloaden van het HSM-beveiligingsdomein.
Microsoft.KeyVault/managedHsm/securitydomain/upload/action: Upload een HSM-beveiligingsdomein.
Microsoft.KeyVault/managedHsm/securitydomain/upload/read: Controleer de status van het exchange-bestand van het HSM-beveiligingsdomein.
Microsoft.KeyVault/managedHsm/securitydomain/transferkey/read: Download een HSM-sleutel voor de overdracht van een beveiligingsdomein.
Microsoft.KeyVault/managedHsm/backup/start/action: Een HSM-back-up starten.
Microsoft.KeyVault/managedHsm/restore/start/action: Start een HSM-herstel.
Microsoft.KeyVault/managedHsm/backup/status/action: lees de status van een HSM-back-up.
Microsoft.KeyVault/managedHsm/restore/status/action: Lees de status van een HSM-herstel.
Microsoft.KeyVault/managedHsm/rng/action: Willekeurige getallen genereren.

KeyVaultRoleScope

Definieert waarden voor RoleScope.
<xref:KnownRoleScope> kan door elkaar worden gebruikt met RoleScope, bevat deze enum de bekende waarden die door de service worden ondersteund.

Bekende waarden die door de service worden ondersteund

/: globaal bereik
/keys: Sleutelsbereik

SUPPORTED_API_VERSIONS

Ondersteunde API-versies

Enums

KnownKeyVaultDataAction

Bekende waarden van KeyVaultDataAction die de service accepteert.

KnownKeyVaultRoleScope

Bekende waarden van KeyVaultRoleScope die de service accepteert.

Functies

isBooleanSetting(KeyVaultSetting)

Bepaalt of een gegeven KeyVaultSetting- een BooleanKeyVaultSetting-is, dat wil weten een booleaanse waarde heeft.

Functiedetails

isBooleanSetting(KeyVaultSetting)

Bepaalt of een gegeven KeyVaultSetting- een BooleanKeyVaultSetting-is, dat wil weten een booleaanse waarde heeft.

function isBooleanSetting(setting: KeyVaultSetting): setting

Parameters

setting
KeyVaultSetting

Retouren

setting