@azure/keyvault-secrets package

SecretClient poskytuje metody pro správu KeyVaultSecret v Azure Key Vault. Klient podporuje vytváření, načítání, aktualizaci, odstraňování, vymazání, zálohování, obnovení a výpis keyVaultSecrets. Klient také podporuje výpis odstraněnéhosecretu pro Key Vault Azure s povoleným obnovitelném odstraněním.

Možnosti pro <xref:backupSecretOptions>.

Rozhraní představující volitelné parametry, které lze předat do beginDeleteSecret(string, BeginDeleteSecretOptions)

Rozhraní představující volitelné parametry, které lze předat do beginRecoverDeletedSecret(string, BeginRecoverDeletedSecretOptions)

Rozhraní představující odstraněný tajný klíč KeyVault.

Možnosti pro getDeletedSecret(string, GetDeletedSecretOptions).

Možnosti pro getSecret(string, GetSecretOptions).

Rozhraní představující tajný klíč KeyVault s jeho názvem, hodnotou a secretProperties.

Představuje segmenty, které tvoří ID tajného kódu Key Vault.

Možnosti pro listDeletedSecrets(ListDeletedSecretsOptions).

Možnosti pro listPropertiesOfSecretVersions(string, ListPropertiesOfSecretVersionsOptions).

Možnosti pro listPropertiesOfSecrets(ListPropertiesOfSecretsOptions).

Rozhraní, které sleduje nastavení stránkované iterace

Rozhraní, které umožňuje asynchronní iteraci k dokončení i po stránce.

PollOperationState obsahuje seznam nejmenší sady vlastností potřebných k definování jakékoli dlouho běžící operace poller.

Zatímco třída Poller 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ěl by se aktualizovat alespoň při spuštění operace, po dokončení a při jejím zrušení. Implementace ale můžou mít libovolný další počet vlastností, které se dají aktualizovat z jiných důvodů.

Abstraktní reprezentace polleru, která má zveřejnit pouze minimální rozhraní API, se kterým uživatel potřebuje pracovat.

Možnosti pro purgeDeletedSecret(string, PurgeDeletedSecretOptions).

Možnosti pro restoreSecretBackup(Uint8Array, RestoreSecretBackupOptions).

Volitelné parametry, které přijímá KeyClient služby KeyVault

Rozhraní představující volitelné parametry, které lze předat do beginDeleteSecret(string, BeginDeleteSecretOptions) a <xref:beginRecoverDeletedKey>.

Rozhraní představující vlastnosti KeyVaultSecret.

Možnosti pro setSecret(string, string, SetSecretOptions).

Možnosti pro updateSecretProperties(string, string, UpdateSecretPropertiesOptions).

Definuje hodnoty pro DeletionRecoveryLevel.
KnownDeletionRecoveryLevel lze použít zaměnitelně s DeletionRecoveryLevel, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

Vymazatelné: 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 k nenávratné ztrátě dat.
Obnovitelné+vyprázdnitelné: Označuje stav trezoru, ve kterém je možné odstranit a který také umožňuje okamžité a trvalé odstranění (tj. vymazání). Tato úroveň zaručuje obnovitelnost odstraněné entity během intervalu uchovávání (90 dnů), pokud není požadována operace vyprázdnění nebo pokud není předplatné zrušeno. Systém ho po 90 dnech trvale odstraní, pokud není obnovený.
Obnovitelné: Označuje stav trezoru, ve kterém je možné odstranění obnovit bez možnosti okamžitého a trvalého odstranění (tj. vymazání). Tato úroveň zaručuje obnovitelnost odstraněné entity během intervalu uchovávání (90 dnů) a v době, kdy je předplatné stále dostupné. Systém ho po 90 dnech trvale odstraní, pokud není obnovený.
Obnovitelné+ProtectedSubscription: Označuje stav trezoru a předplatného, ve kterém je možné odstranění obnovit v intervalu uchovávání (90 dnů), okamžité a trvalé odstranění (tj. vymazání) není povoleno a ve kterém samotné předplatné nelze trvale zrušit. Systém ho po 90 dnech trvale odstraní, pokud není obnovený.
CustomizedRecoverable+Purgeable: Označuje stav trezoru, ve kterém je možné odstranění obnovit a který také umožňuje okamžité a trvalé odstranění (tj. vymazání, když 7< = SoftDeleteRetentionInDays < 90). Tato úroveň zaručuje obnovitelnost odstraněné entity během intervalu uchovávání, pokud není požadována operace vyprázdnění nebo pokud není zrušeno předplatné.
CustomizedRecoverable: Označuje stav trezoru, ve kterém je možné odstranění obnovit bez možnosti okamžitého a trvalého odstranění (tj. vymazání při 7< = SoftDeleteRetentionInDays < 90). Tato úroveň zaručuje obnovitelnost odstraněné entity během intervalu uchovávání a po dobu, kdy je předplatné stále dostupné.
CustomizedRecoverable+ProtectedSubscription: Označuje stav trezoru a předplatného, ve kterém je možné odstranit, okamžité a trvalé odstranění (tj. vymazání) není povoleno a ve kterém samotné předplatné nelze trvale zrušit, pokud je 7< = SoftDeleteRetentionInDays < 90. Tato úroveň zaručuje obnovitelnost odstraněné entity během intervalu uchovávání a odráží také skutečnost, že samotné předplatné nelze zrušit.

Známé hodnoty DeletionRecoveryLevel , které služba přijímá.

Analyzuje dané ID tajného kódu Key Vault. Příklad:

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

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

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