@azure/keyvault-secrets package

Obiekt SecretClient udostępnia metody zarządzania KeyVaultSecret w usłudze Azure Key Vault. Klient obsługuje tworzenie, pobieranie, aktualizowanie, usuwanie, przeczyszczanie, tworzenie kopii zapasowej, przywracanie i wyświetlanie listy kluczy KeyVaultSecrets. Klient obsługuje również wyświetlanie listy DeletedSecret dla usługi Azure Key Vault z włączoną obsługą usuwania nietrwałego.

Opcje <xref:backupSecretOptions>.

Interfejs reprezentujący parametry opcjonalne, które można przekazać do beginDeleteSecret(string, BeginDeleteSecretOptions)

Interfejs reprezentujący parametry opcjonalne, które można przekazać do beginRecoverDeletedSecret(string, BeginRecoverDeletedSecretOptions)

Interfejs reprezentujący usunięty wpis tajny usługi KeyVault.

Opcje getDeletedSecret(string, GetDeletedSecretOptions).

Opcje getSecret(string, GetSecretOptions).

Interfejs reprezentujący wpis tajny usługi KeyVault z jego nazwą, wartością i SecretProperties.

Reprezentuje segmenty tworzące identyfikator wpisu tajnego usługi Key Vault.

Opcje listDeletedSecrets(ListDeletedSecretsOptions).

Opcje listPropertiesOfSecretVersions(string, ListPropertiesOfSecretVersionsOptions).

Opcje listPropertiesOfSecrets(ListPropertiesOfSecretsOptions).

Interfejs śledzący ustawienia iteracji stronicowanej

Interfejs, który umożliwia iterację asynchronialną zarówno do ukończenia, jak i według strony.

PollOperationState zawiera listę najdrobniejszych zestawów właściwości potrzebnych do zdefiniowania dowolnej długotrwałej operacji poller.

Podczas gdy klasa Poller działa jako lokalny mechanizm sterowania, aby rozpocząć wyzwalanie, czekać i potencjalnie anulować długotrwałą operację, pollOperationState dokumentuje stan zdalnej długotrwałej operacji.

Powinna zostać zaktualizowana co najmniej po rozpoczęciu operacji, zakończeniu i anulowaniu. Jednak implementacje mogą mieć dowolną inną liczbę właściwości, które mogą być aktualizowane z innych powodów.

Abstrakcyjna reprezentacja narzędzia poller, która ma na celu uwidocznienie tylko minimalnego interfejsu API, z którymi użytkownik musi pracować.

Opcje purgeDeletedSecret(string, PurgeDeletedSecretOptions).

Opcje restoreSecretBackup(Uint8Array, RestoreSecretBackupOptions).

Opcjonalne parametry akceptowane przez klienta KeyVault

Interfejs reprezentujący opcjonalne parametry, które można przekazać do beginDeleteSecret(string, BeginDeleteSecretOptions) i <xref:beginRecoverDeletedKey>.

Interfejs reprezentujący właściwości KeyVaultSecret.

Opcje setSecret(string, string, SetSecretOptions).

Opcje updateSecretProperties(string, string, UpdateSecretPropertiesOptions).

Odzwierciedla obecnie poziom odzyskiwania usuwania dla wpisów tajnych w bieżącym magazynie. Jeśli zawiera "przeczyszczalną", wpis tajny może zostać trwale usunięty przez uprzywilejowanego użytkownika; w przeciwnym razie tylko system może przeczyścić wpis tajny na końcu interwału przechowywania.
KnownDeletionRecoveryLevel można używać zamiennie z elementem DeletionRecoveryLevel, wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

można przeczyścić: określa stan magazynu, w którym usunięcie jest operacją nieodwracalną bez możliwości odzyskiwania. Ten poziom nie odpowiada działaniu ochrony przed operacją Usuwania; dane są nieodwracalnie utracone po zaakceptowaniu operacji Usuwania na poziomie jednostki lub wyższym (magazyn, grupa zasobów, subskrypcja itp.)
możliwe do odzyskania i przeczyszczania: oznacza stan magazynu, w którym można odzyskać, a także umożliwia natychmiastowe i trwałe usunięcie (tj. przeczyszczenie). Ten poziom gwarantuje możliwość odzyskania usuniętej jednostki w przedziale przechowywania (90 dni), chyba że zażądano operacji przeczyszczania lub subskrypcja zostanie anulowana. System zostanie trwale usunięty po 90 dniach, jeśli nie zostanie odzyskany
możliwe do odzyskania: określa stan magazynu, w którym można odzyskać usunięcie bez możliwości natychmiastowego i trwałego usunięcia (tj. przeczyszczania). Ten poziom gwarantuje możliwość odzyskania usuniętej jednostki w okresie przechowywania (90 dni) i gdy subskrypcja jest nadal dostępna. System zostanie trwale usunięty po 90 dniach, jeśli nie zostanie odzyskany
możliwe do odzyskania+ChronioneSubskrypcja: oznacza magazyn i stan subskrypcji, w którym usunięcie można odzyskać w przedziale przechowywania (90 dni), natychmiastowe i trwałe usunięcie (tj. przeczyszczenie) nie jest dozwolone i w którym sama subskrypcja nie może zostać trwale anulowana. System zostanie trwale usunięty po 90 dniach, jeśli nie zostanie odzyskany
CustomizedRecoverable+Purgeable: oznacza stan magazynu, w którym można odzyskać usunięcie, a także zezwala na natychmiastowe i trwałe usunięcie (tj. przeczyszczanie, gdy 7 <= SoftDeleteRetentionInDays < 90). Ten poziom gwarantuje możliwość odzyskania usuniętej jednostki w okresie przechowywania, chyba że zażądano operacji przeczyszczania lub subskrypcja zostanie anulowana.
CustomizedRecoverable: oznacza stan magazynu, w którym można odzyskać usunięcie bez możliwości natychmiastowego i trwałego usunięcia (tj. przeczyszczania, gdy 7 <= SoftDeleteRetentionInDays < 90). Ten poziom gwarantuje możliwość odzyskania usuniętej jednostki w okresie przechowywania i gdy subskrypcja jest nadal dostępna.
CustomizedRecoverable+ProtectedSubscription: oznacza magazyn i stan subskrypcji, w którym usunięcie jest możliwe do odzyskania, natychmiastowe i trwałe usunięcie (tj. przeczyszczenie) jest niedozwolone i w którym sama subskrypcja nie może zostać trwale anulowana, gdy 7 <= SoftDeleteRetentionInDays < 90. Ten poziom gwarantuje możliwość odzyskania usuniętej jednostki w okresie przechowywania, a także odzwierciedla fakt, że sama subskrypcja nie może zostać anulowana.

Odzwierciedla obecnie poziom odzyskiwania usuwania dla wpisów tajnych w bieżącym magazynie. Jeśli zawiera "przeczyszczalną", wpis tajny może zostać trwale usunięty przez uprzywilejowanego użytkownika; w przeciwnym razie tylko system może przeczyścić wpis tajny na końcu interwału przechowywania.

Analizuje dany identyfikator wpisu tajnego usługi Key Vault. Przykład:

https://< nazwa-magazynu.vault.azure.net/secrets/<> nazwa-sekretu>/<unikatowy-identyfikator_wersji>

Podczas analizowania powyższego identyfikatora ta funkcja zwraca następujące elementy:

  {
     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>"
  }