@azure/keyvault-secrets package

Előkelő társaság

SecretClient

A SecretClient metódusokat biztosít KeyVaultSecret kezelésére az Azure Key Vaultban. Az ügyfél támogatja a KeyVaultSecrets létrehozását, lekérését, frissítését, törlését, törlését, biztonsági mentését, visszaállítását és felsorolását. Az ügyfél emellett támogatja a DeletedSecret listáját a helyreállítható törlést engedélyező Azure Key Vaulthoz.

Felületek

BackupSecretOptions	A <xref:backupSecretOptions>beállításai.
BeginDeleteSecretOptions	A beginDeleteSecret(string, BeginDeleteSecretOptions) számára továbbítható opcionális paramétereket képviselő felület
BeginRecoverDeletedSecretOptions	A beginRecoverDeletedSecret(string, BeginRecoverDeletedSecretOptions) számára továbbítható opcionális paramétereket képviselő felület
DeletedSecret	Törölt KeyVault-titkos kulcsot jelképező felület.
GetDeletedSecretOptions	A getDeletedSecret(string, GetDeletedSecretOptions)beállításai.
GetSecretOptions	A getSecret(string, GetSecretOptions)beállításai.
KeyVaultSecret	Egy KeyVault-titkos kulcsot jelképező felület, amelynek neve, értéke és SecretProperties.
KeyVaultSecretIdentifier	A Key Vault titkos azonosítóját alkotó szegmenseket jelöli.
ListDeletedSecretsOptions	A listDeletedSecrets(ListDeletedSecretsOptions)beállításai.
ListPropertiesOfSecretVersionsOptions	A listPropertiesOfSecretVersions(string, ListPropertiesOfSecretVersionsOptions)beállításai.
ListPropertiesOfSecretsOptions	A listPropertiesOfSecrets(ListPropertiesOfSecretsOptions)beállításai.
PageSettings	Egy felület, amely nyomon követi a lapozott iteráció beállításait
PagedAsyncIterableIterator	Egy felület, amely lehetővé teszi az aszinkron iterálást mind a befejezésig, mind az oldal szerint.
PollOperationState	A PollOperationState a hosszú ideig futó művelet pollerének meghatározásához szükséges legkisebb tulajdonságkészlet véleményezett listáját tartalmazza. Bár a Poller osztály helyi vezérlő mechanizmusként működik egy hosszú ideig futó művelet elindításához, várakozásához és esetleges megszakításához, a PollOperationState dokumentálja a távoli, hosszú ideig futó művelet állapotát. Legalább akkor kell frissíteni, amikor a művelet elkezdődik, amikor befejeződött, és ha a művelet megszakadt. Az implementációk azonban bármilyen más okból frissíthető tulajdonsággal rendelkezhetnek.
PollerLike	A poller absztrakt ábrázolása, amelynek célja, hogy a felhasználónak csak a minimális API-t tegye elérhetővé.
PurgeDeletedSecretOptions	A purgeDeletedSecret(string, PurgeDeletedSecretOptions)beállításai.
RestoreSecretBackupOptions	A restoreSecretBackup(Uint8Array, RestoreSecretBackupOptions)beállításai.
SecretClientOptions	A KeyVault KeyClient által elfogadott választható paraméterek
SecretPollerOptions	A beginDeleteSecret(string, BeginDeleteSecretOptions) és <xref:beginRecoverDeletedKey>számára továbbítható opcionális paramétereket képviselő felület.
SecretProperties	Egy KeyVaultSecrettulajdonságait képviselő felület.
SetSecretOptions	A setSecret(string, string, SetSecretOptions)beállításai.
UpdateSecretPropertiesOptions	A updateSecretProperties(string, string, UpdateSecretPropertiesOptions)beállításai.

Típus-aliasok

DeletionRecoveryLevel

Az aktuális tároló titkos kulcsainak jelenleg érvényben lévő törlési helyreállítási szintjét tükrözi. Ha "Eltávolítható" fájlt tartalmaz, a titkos kód véglegesen törölhető egy kiemelt felhasználó által; ellenkező esetben csak a rendszer tudja kiüríteni a titkos megőrzési időköz végén. KnownDeletionRecoveryLevel felcserélhető a DeletionRecoveryLeveltel, ez a szám tartalmazza a szolgáltatás által támogatott ismert értékeket. A szolgáltatás által támogatott ismert értékek Helyreállítható: Olyan tárolóállapotot jelöl, amelyben a törlés visszafordíthatatlan művelet, a helyreállítás lehetősége nélkül. Ez a szint nem felel meg a törlési műveletekkel szembeni védelemnek; az adatok helyrehozhatatlanul elvesznek, ha egy törlési műveletet az entitás szintjén vagy annál magasabb szinten fogadnak el (tároló, erőforráscsoport, előfizetés stb.) Helyreállítható+Helyreállítható: Azt a tárolóállapotot jelöli, amelyben a törlés helyreállítható, és amely lehetővé teszi az azonnali és végleges törlést (azaz a törlést). Ez a szint garantálja a törölt entitás helyreállíthatóságát a megőrzési időszak alatt (90 nap), kivéve, ha törlési műveletet kérnek, vagy az előfizetést lemondják. A rendszer 90 nap után véglegesen törli, ha nem állítható helyre Helyreállítható: Olyan tárolóállapotot jelöl, amelyben a törlés helyreállítható anélkül, hogy azonnali és végleges törlésre (azaz törlésre) van lehetőség. Ez a szint garantálja a törölt entitás helyreállíthatóságát a megőrzési időszak alatt (90 nap), és amíg az előfizetés továbbra is elérhető. A rendszer 90 nap után véglegesen törli, ha nem állítható helyre Recoveryable+ProtectedSubscription: Azt a tárolót és előfizetési állapotot jelöli, amelyben a törlés megőrzési idő (90 nap) alatt helyreállítható, az azonnali és végleges törlés (azaz a törlés) nem engedélyezett, és amelyben maga az előfizetés nem törölhető véglegesen. A rendszer 90 nap után véglegesen törli, ha nem állítható helyre CustomizedRecoverable+Purgeable: Azt a tárolóállapotot jelöli, amelyben a törlés helyreállítható, és amely lehetővé teszi az azonnali és végleges törlést is (azaz 7 <= SoftDeleteRetentionInDays < 90). Ez a szint garantálja a törölt entitás helyreállíthatóságát a megőrzési időszak alatt, kivéve, ha törlési műveletet kérnek, vagy az előfizetést lemondják. CustomizedRecoverable: Azt a tárolóállapotot jelöli, amelyben a törlés helyreállítható anélkül, hogy azonnali és végleges törlésre van lehetőség (azaz 7 <= SoftDeleteRetentionInDays < 90). Ez a szint garantálja a törölt entitás helyreállíthatóságát a megőrzési időszak alatt, és amíg az előfizetés továbbra is elérhető. CustomizedRecoverable+ProtectedSubscription: Azt a tárolót és előfizetési állapotot jelöli, amelyben a törlés helyreállítható, az azonnali és végleges törlés (azaz a törlés) nem engedélyezett, és amelyben maga az előfizetés nem törölhető véglegesen, amikor 7 <= SoftDeleteRetentionInDays < 90. Ez a szint garantálja a törölt entitás helyreállíthatóságát a megőrzési időszak alatt, és azt is tükrözi, hogy maga az előfizetés nem törölhető.

Enums

KnownDeletionRecoveryLevel

Az aktuális tároló titkos kulcsainak jelenleg érvényben lévő törlési helyreállítási szintjét tükrözi. Ha "Eltávolítható" fájlt tartalmaz, a titkos kód véglegesen törölhető egy kiemelt felhasználó által; ellenkező esetben csak a rendszer tudja kiüríteni a titkos megőrzési időköz végén.

Functions

parseKeyVaultSecretIdentifier(string)

Elemzi a key vault megadott titkos azonosítóját. Ilyen például a következő: https://< keyvault-name.vault.azure.net/secrets/>< titkos-név>/<egyedi-verzió-azonosító> A fenti azonosító elemzésekor a függvény a következőt adja vissza: { 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>" }

Változók

logger

A @azure/logger csomag konfigurációja.

Funkciók részletei

parseKeyVaultSecretIdentifier(string)

Elemzi a key vault megadott titkos azonosítóját. Ilyen például a következő:

https://< keyvault-name.vault.azure.net/secrets/>< titkos-név>/<egyedi-verzió-azonosító>

A fenti azonosító elemzésekor a függvény a következőt adja vissza:

  {
     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

Paraméterek

id

string

A Key Vault titkos kulcsazonosítója.

Visszatér

KeyVaultSecretIdentifier

Variable Details

logger

A @azure/logger csomag konfigurációja.

logger: AzureLogger

Típus

AzureLogger