@azure/keyvault-admin package

Kelas

KeyVaultAccessControlClient

KeyVaultAccessControlClient menyediakan metode untuk mengelola kontrol akses dan penetapan peran dalam instans Azure Key Vault tertentu. Klien mendukung pembuatan, pengambilan, dan penghapusan peran.

KeyVaultBackupClient

KeyVaultBackupClient menyediakan metode untuk menghasilkan cadangan dan memulihkan cadangan instans Azure Key Vault tertentu. Klien ini mendukung pembuatan cadangan penuh, pemulihan selektif kunci tertentu, dan pemulihan penuh instans Key Vault.

KeyVaultSettingsClient

KeyVaultSettingsClient menyediakan metode asinkron untuk membuat, memperbarui, mendapatkan, dan mencantumkan pengaturan untuk Azure Key Vault.

Antarmuka

AccessControlClientOptions

Parameter opsional yang diterima oleh AccessControlClient Key Vault

BooleanKeyVaultSetting

Pengaturan Key Vault dari jenis boolean. Untuk memeriksa apakah KeyVaultSetting tertentu adalah boolean, gunakan isBooleanSetting.

CreateRoleAssignmentOptions

Antarmuka yang mewakili parameter opsional yang dapat diteruskan ke createRoleAssignment(string, string, string, string, CreateRoleAssignmentOptions)

DeleteRoleAssignmentOptions

Antarmuka yang mewakili parameter opsional yang dapat diteruskan ke deleteRoleAssignment(string, string, DeleteRoleAssignmentOptions)

DeleteRoleDefinitionOptions

Antarmuka yang mewakili parameter opsional yang diteruskan ke deleteRoleDefinition(string, string, DeleteRoleDefinitionOptions).

GetRoleAssignmentOptions

Antarmuka yang mewakili parameter opsional yang dapat diteruskan ke getRoleAssignment(string, string, GetRoleAssignmentOptions)

GetRoleDefinitionOptions

Antarmuka yang mewakili parameter opsional yang diteruskan ke getRoleDefinition(string, string, GetRoleDefinitionOptions).

GetSettingOptions

Antarmuka yang mewakili parameter opsional yang dapat diteruskan ke getSetting

KeyVaultAdminPollOperationState

Antarmuka yang mewakili status operasi Key Vault Admin Poller.

KeyVaultBackupClientOptions

Parameter opsional yang diterima oleh KeyVaultBackupClient

KeyVaultBackupPollerOptions

Antarmuka yang mewakili parameter opsional yang dapat diteruskan ke beginBackup(string, string, KeyVaultBeginBackupOptions)

KeyVaultBackupResult

Antarmuka yang mewakili hasil operasi pencadangan.

KeyVaultBeginBackupOptions

Antarmuka yang mewakili parameter opsional yang dapat diteruskan ke beginBackup

KeyVaultBeginPreBackupOptions

Antarmuka yang mewakili parameter opsional yang dapat diteruskan ke beginPreBackup

KeyVaultBeginPreRestoreOptions

Antarmuka yang mewakili parameter opsional yang dapat diteruskan ke beginPreRestore

KeyVaultBeginRestoreOptions

Antarmuka yang mewakili parameter opsional yang dapat diteruskan ke beginRestore

KeyVaultBeginSelectiveKeyRestoreOptions

Antarmuka yang mewakili parameter opsional yang dapat diteruskan ke beginSelectiveKeyRestore

KeyVaultPermission

Daftar izin Key Vault.

KeyVaultRestoreOperationState

Antarmuka yang mewakili properti yang tersedia untuk umum dari status operasi polling Key Vault pemulihan.

KeyVaultRestoreResult

Antarmuka yang mewakili hasil operasi pemulihan.

KeyVaultRoleAssignment

Penetapan peran Key Vault.

KeyVaultRoleAssignmentProperties

Properti penetapan peran.

KeyVaultRoleDefinition

Definisi peran Key Vault.

KeyVaultSelectiveKeyRestoreOperationState

Antarmuka yang mewakili properti yang tersedia untuk umum dari status operasi polling Key Vault pemulihan.

KeyVaultSelectiveKeyRestoreResult

Antarmuka yang mewakili hasil operasi pemulihan kunci selektif.

KeyVaultSetting

Pengaturan Key Vault.

ListRoleAssignmentsOptions

Antarmuka yang mewakili parameter opsional yang diteruskan ke listRoleAssignments(string, ListRoleAssignmentsOptions).

ListRoleAssignmentsPageSettings

Argumen untuk mengambil halaman hasil pencarian berikutnya.

ListRoleDefinitionsOptions

Antarmuka yang mewakili parameter opsional yang diteruskan ke listRoleDefinitions(string, ListRoleDefinitionsOptions).

ListRoleDefinitionsPageSettings

Argumen untuk mengambil halaman hasil pencarian berikutnya.

ListSettingsOptions

Antarmuka yang mewakili parameter opsional yang dapat diteruskan ke <xref:KeyVaultSettingsClient.listSettings>

ListSettingsResponse

Antarmuka yang mewakili respons yang dikembalikan oleh <xref:KeyVaultSettingsClient.listSettings>

PollerLike

Poller sederhana yang dapat digunakan untuk melakukan polling operasi jangka panjang.

SetRoleDefinitionOptions

Antarmuka yang mewakili parameter opsional yang diteruskan ke setRoleDefinition(string, SetRoleDefinitionOptions).

SettingsClientOptions

Parameter opsional yang diterima oleh KeyVaultSettingsClient.

UpdateSettingOptions

Antarmuka yang mewakili parameter opsional yang dapat diteruskan ke updateSetting

Alias Jenis

KeyVaultBackupOperationState

Antarmuka yang mewakili properti yang tersedia untuk umum dari status operasi polling Key Vault cadangan.

KeyVaultDataAction

Izin yang didukung untuk tindakan data.
<xref:KnownDataAction> dapat digunakan secara bergantian dengan DataAction, enum ini berisi nilai yang diketahui yang didukung layanan.

Nilai yang diketahui didukung oleh layanan

Microsoft.KeyVault/managedHsm/keys/read/action: Baca metadata kunci HSM.
Microsoft.KeyVault/managedHsm/keys/write/action: Perbarui kunci HSM.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/read/action: Membaca kunci HSM yang dihapus.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/recover/action: Memulihkan kunci HSM yang dihapus.
Microsoft.KeyVault/managedHsm/keys/backup/action: Kunci HSM cadangan.
Microsoft.KeyVault/managedHsm/keys/restore/action: Pulihkan kunci HSM.
Microsoft.KeyVault/managedHsm/roleAssignments/delete/action: Hapus penetapan peran.
Microsoft.KeyVault/managedHsm/roleAssignments/read/action: Dapatkan penetapan peran.
Microsoft.KeyVault/managedHsm/roleAssignments/write/action: Membuat atau memperbarui penetapan peran.
Microsoft.KeyVault/managedHsm/roleDefinitions/read/action: Dapatkan definisi peran.
Microsoft.KeyVault/managedHsm/roleDefinitions/write/action: Membuat atau memperbarui definisi peran.
Microsoft.KeyVault/managedHsm/roleDefinitions/delete/action: Hapus definisi peran.
Microsoft.KeyVault/managedHsm/keys/encrypt/action: Enkripsi menggunakan kunci HSM.
Microsoft.KeyVault/managedHsm/keys/decrypt/action: Dekripsi menggunakan kunci HSM.
Microsoft.KeyVault/managedHsm/keys/wrap/action: Bungkus menggunakan kunci HSM.
Microsoft.KeyVault/managedHsm/keys/unwrap/action: Buka bungkus menggunakan kunci HSM.
Microsoft.KeyVault/managedHsm/keys/sign/action: Masuk menggunakan kunci HSM.
Microsoft.KeyVault/managedHsm/keys/verify/action: Verifikasi menggunakan kunci HSM.
Microsoft.KeyVault/managedHsm/keys/create: Buat kunci HSM.
Microsoft.KeyVault/managedHsm/keys/delete: Hapus kunci HSM.
Microsoft.KeyVault/managedHsm/keys/export/action: Ekspor kunci HSM.
Microsoft.KeyVault/managedHsm/keys/release/action: Merilis kunci HSM menggunakan Secure Key Release.
Microsoft.KeyVault/managedHsm/keys/import/action: Impor kunci HSM.
Microsoft.KeyVault/managedHsm/keys/deletedKeys/delete: Hapus menyeluruh kunci HSM yang dihapus.
Microsoft.KeyVault/managedHsm/securitydomain/download/action: Unduh domain keamanan HSM.
Microsoft.KeyVault/managedHsm/securitydomain/download/read: Periksa status unduhan domain keamanan HSM.
Microsoft.KeyVault/managedHsm/securitydomain/upload/action: Unggah domain keamanan HSM.
Microsoft.KeyVault/managedHsm/securitydomain/upload/read: Periksa status file pertukaran domain keamanan HSM.
Microsoft.KeyVault/managedHsm/securitydomain/transferkey/read: Unduh kunci transfer domain keamanan HSM.
Microsoft.KeyVault/managedHsm/backup/start/action: Mulai pencadangan HSM.
Microsoft.KeyVault/managedHsm/restore/start/action: Mulai pemulihan HSM.
Microsoft.KeyVault/managedHsm/backup/status/action: Membaca status pencadangan HSM.
Microsoft.KeyVault/managedHsm/restore/status/action: Membaca status pemulihan HSM.
Microsoft.KeyVault/managedHsm/rng/action: Hasilkan angka acak.

KeyVaultRoleScope

Cakupan peran.
<xref:KnownRoleScope> dapat digunakan secara bergantian dengan RoleScope, enum ini berisi nilai yang diketahui yang didukung layanan.

Nilai yang diketahui didukung oleh layanan

/: Cakupan global
/keys: Cakupan kunci

OperationStatus

Status operasi yang berjalan lama.
<xref:KnownOperationStatus> dapat digunakan secara bergantian dengan OperationStatus, enum ini berisi nilai yang diketahui yang didukung layanan.

Nilai yang diketahui didukung oleh layanan

InProgress : Operasi sedang berlangsung.
Berhasil: Operasi berhasil diselesaikan.
Dibatalkan: Operasi dibatalkan.
Gagal: Operasi gagal.

SUPPORTED_API_VERSIONS

Versi API yang didukung

Enum

KnownKeyVaultDataAction

Izin yang didukung untuk tindakan data.

KnownKeyVaultRoleScope

Cakupan peran.

Fungsi

isBooleanSetting(KeyVaultSetting)

Menentukan apakah KeyVaultSetting tertentu adalah BooleanKeyVaultSetting, yaitu memiliki nilai boolean.

Variabel

LATEST_API_VERSION

Versi API layanan Key Vault terbaru yang didukung.

SDK_VERSION

Versi terbaru dari Key Vault Admin SDK.

Detail Fungsi

isBooleanSetting(KeyVaultSetting)

Menentukan apakah KeyVaultSetting tertentu adalah BooleanKeyVaultSetting, yaitu memiliki nilai boolean.

function isBooleanSetting(setting: KeyVaultSetting): setting

Parameter

setting
KeyVaultSetting

Mengembalikan

setting

Detail Variabel

LATEST_API_VERSION

Versi API layanan Key Vault terbaru yang didukung.

LATEST_API_VERSION: "2025-07-01"

Jenis

"2025-07-01"

SDK_VERSION

Versi terbaru dari Key Vault Admin SDK.

SDK_VERSION: string

Jenis

string