@azure/keyvault-secrets package

Třídy

SecretClient

SecretClient poskytuje metody pro správu KeyVaultSecret ve službě Azure Key Vault. Klient podporuje vytváření, načítání, aktualizaci, odstraňování, mazání, zálohování, obnovení a výpis klíčů KeyVaultSecrets. Klient podporuje také výpis DeletedSecret pro obnovitelné odstranění služby Azure Key Vault.

Rozhraní

BackupSecretOptions	Možnosti pro <xref:backupSecretOptions>.
BeginDeleteSecretOptions	Rozhraní představující volitelné parametry, které lze předat beginDeleteSecret(string, BeginDeleteSecretOptions)
BeginRecoverDeletedSecretOptions	Rozhraní představující volitelné parametry, které lze předat beginRecoverDeletedSecret(string, BeginRecoverDeletedSecretOptions)
DeletedSecret	Rozhraní představující odstraněný tajný klíč služby KeyVault.
GetDeletedSecretOptions	Možnosti pro getDeletedSecret(string, GetDeletedSecretOptions).
GetSecretOptions	Možnosti pro getSecret(string, GetSecretOptions).
KeyVaultSecret	Rozhraní představující tajný klíč KeyVault s názvem, hodnotou a SecretProperties.
KeyVaultSecretIdentifier	Představuje segmenty, které tvoří ID tajného klíče služby Key Vault.
ListDeletedSecretsOptions	Možnosti pro listDeletedSecrets(ListDeletedSecretsOptions).
ListPropertiesOfSecretVersionsOptions	Možnosti pro listPropertiesOfSecretVersions(string, ListPropertiesOfSecretVersionsOptions).
ListPropertiesOfSecretsOptions	Možnosti pro listPropertiesOfSecrets(ListPropertiesOfSecretsOptions).
PageSettings	Rozhraní, které sleduje nastavení stránkované iterace
PagedAsyncIterableIterator	Rozhraní, které umožňuje asynchronní iteraci k dokončení i po stránce.
PollOperationState	PollOperationState obsahuje názorný seznam nejmenší sady vlastností potřebných k definování jakékoli dlouhotrvající operace poller. Zatímco Poller třída funguje jako místní řídicí mechanismus pro spuštění aktivace, čekání a potenciálně zrušení dlouhotrvající operace, PollOperationState dokumentuje stav vzdálené dlouhotrvající operace. Měla by se aktualizovat aspoň po spuštění operace, po jeho dokončení a po zrušení. Implementace ale můžou mít jakýkoli jiný počet vlastností, které je možné aktualizovat z jiných důvodů.
PollerLike	Abstraktní reprezentace polleru, která má vystavit pouze minimální rozhraní API, se kterým musí uživatel pracovat.
PurgeDeletedSecretOptions	Možnosti pro purgeDeletedSecret(string, PurgeDeletedSecretOptions).
RestoreSecretBackupOptions	Možnosti pro restoreSecretBackup(Uint8Array, RestoreSecretBackupOptions).
SecretClientOptions	Volitelné parametry akceptované keyClient služby KeyClient služby KeyVault
SecretPollerOptions	Rozhraní představující volitelné parametry, které lze předat beginDeleteSecret(string, BeginDeleteSecretOptions) a <xref:beginRecoverDeletedKey>.
SecretProperties	Rozhraní představující vlastnosti keyVaultSecret.
SetSecretOptions	Možnosti pro setSecret(string, string, SetSecretOptions).
UpdateSecretPropertiesOptions	Možnosti pro updateSecretProperties(string, string, UpdateSecretPropertiesOptions).

Aliasy typu

DeletionRecoveryLevel

Odráží úroveň obnovení odstranění, která aktuálně platí pro tajné kódy v aktuálním trezoru. Pokud obsahuje "vyprázdnit", může tajný kód trvale odstranit privilegovaný uživatel; v opačném případě může tajný klíč vyprázdnit pouze systém na konci intervalu uchovávání. PoleDeletionRecoveryLevel lze použít zaměnitelně s DeletionRecoveryLevel, tento výčet obsahuje známé hodnoty, které služba podporuje. Známé hodnoty podporované službou vyprázdnění: Označuje stav trezoru, ve kterém je odstranění nevratnou operací bez možnosti obnovení. Tato úroveň odpovídá tomu, že není k dispozici žádná ochrana proti operaci odstranění; při přijetí operace odstranění na úrovni entity nebo vyšší (trezor, skupina prostředků, předplatné atd.) dojde ke ztrátě dat. Obnovitelné+vyprázdnitelné: Označuje stav trezoru, ve kterém se odstranění dá obnovit, a umožňuje také okamžité a trvalé odstranění (tj. vyprázdnění). Tato úroveň zaručuje obnovitelnost odstraněné entity během intervalu uchovávání informací (90 dnů), pokud se nepožaduje operace vyprázdnění nebo se předplatné zruší. Systém ho trvale odstraní po 90 dnech, pokud ho neobnoví. Obnovitelné: Označuje stav trezoru, ve kterém je odstranění možné obnovit bez možnosti okamžitého a trvalého odstranění (tj. vyprázdnění). Tato úroveň zaručuje obnovitelnost odstraněné entity během intervalu uchovávání informací (90 dnů) a v době, kdy je předplatné stále dostupné. Systém ho trvale odstraní po 90 dnech, pokud ho neobnoví. Obnovitelné +ProtectedSubscription: Označuje trezor a stav předplatného, ve kterém je odstranění možné obnovit v intervalu uchovávání (90 dnů), okamžité a trvalé odstranění (tj. vyprázdnění) není povoleno a ve kterém samotné předplatné nelze trvale zrušit. Systém ho trvale odstraní po 90 dnech, pokud ho neobnoví. CustomizedRecoverable+Purgeable: Označuje stav trezoru, ve kterém se odstranění dá obnovit, a umožňuje také okamžité a trvalé odstranění (tj. vymazání při 7 <= SoftDeleteRetentionInDays < 90). Tato úroveň zaručuje obnovitelnost odstraněné entity během intervalu uchovávání, pokud se nepožaduje operace vyprázdnění nebo se předplatné zruší. Vlastní: Označuje stav trezoru, ve kterém se odstranění dá obnovit bez možnosti okamžitého a trvalého odstranění (tj. vymazání, když 7 <= SoftDeleteRetentionInDays < 90). Tato úroveň zaručuje obnovitelnost odstraněné entity během intervalu uchovávání a v době, kdy je předplatné stále dostupné. CustomizedRecoverable+ProtectedSubscription: Označuje stav trezoru a předplatného, ve kterém se odstranění dá obnovit, okamžité a trvalé odstranění (tj. vyprázdnění) a ve kterém samotné předplatné nelze trvale zrušit, když 7 <= SoftDeleteRetentionInDays < 90. Tato úroveň zaručuje obnovitelnost odstraněné entity během intervalu uchovávání a také odráží skutečnost, že samotné předplatné nelze zrušit.

Výčty

KnownDeletionRecoveryLevel

Odráží úroveň obnovení odstranění, která aktuálně platí pro tajné kódy v aktuálním trezoru. Pokud obsahuje "vyprázdnit", může tajný kód trvale odstranit privilegovaný uživatel; v opačném případě může tajný klíč vyprázdnit pouze systém na konci intervalu uchovávání.

Funkce

parseKeyVaultSecretIdentifier(string)

Analyzuje dané ID tajného kódu služby Key Vault. Příkladem je: https://< název-trezoru-klíč.vault.azure.net/secrets/>< název-tajného-kódu>/<id-jedinečné-verze-> Při analýze výše uvedeného ID vrátí tato funkce: { 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>" }

Proměnné

logger

Konfigurace @azure/logger tohoto balíčku.

Podrobnosti funkce

parseKeyVaultSecretIdentifier(string)

Analyzuje dané ID tajného kódu služby Key Vault. Příkladem je:

https://< název-trezoru-klíč.vault.azure.net/secrets/>< název-tajného-kódu>/<id-jedinečné-verze->

Při analýze výše uvedeného ID vrátí tato funkce:

  {
     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

ID tajného klíče služby Key Vault.

Návraty

KeyVaultSecretIdentifier

Variable Details

logger

Konfigurace @azure/logger tohoto balíčku.

logger: AzureLogger

Typ

AzureLogger