Udostępnij za pośrednictwem

@azure/keyvault-secrets package

Klasy

SecretClient

Obiekt SecretClient udostępnia metody zarządzania <xref: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 <xref:DeletedSecret> dla usługi Azure Key Vault z włączoną obsługą usuwania nietrwałego.

Interfejsy

BackupSecretOptions

Opcje <xref:backupSecretOptions>.
BeginDeleteSecretOptions

Interfejs reprezentujący parametry opcjonalne, które można przekazać do <xref:beginDeleteSecret>
BeginRecoverDeletedSecretOptions

Interfejs reprezentujący parametry opcjonalne, które można przekazać do <xref:beginRecoverDeletedSecret>
DeletedSecret

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

Opcje <xref:getDeletedSecret>.
GetSecretOptions

Opcje <xref:getSecret>.
KeyVaultSecret

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

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

Opcje <xref:listDeletedSecrets>.
ListPropertiesOfSecretVersionsOptions

Opcje <xref:listPropertiesOfSecretVersions>.
ListPropertiesOfSecretsOptions

Opcje <xref:listPropertiesOfSecrets>.
PurgeDeletedSecretOptions

Opcje <xref:purgeDeletedSecret>.
RestoreSecretBackupOptions

Opcje <xref:restoreSecretBackup>.
SecretClientOptions

Opcjonalne parametry akceptowane przez klienta KeyVault
SecretPollerOptions

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

Interfejs reprezentujący właściwości <xref:KeyVaultSecret>.
SetSecretOptions

Opcje <xref:setSecret>.
UpdateSecretPropertiesOptions

Opcje <xref:updateSecretProperties>.

Aliasy typu

DeletionRecoveryLevel

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

Znajomość wartości obsługiwanych 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 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: oznacza magazyn i stan subskrypcji, w którym usunięcie jest możliwe do odzyskania, natychmiastowe i trwałe usunięcie (tj. przeczyszczenie) nie jest dozwolone 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 <xref:DeletionRecoveryLevel> akceptowanych przez usługę.

Funkcje

parseKeyVaultSecretIdentifier(string)

Analizuje podany identyfikator wpisu tajnego Key Vault. Przykładem jest: 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>"
  }

Szczegóły funkcji

parseKeyVaultSecretIdentifier(string)

Analizuje podany identyfikator wpisu tajnego Key Vault. Przykładem jest: 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>"
  }

function parseKeyVaultSecretIdentifier(id: string)

Parametry

id

string

Identyfikator wpisu tajnego usługi Key Vault.

Zwraca

KeyVaultSecretIdentifier