@azure/keyvault-secrets package

Třídy

SecretClient

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.

Rozhraní

BackupSecretOptions	Možnosti pro <xref:backupSecretOptions>.
BeginDeleteSecretOptions	Rozhraní představující volitelné parametry, které lze předat do beginDeleteSecret(string, BeginDeleteSecretOptions)
BeginRecoverDeletedSecretOptions	Rozhraní představující volitelné parametry, které lze předat do beginRecoverDeletedSecret(string, BeginRecoverDeletedSecretOptions)
DeletedSecret	Rozhraní představující odstraněný tajný klíč KeyVault.
GetDeletedSecretOptions	Možnosti pro getDeletedSecret(string, GetDeletedSecretOptions).
GetSecretOptions	Možnosti pro getSecret(string, GetSecretOptions).
KeyVaultSecret	Rozhraní představující tajný klíč KeyVault s jeho názvem, hodnotou a secretProperties.
KeyVaultSecretIdentifier	Představuje segmenty, které tvoří ID tajného kódu 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 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ů.
PollerLike	Abstraktní reprezentace polleru, která má zveřejnit pouze minimální rozhraní API, se kterým uživatel potřebuje pracovat.
PurgeDeletedSecretOptions	Možnosti pro purgeDeletedSecret(string, PurgeDeletedSecretOptions).
RestoreSecretBackupOptions	Možnosti pro restoreSecretBackup(Uint8Array, RestoreSecretBackupOptions).
SecretClientOptions	Volitelné parametry, které přijímá KeyClient služby KeyVault
SecretPollerOptions	Rozhraní představující volitelné parametry, které lze předat do 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

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.

Výčty

KnownDeletionRecoveryLevel

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

Funkce

parseKeyVaultSecretIdentifier(string)

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

Podrobnosti funkce

parseKeyVaultSecretIdentifier(string)

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

function parseKeyVaultSecretIdentifier(id: string): KeyVaultSecretIdentifier

Parametry

id

string

ID tajného kódu Key Vault.

Návraty

KeyVaultSecretIdentifier