@azure/keyvault-secrets package

Sınıflar

SecretClient

SecretClient, Azure Key Vault KeyVaultSecret'i yönetmek için yöntemler sağlar. İstemci KeyVaultSecrets oluşturma, alma, güncelleştirme, silme, temizleme, yedekleme, geri yükleme ve listelemeyi destekler. İstemci, geçici silme özelliği etkinleştirilmiş bir Azure Key Vault için DeletedSecret listesini de destekler.

Arabirimler

BackupSecretOptions	için <xref:backupSecretOptions>seçenekler.
BeginDeleteSecretOptions	geçirilebilecek isteğe bağlı parametreleri temsil eden bir arabirim beginDeleteSecret(string, BeginDeleteSecretOptions)
BeginRecoverDeletedSecretOptions	geçirilebilecek isteğe bağlı parametreleri temsil eden bir arabirim beginRecoverDeletedSecret(string, BeginRecoverDeletedSecretOptions)
DeletedSecret	Silinen KeyVault Gizli Dizisini temsil eden bir arabirim.
GetDeletedSecretOptions	için getDeletedSecret(string, GetDeletedSecretOptions)seçenekler.
GetSecretOptions	için getSecret(string, GetSecretOptions)seçenekler.
KeyVaultSecret	KeyVault Gizli Dizisini, adı, değeri ve SecretProperties ile temsil eden bir arabirim.
KeyVaultSecretIdentifier	Key Vault Gizli Dizi Kimliği oluşturan kesimleri temsil eder.
ListDeletedSecretsOptions	için listDeletedSecrets(ListDeletedSecretsOptions)seçenekler.
ListPropertiesOfSecretVersionsOptions	için listPropertiesOfSecretVersions(string, ListPropertiesOfSecretVersionsOptions)seçenekler.
ListPropertiesOfSecretsOptions	için listPropertiesOfSecrets(ListPropertiesOfSecretsOptions)seçenekler.
PageSettings	Sayfalanmış yineleme ayarlarını izleyen bir arabirim
PagedAsyncIterableIterator	Hem tamamlamaya hem de sayfaya göre zaman uyumsuz yinelenebilir yinelemeye izin veren bir arabirim.
PollOperationState	PollOperationState, uzun süre çalışan işlem poller'lerini tanımlamak için gereken en küçük özellik kümesinin bir listesini içerir. Poller sınıfı, uzun süre çalışan bir işlemi tetikleme, bekleme ve potansiyel olarak iptal etme amacıyla yerel denetim mekanizması olarak çalışsa da PollOperationState, uzak uzun süre çalışan işlemin durumunu belgeler. En azından işlem başladığında, tamamlandığında ve iptal edildiğinde güncelleştirilmelidir. Ancak, uygulamalar başka nedenlerle güncelleştirilebilecek başka sayıda özelliğe sahip olabilir.
PollerLike	Kullanıcının çalışması gereken en düşük API'yi kullanıma sunma amacıyla bir poller'in soyut gösterimi.
PurgeDeletedSecretOptions	için purgeDeletedSecret(string, PurgeDeletedSecretOptions)seçenekler.
RestoreSecretBackupOptions	için restoreSecretBackup(Uint8Array, RestoreSecretBackupOptions)seçenekler.
SecretClientOptions	KeyVault KeyClient tarafından kabul edilen isteğe bağlı parametreler
SecretPollerOptions	ve <xref:beginRecoverDeletedKey>'ye beginDeleteSecret(string, BeginDeleteSecretOptions) geçirilebilen isteğe bağlı parametreleri temsil eden bir arabirim.
SecretProperties	KeyVaultSecret özelliklerini temsil eden bir arabirim.
SetSecretOptions	için setSecret(string, string, SetSecretOptions)seçenekler.
UpdateSecretPropertiesOptions	için updateSecretProperties(string, string, UpdateSecretPropertiesOptions)seçenekler.

Tür Diğer Adları

DeletionRecoveryLevel

DeletionRecoveryLevel değerlerini tanımlar. KnownDeletionRecoveryLevel, DeletionRecoveryLevel ile birbirinin yerine kullanılabilir, bu sabit listesi hizmetin desteklediği bilinen değerleri içerir. Hizmet tarafından desteklenen bilinen değerler Temizlenebilir: Kurtarma olasılığı olmadan silme işleminin geri alınamaz bir işlem olduğu bir kasa durumunu belirtir. Bu düzey, Silme işlemine karşı kullanılabilir koruma olmamasını ifade eder; varlık düzeyinde veya daha yüksek bir düzeyde (kasa, kaynak grubu, abonelik vb.) silme işlemi kabul edildikten sonra veriler kurtarılamaz şekilde kaybolur. Kurtarılabilir+Temizlenebilir: Silme işleminin kurtarılabilir olduğu ve ayrıca anında ve kalıcı silmeye (temizleme) izin veren bir kasa durumunu belirtir. Bu düzey, bir Temizleme işlemi istenmediği veya abonelik iptal edilmediği sürece bekletme aralığı (90 gün) boyunca silinen varlığın kurtarılabilirliğini garanti eder. Sistem, kurtarılmadıysa 90 gün sonra kalıcı olarak siler Kurtarılabilir: Silme işleminin anında ve kalıcı silme (temizleme) olasılığı olmadan kurtarılabilir olduğu bir kasa durumunu belirtir. Bu düzey, saklama aralığı (90 gün) ve abonelik hala kullanılabilir durumdayken silinen varlığın kurtarılabilirliğini garanti eder. Sistem, kurtarılmadıysa 90 gün sonra kalıcı olarak siler Recoverable+ProtectedSubscription: Silme işleminin saklama aralığı (90 gün) içinde kurtarılabilir olduğu, anında ve kalıcı silmeye (temizleme) izin verilmediği ve aboneliğin kendisinin kalıcı olarak iptal edilemediği bir kasayı ve abonelik durumunu belirtir. Sistem, kurtarılmadıysa 90 gün sonra kalıcı olarak siler CustomizedRecoverable+Purgeable: Silme işleminin kurtarılabilir olduğu ve ayrıca anında ve kalıcı silmeye izin veren bir kasa durumunu belirtir (örneğin, 7<= SoftDeleteRetentionInDays < 90 olduğunda temizleme). Bu düzey, bir Temizleme işlemi istenmediği veya abonelik iptal edilmediği sürece bekletme aralığı boyunca silinen varlığın kurtarılabilirliğini garanti eder. CustomizedRecoverable: Silme işleminin anında ve kalıcı silme olanağı olmadan kurtarılabilir olduğu bir kasa durumunu belirtir (örneğin, 7<= SoftDeleteRetentionInDays < 90 olduğunda temizleme). Bu düzey, saklama aralığı boyunca ve abonelik hala kullanılabilir durumdayken silinen varlığın kurtarılabilirliğini garanti eder. CustomizedRecoverable+ProtectedSubscription: 7<= SoftDeleteRetentionInDays < 90 olduğunda kurtarma, anında ve kalıcı silmeye (temizleme) izin verilmediği ve aboneliğin kendisinin kalıcı olarak iptal edilemediği bir kasayı ve abonelik durumunu belirtir. Bu düzey, bekletme aralığı boyunca silinen varlığın kurtarılabilirliğini garanti eder ve ayrıca aboneliğin kendisinin iptal edilemediğini yansıtır.

Numaralandırmalar

KnownDeletionRecoveryLevel

Hizmetin kabul ettiğini Bilinen DeletionRecoveryLevel değerleri.

İşlevler

parseKeyVaultSecretIdentifier(string)

Verilen Key Vault Gizli Dizi Kimliğini ayrıştırıyor. Örnek olarak: https://.vault.azure.net/secrets// Yukarıdaki kimliği ayrıştırırken bu işlev şunları döndürür: { 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>" }

İşlev Ayrıntıları

parseKeyVaultSecretIdentifier(string)

Verilen Key Vault Gizli Dizi Kimliğini ayrıştırıyor. Örnek olarak:

https://.vault.azure.net/secrets//

Yukarıdaki kimliği ayrıştırırken bu işlev şunları döndürür:

  {
     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

Parametreler

id

string

Key Vault Gizli Dizisinin Kimliği.

Döndürülenler

KeyVaultSecretIdentifier