Aracılığıyla paylaş


@azure/keyvault-secrets package

Sınıflar

SecretClient

SecretClient, Azure Key Vault'ta KeyVaultSecret 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 ayrıca geçici silme özelliği etkinleştirilmiş Azure Key Vault için DeletedSecret listelemeyi de destekler.

Arabirimler

BackupSecretOptions

<xref:backupSecretOptions>seçenekleri.

BeginDeleteSecretOptions

beginDeleteSecret(string, BeginDeleteSecretOptions) geçirilebilen isteğe bağlı parametreleri temsil eden bir arabirim

BeginRecoverDeletedSecretOptions

beginRecoverDeletedSecret(string, BeginRecoverDeletedSecretOptions) geçirilebilen isteğe bağlı parametreleri temsil eden bir arabirim

DeletedSecret

Silinen KeyVault Gizli Dizisini temsil eden arabirim.

GetDeletedSecretOptions

getDeletedSecret(string, GetDeletedSecretOptions)seçenekleri.

GetSecretOptions

getSecret(string, GetSecretOptions)seçenekleri.

KeyVaultSecret

Adı, değeri ve SecretProperties bir KeyVault Gizli Dizisini temsil eden arabirim.

KeyVaultSecretIdentifier

Key Vault Gizli Dizi Kimliği oluşturan kesimleri temsil eder.

ListDeletedSecretsOptions

listDeletedSecrets(ListDeletedSecretsOptions)seçenekleri.

ListPropertiesOfSecretVersionsOptions

listPropertiesOfSecretVersions(string, ListPropertiesOfSecretVersionsOptions)seçenekleri.

ListPropertiesOfSecretsOptions

listPropertiesOfSecrets(ListPropertiesOfSecretsOptions)seçenekleri.

PageSettings

Sayfalanmış yineleme ayarlarını izleyen bir arabirim

PagedAsyncIterableIterator

Zaman uyumsuz yinelenebilir yinelemeye hem tamamlamaya hem de sayfaya 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 fikirli bir listesini içerir.

Poller sınıfı, uzun süre çalışan bir işlemi tetiklemeye, beklemeye ve potansiyel olarak iptal etmeye yönelik 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 amaçlı bir poller'in soyut gösterimi.

PurgeDeletedSecretOptions

purgeDeletedSecret(string, PurgeDeletedSecretOptions)seçenekleri.

RestoreSecretBackupOptions

restoreSecretBackup(Uint8Array, RestoreSecretBackupOptions)seçenekleri.

SecretClientOptions

KeyVault'un KeyClient tarafından kabul edilen isteğe bağlı parametreler

SecretPollerOptions

beginDeleteSecret(string, BeginDeleteSecretOptions) ve <xref:beginRecoverDeletedKey>geçirilebilen isteğe bağlı parametreleri temsil eden bir arabirim.

SecretProperties

KeyVaultSecretözelliklerini temsil eden arabirim.

SetSecretOptions

setSecret(string, string, SetSecretOptions)seçenekleri.

UpdateSecretPropertiesOptions

updateSecretProperties(string, string, UpdateSecretPropertiesOptions)seçenekleri.

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 olanağı olmadan silme işleminin geri alınamaz bir işlem olduğu kasa durumunu belirtir. Bu düzey, silme işlemine karşı kullanılabilir koruma olmamasına karşılık gelir; 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.
Recoverable+Purgeable: Silmenin 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 saklama 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) boyunca 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 edilemeyeceğ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). Bu düzey, bir Temizleme işlemi istenmediği veya abonelik iptal edilmediği sürece saklama aralığı boyunca silinen varlığın kurtarılabilirliğini garanti eder.
CustomizedRecoverable: Silme işleminin anında ve kalıcı silme olanağı olmadan kurtarılabilir durumda olduğunu 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: Silme işleminin kurtarılabilir olduğu, anında ve kalıcı silmeye (temizleme) izin verilmediği ve 7<= SoftDeleteRetentionInDays < 90 olduğunda aboneliğin kendisinin kalıcı olarak iptal edilemeyeceğ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 DeletionRecoveryLevel bilinen 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