@azure/keyvault-secrets package

Kelas

SecretClient

SecretClient menyediakan metode untuk mengelola KeyVaultSecret di Azure Key Vault. Klien mendukung pembuatan, pengambilan, pembaruan, penghapusan, pembersihan, pencadangan, pemulihan, dan daftar KeyVaultSecrets. Klien juga mendukung daftar DeletedSecret untuk Azure Key Vault yang diaktifkan penghapusan sementara.

Antarmuka

BackupSecretOptions	Opsi untuk <xref:backupSecretOptions>.
BeginDeleteSecretOptions	Antarmuka yang mewakili parameter opsional yang dapat diteruskan ke beginDeleteSecret(string, BeginDeleteSecretOptions)
BeginRecoverDeletedSecretOptions	Antarmuka yang mewakili parameter opsional yang dapat diteruskan ke beginRecoverDeletedSecret(string, BeginRecoverDeletedSecretOptions)
DeletedSecret	Antarmuka yang mewakili Rahasia KeyVault yang dihapus.
GetDeletedSecretOptions	Opsi untuk getDeletedSecret(string, GetDeletedSecretOptions).
GetSecretOptions	Opsi untuk getSecret(string, GetSecretOptions).
KeyVaultSecret	Antarmuka yang mewakili Rahasia KeyVault, dengan nama, nilai, dan SecretProperties.
KeyVaultSecretIdentifier	Mewakili segmen yang menyusun Id Rahasia Key Vault.
ListDeletedSecretsOptions	Opsi untuk listDeletedSecrets(ListDeletedSecretsOptions).
ListPropertiesOfSecretVersionsOptions	Opsi untuk listPropertiesOfSecretVersions(string, ListPropertiesOfSecretVersionsOptions).
ListPropertiesOfSecretsOptions	Opsi untuk listPropertiesOfSecrets(ListPropertiesOfSecretsOptions).
PageSettings	Antarmuka yang melacak pengaturan untuk iterasi halaman
PagedAsyncIterableIterator	Antarmuka yang memungkinkan iterasi yang dapat diulang asinkron baik ke penyelesaian maupun berdasarkan halaman.
PollOperationState	PollOperationState berisi daftar berpendapat dari sekumpulan properti terkecil yang diperlukan untuk menentukan poller operasi yang berjalan lama. Sementara kelas Poller berfungsi sebagai mekanisme kontrol lokal untuk mulai memicu, menunggu, dan berpotensi membatalkan operasi yang berjalan lama, PollOperationState mencocokkan status operasi jangka panjang jarak jauh. Ini harus diperbarui setidaknya ketika operasi dimulai, ketika selesai, dan ketika dibatalkan. Meskipun, implementasi dapat memiliki sejumlah properti lain yang dapat diperbarui dengan alasan lain.
PollerLike	Representasi abstrak dari poller, dimaksudkan untuk mengekspos api minimal yang perlu dikerjakan pengguna.
PurgeDeletedSecretOptions	Opsi untuk purgeDeletedSecret(string, PurgeDeletedSecretOptions).
RestoreSecretBackupOptions	Opsi untuk restoreSecretBackup(Uint8Array, RestoreSecretBackupOptions).
SecretClientOptions	Parameter opsional yang diterima oleh KeyClient KeyVault
SecretPollerOptions	Antarmuka yang mewakili parameter opsional yang dapat diteruskan ke beginDeleteSecret(string, BeginDeleteSecretOptions) dan <xref:beginRecoverDeletedKey>.
SecretProperties	Antarmuka yang mewakili properti KeyVaultSecret.
SetSecretOptions	Opsi untuk setSecret(string, string, SetSecretOptions).
UpdateSecretPropertiesOptions	Opsi untuk updateSecretProperties(string, string, UpdateSecretPropertiesOptions).

Alias Jenis

DeletionRecoveryLevel

Mencerminkan tingkat pemulihan penghapusan yang saat ini berlaku untuk rahasia di vault saat ini. Jika berisi 'Dapat Dihapus Menyeluruh', rahasia dapat dihapus secara permanen oleh pengguna istimewa; jika tidak, hanya sistem yang dapat menghapus menyeluruh rahasia, di akhir interval retensi. KnownDeletionRecoveryLevel dapat digunakan secara bergantian dengan DeletionRecoveryLevel, enum ini berisi nilai yang diketahui yang didukung layanan. Nilai yang diketahui didukung oleh layanan dapat dibersihkan: Menunjukkan status vault di mana penghapusan adalah operasi yang tidak dapat diubah, tanpa kemungkinan untuk pemulihan. Tingkat ini sesuai dengan tidak ada perlindungan yang tersedia terhadap operasi Hapus; data hilang secara tidak dapat diambil setelah menerima operasi Hapus di tingkat entitas atau yang lebih tinggi (vault, grup sumber daya, langganan, dll.) Recoverable+Purgeable: Menunjukkan status vault di mana penghapusan dapat dipulihkan, dan yang juga mengizinkan penghapusan segera dan permanen (yaitu pembersihan). Tingkat ini menjamin pemulihan entitas yang dihapus selama interval retensi (90 hari), kecuali operasi Pembersihan diminta, atau langganan dibatalkan. Sistem menghapusnya secara permanen setelah 90 hari, jika tidak dipulihkan yang Dapat Dipulihkan : Menunjukkan status brankas di mana penghapusan dapat dipulihkan tanpa kemungkinan untuk penghapusan segera dan permanen (yaitu penghapusan menyeluruh). Tingkat ini menjamin pemulihan entitas yang dihapus selama interval retensi (90 hari) dan saat langganan masih tersedia. Sistem menghapusnya secara permanen setelah 90 hari, jika tidak dipulihkan Recoverable+ProtectedSubscription: Menunjukkan status vault dan langganan di mana penghapusan dapat dipulihkan dalam interval penyimpanan (90 hari), penghapusan segera dan permanen (yaitu pembersihan) tidak diizinkan, dan di mana langganan itu sendiri tidak dapat dibatalkan secara permanen. Sistem menghapusnya secara permanen setelah 90 hari, jika tidak dipulihkan CustomizedRecoverable+Purgeable: Menunjukkan status brankas di mana penghapusan dapat dipulihkan, dan yang juga mengizinkan penghapusan segera dan permanen (yaitu pembersihan saat 7 <= SoftDeleteRetentionInDays < 90). Tingkat ini menjamin pemulihan entitas yang dihapus selama interval retensi, kecuali jika operasi Pembersihan diminta, atau langganan dibatalkan. CustomizedRecoverable: Menunjukkan status vault di mana penghapusan dapat dipulihkan tanpa kemungkinan untuk penghapusan segera dan permanen (yaitu hapus menyeluruh saat 7 <= SoftDeleteRetentionInDays < 90). Tingkat ini menjamin pemulihan entitas yang dihapus selama interval retensi dan saat langganan masih tersedia. CustomizedRecoverable+ProtectedSubscription: Menunjukkan status vault dan langganan di mana penghapusan dapat dipulihkan, segera dan permanen (yaitu pembersihan) tidak diizinkan, dan di mana langganan itu sendiri tidak dapat dibatalkan secara permanen ketika 7 <= SoftDeleteRetentionInDays < 90. Tingkat ini menjamin pemulihan entitas yang dihapus selama interval retensi, dan juga mencerminkan fakta bahwa langganan itu sendiri tidak dapat dibatalkan.

Enum

KnownDeletionRecoveryLevel

Mencerminkan tingkat pemulihan penghapusan yang saat ini berlaku untuk rahasia di vault saat ini. Jika berisi 'Dapat Dihapus Menyeluruh', rahasia dapat dihapus secara permanen oleh pengguna istimewa; jika tidak, hanya sistem yang dapat menghapus menyeluruh rahasia, di akhir interval retensi.

Fungsi

parseKeyVaultSecretIdentifier(string)

Mengurai Id Rahasia Key Vault yang diberikan. Contohnya adalah: https://< keyvault-name.vault.azure.net/secrets/>< secret-name>/<unique-version-id> Pada penguraian Id di atas, fungsi ini mengembalikan: { sourceId: "https://<keyvault-name>.vault.azure.net/secrets/<secret-name>/<unique-version-id>", vaultUrl: "https://<keyvault-name>.vault.azure.net", version: "<unique-version-id>", name: "<secret-name>" }

Variabel

logger

Konfigurasi @azure/logger untuk paket ini.

Detail Fungsi

parseKeyVaultSecretIdentifier(string)

Mengurai Id Rahasia Key Vault yang diberikan. Contohnya adalah:

https://< keyvault-name.vault.azure.net/secrets/>< secret-name>/<unique-version-id>

Pada penguraian Id di atas, fungsi ini mengembalikan:

  {
     sourceId: "https://<keyvault-name>.vault.azure.net/secrets/<secret-name>/<unique-version-id>",
     vaultUrl: "https://<keyvault-name>.vault.azure.net",
     version: "<unique-version-id>",
     name: "<secret-name>"
  }

function parseKeyVaultSecretIdentifier(id: string): KeyVaultSecretIdentifier

Parameter

id

string

Id Rahasia Key Vault.

Mengembalikan

KeyVaultSecretIdentifier

Variable Details

logger

Konfigurasi @azure/logger untuk paket ini.

logger: AzureLogger

Jenis

AzureLogger