@azure/keyvault-secrets package

Odwołanie

Klasy

Element SecretClient udostępnia metody zarządzania kluczem KeyVaultSecret w usłudze Azure Key Vault. Klient obsługuje tworzenie, pobieranie, aktualizowanie, usuwanie, czyszczenie, 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.

Interfejsy

BackupSecretOptions	Opcje dla programu <xref:backupSecretOptions>.
BeginDeleteSecretOptions	Interfejs reprezentujący parametry opcjonalne, które można przekazać do beginDeleteSecret(string, BeginDeleteSecretOptions)
BeginRecoverDeletedSecretOptions	Interfejs reprezentujący parametry opcjonalne, które można przekazać do beginRecoverDeletedSecret(string, BeginRecoverDeletedSecretOptions)
DeletedSecret	Interfejs reprezentujący usunięty wpis tajny usługi KeyVault.
GetDeletedSecretOptions	Opcje dla programu getDeletedSecret(string, GetDeletedSecretOptions).
GetSecretOptions	Opcje dla programu getSecret(string, GetSecretOptions).
KeyVaultSecret	Interfejs reprezentujący wpis tajny usługi KeyVault z jego nazwą, wartością i właściwościami SecretProperties.
KeyVaultSecretIdentifier	Reprezentuje segmenty tworzące identyfikator wpisu tajnego Key Vault.
ListDeletedSecretsOptions	Opcje dla programu listDeletedSecrets(ListDeletedSecretsOptions).
ListPropertiesOfSecretVersionsOptions	Opcje dla programu listPropertiesOfSecretVersions(string, ListPropertiesOfSecretVersionsOptions).
ListPropertiesOfSecretsOptions	Opcje dla programu listPropertiesOfSecrets(ListPropertiesOfSecretsOptions).
PageSettings	Interfejs śledzący ustawienia iteracji stronicowanej
PagedAsyncIterableIterator	Interfejs, który umożliwia iterację asynchronizalną zarówno do ukończenia, jak i według strony.
PollOperationState	PollOperationState zawiera listę z opiniami najmniejszego zestawu 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. Chociaż implementacje mogą mieć dowolną inną liczbę właściwości, które można zaktualizować z innych powodów.
PollerLike	Abstrakcyjna reprezentacja narzędzia poller, która ma na celu uwidocznienie tylko minimalnego interfejsu API, z którymi użytkownik musi pracować.
PurgeDeletedSecretOptions	Opcje dla programu purgeDeletedSecret(string, PurgeDeletedSecretOptions).
RestoreSecretBackupOptions	Opcje dla programu restoreSecretBackup(Uint8Array, RestoreSecretBackupOptions).
SecretClientOptions	Opcjonalne parametry akceptowane przez klienta KeyClient usługi KeyVault
SecretPollerOptions	Interfejs reprezentujący opcjonalne parametry, które można przekazać do beginDeleteSecret(string, BeginDeleteSecretOptions) elementów i <xref:beginRecoverDeletedKey>.
SecretProperties	Interfejs reprezentujący właściwości obiektu KeyVaultSecret.
SetSecretOptions	Opcje dla programu setSecret(string, string, SetSecretOptions).
UpdateSecretPropertiesOptions	Opcje dla programu updateSecretProperties(string, string, UpdateSecretPropertiesOptions).

Aliasy typu

DeletionRecoveryLevel

Definiuje wartości elementu DeletionRecoveryLevel.
KnownDeletionRecoveryLevel można używać zamiennie z elementem DeletionRecoveryLevel. To wyliczenie zawiera znane wartości obsługiwane przez usługę.

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

Możliwe do przeczyszczenia: 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 przeczyszczanie: określa stan magazynu, w którym można odzyskać usunięcie, a także umożliwia natychmiastowe i trwałe usunięcie (tj. przeczyszczenie). Ten poziom gwarantuje możliwość odzyskania usuniętej jednostki w okresie 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, że magazyn i stan subskrypcji, w którym usunięcie można odzyskać w okresie 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: określa stan magazynu, w którym można odzyskać usunięcie, a także umożliwia 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: określa 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: określa 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.

Wyliczenia

KnownDeletionRecoveryLevel

Znane wartości DeletionRecoveryLevel akceptowane przez usługę.

Funkcje

parseKeyVaultSecretIdentifier(string)

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

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

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

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

Szczegóły funkcji

parseKeyVaultSecretIdentifier(string)

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

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

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

  {
     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

Parametry

id: string

Identyfikator wpisu tajnego Key Vault.

Zwraca

KeyVaultSecretIdentifier

@azure/keyvault-secrets package

Klasy

Interfejsy

Aliasy typu

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

Wyliczenia

Funkcje

Szczegóły funkcji

parseKeyVaultSecretIdentifier(string)

Parametry

Zwraca

Dodatkowe zasoby