@azure/keyvault-secrets package
Osztályok
SecretClient |
A SecretClient metódusokat biztosít a KeyVaultSecret kezeléséhez az Azure Key Vault. 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, törlését, biztonsági mentését, visszaállítását és listázását. Az ügyfél emellett támogatja a DeletedSecret listázását a helyreállítható törlést engedélyező Azure-Key Vault esetében. |
Interfészek
BackupSecretOptions |
A beállítások a következőhöz: <xref:backupSecretOptions>. |
BeginDeleteSecretOptions |
Az opcionális paramétereket képviselő felület, amely átadható a következőnek: beginDeleteSecret(string, BeginDeleteSecretOptions) |
BeginRecoverDeletedSecretOptions |
Az opcionális paramétereket képviselő felület, amely átadható a következőnek: beginRecoverDeletedSecret(string, BeginRecoverDeletedSecretOptions) |
DeletedSecret |
Törölt KeyVault-titkos kulcsot jelképező felület. |
GetDeletedSecretOptions |
A beállítások a következőhöz: getDeletedSecret(string, GetDeletedSecretOptions). |
GetSecretOptions |
A beállítások a következőhöz: getSecret(string, GetSecretOptions). |
KeyVaultSecret |
A KeyVault Secretet jelképező felület, amelynek neve, értéke és Titkos kulcstulajdonságai. |
KeyVaultSecretIdentifier |
Azokat a szegmenseket jelöli, amelyek Key Vault titkos azonosítót írnak. |
ListDeletedSecretsOptions |
A beállítások a következőhöz: listDeletedSecrets(ListDeletedSecretsOptions). |
ListPropertiesOfSecretVersionsOptions |
A beállítások a következőhöz: listPropertiesOfSecretVersions(string, ListPropertiesOfSecretVersionsOptions). |
ListPropertiesOfSecretsOptions |
A beállítások a következőhöz: listPropertiesOfSecrets(ListPropertiesOfSecretsOptions). |
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ációt mind a befejezésig, mind az oldal szerint. |
PollOperationState |
A PollOperationState a hosszú ideig futó művelet pollerének definiálá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. Frissíteni kell legalább a művelet indításakor, befejezésekor és megszakításakor. 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 beállítások a következőhöz: purgeDeletedSecret(string, PurgeDeletedSecretOptions). |
RestoreSecretBackupOptions |
A beállítások a következőhöz: restoreSecretBackup(Uint8Array, RestoreSecretBackupOptions). |
SecretClientOptions |
A KeyVault KeyClient által elfogadott választható paraméterek |
SecretPollerOptions |
A és <xref:beginRecoverDeletedKey>a számára átadható beginDeleteSecret(string, BeginDeleteSecretOptions) opcionális paramétereket képviselő felület. |
SecretProperties |
Egy KeyVaultSecret tulajdonságait képviselő felület. |
SetSecretOptions |
A beállítások a következőhöz: setSecret(string, string, SetSecretOptions). |
UpdateSecretPropertiesOptions |
A beállítások a következőhöz: updateSecretProperties(string, string, UpdateSecretPropertiesOptions). |
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és művelet elleni védelemnek; az adatok helyrehozhatatlanul elvesznek egy törlési művelet entitásszinten vagy magasabb szinten (tároló, erőforráscsoport, előfizetés stb.) elfogadásakor. |
Enumerációk
KnownDeletionRecoveryLevel |
A szolgáltatás által elfogadott DeletionRecoveryLevel ismert értékei. |
Függvények
parse |
Elemzi a megadott Key Vault titkos azonosító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 megadott Key Vault titkos azonosító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 kód azonosítója.