@azure/keyvault-secrets package
Osztályok
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. |
Interfészek
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ípusaliasok
DeletionRecoveryLevel |
A DeletionRecoveryLevel értékeit határozza meg. 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.) |
Enumerációk
KnownDeletionRecoveryLevel |
A szolgáltatás által elfogadott DeletionRecoveryLevel ismert értékei. |
Függvények
parse |
Elemzi a key vault megadott titkos azonosítóját. Ilyen például a következő: https://.vault.azure.net/secrets// A fenti azonosító elemzésekor a függvény a következőt adja vissza:
|
Függvény adatai
parseKeyVaultSecretIdentifier(string)
Elemzi a key vault megadott titkos azonosítóját. Ilyen például a következő:
https://.vault.azure.net/secrets//
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.