Megosztás a következőn keresztül:

Azure Key Vault felügyeleti ügyféloldali kódtár JavaScripthez – 4.7.0-s verzió

Az Azure Key Vault felügyelt HSM egy teljes körűen felügyelt, magas rendelkezésre állású, egybérlős, szabványoknak megfelelő felhőszolgáltatás, amely lehetővé teszi a titkosítási kulcsok védelmét a felhőalkalmazások számára a FIPS 140–2 3. szintű hitelesített HSM-ek használatával. Ha többet szeretne megtudni az Azure Key Vault által felügyelt HSM-ről, érdemes lehet áttekinteni a következőt: Mi az Az Azure Key Vault által felügyelt HSM?

A csomag @azure/keyvault-admin támogatja a rendszergazdai Key Vault-feladatokat, például a teljes biztonsági mentést/ visszaállítást és a kulcsszintű szerepköralapú hozzáférés-vezérlést (RBAC).

Megjegyzés: A felügyeleti kódtár csak Azure Key Vault felügyelt HSM- működik – a Key Vaultot célzó függvények sikertelenek lesznek.

Megjegyzés: Ez a csomag az Azure Key Vault szolgáltatás korlátozásai miatt nem használható a böngészőben, útmutatásért tekintse meg a dokumentum .

Főbb hivatkozások:

Kezdő lépések

A csomag telepítése

Telepítse az Azure Key Vault felügyeleti ügyfélkódtárát JavaScripthez és TypeScripthez NPM:

npm install @azure/keyvault-admin

TypeScript konfigurálása

A TypeScript-felhasználóknak telepítve kell lenniük a csomóponttípus-definícióknak:

npm install @types/node

A tsconfig.jsoncompilerOptions.allowSyntheticDefaultImports is engedélyeznie kell. Vegye figyelembe, hogy ha engedélyezte a compilerOptions.esModuleInterop, a allowSyntheticDefaultImports alapértelmezés szerint engedélyezve van. További információért tekintse meg TypeScript fordítóbeállítási kézikönyvét.

Jelenleg támogatott környezetek

Előfeltételek

Az ügyfél hitelesítése

Az Azure Key Vault szolgáltatással való interakcióhoz létre kell hoznia egy példányt a KeyVaultAccessControlClient osztályból vagy a KeyVaultBackupClient osztályból, valamint egy tároló URL- (amelyet "DNS-névnek" tekinthet az Azure Portalon) és egy hitelesítő objektumot. A dokumentumban bemutatott példák egy DefaultAzureCredentialnevű hitelesítő objektumot használnak, amely a legtöbb forgatókönyvhez, beleértve a helyi fejlesztési és éles környezeteket is. Emellett azt is javasoljuk, hogy felügyelt identitás használjon éles környezetekben történő hitelesítéshez.

A hitelesítés különböző módjairól és a hozzájuk tartozó hitelesítő adatok típusairól az Azure Identity dokumentációjánaktalál további információt.

KeyVaultAccessControlClient létrehozása

Miután hitelesítést a legjobbanmegfelelő hitelesítési módszerrel, az alábbiak szerint hozhat létre egy KeyVaultAccessControlClient, a konstruktorban a felügyelt HSM URL-címére helyettesítve:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyVaultAccessControlClient } from "@azure/keyvault-admin";

const vaultUrl = `https://<MY KEY VAULT HERE>.vault.azure.net`;
const credentials = new DefaultAzureCredential();
const client = new KeyVaultAccessControlClient(vaultUrl, credentials);

KeyVaultBackupClient létrehozása

Miután hitelesítést a legjobbanmegfelelő hitelesítési módszerrel, az alábbiak szerint hozhat létre egy KeyVaultBackupClient, a konstruktorban a felügyelt HSM URL-címére helyettesítve:

import { DefaultAzureCredential } from "@azure/identity";
import { KeyVaultBackupClient } from "@azure/keyvault-admin";

const vaultUrl = `https://<MY KEY VAULT HERE>.vault.azure.net`;
const credentials = new DefaultAzureCredential();
const client = new KeyVaultBackupClient(vaultUrl, credentials);

Főbb fogalmak

KeyVaultRoleDefinition

A szerepkördefiníció engedélyek gyűjteménye. A szerepkördefiníció határozza meg azokat a műveleteket, amelyek végrehajthatók, például olvasás, írás és törlés. Megadhatja az engedélyezett műveletekből kizárt műveleteket is.

A szerepkördefiníciók egy KeyVaultRoleAssignmentrészeként listázhatók és adhatók meg.

KeyVaultRoleAssignment

A szerepkör-hozzárendelés egy szerepkördefiníció társítása egy szolgáltatásnévhez. Ezek létrehozhatók, listázhatók, beolvashatók egyenként és törölhetők.

KeyVaultAccessControlClient

A KeyVaultAccessControlClient olyan műveleteket biztosít, amelyek lehetővé teszik a szerepkör-definíciók (KeyVaultRoleDefinitionpéldányai) és a szerepkör-hozzárendelések (KeyVaultRoleAssignmentpéldányai) kezelését.

KeyVaultBackupClient

A KeyVaultBackupClient teljes kulcsos biztonsági mentések, teljes kulcsok visszaállítása és szelektív kulcs-visszaállítások végrehajtására szolgálnak.

Hosszú ideig futó műveletek

A KeyVaultBackupClient által végzett műveletek az Azure-erőforrások által igényelt mennyiségű időt is igénybe vehetnek, így az ügyfélrétegnek nyomon kell követnie, szerializálnia és folytatnia kell a műveleteket azoknak a programoknak az életciklusán keresztül, amelyek megvárják, amíg befejeződnek. Ez a @azure/core-lro.

A KeyVaultBackupClient három olyan metódust kínál, amelyek hosszú ideig futó műveleteket hajtanak végre:

  • beginBackupelkezd biztonsági másolatot készíteni egy Azure Key Vault által felügyelt HSM-ről a megadott Storage Blob-fiókon.
  • beginRestoreelkezdi visszaállítani az összes kulcsfontosságú anyagot a korábban tárolt Azure Blob Storage biztonsági mentési mappájára mutató SAS-jogkivonat használatával.
  • beginSelectiveRestoreegy adott kulcs összes kulcsverzióját visszaállítja a felhasználó által megadott SAS-jogkivonat használatával, amely egy korábban tárolt Azure Blob Storage biztonsági mentési mappára mutat.

A hosszú ideig futó műveleteket kezdő metódusok egy lekérdezést adnak vissza, amely lehetővé teszi, hogy határozatlan ideig várjon, amíg a művelet befejeződik. További információt az alábbi példákban talál.

Példák

JavaScript- és TypeScript-mintákkal is rendelkezünk, amelyek a csomag hozzáférés-vezérlési és biztonsági mentési/visszaállítási funkcióit mutatják. A minták futtatásához kövesse a megfelelő olvasási útmutatót.

Hibaelhárítás

A különböző hibaforgatókönyvek diagnosztizálásával kapcsolatos részletekért tekintse meg hibaelhárítási útmutatónkat.

A naplózás engedélyezése segíthet a hibákról szóló hasznos információk feltárásában. A HTTP-kérések és válaszok naplójának megtekintéséhez állítsa a környezeti változót a AZURE_LOG_LEVEL következőre info: . Alternatívaként a naplózás futásidőben is engedélyezhető a setLogLevel hívásával a @azure/logger.

import { setLogLevel } from "@azure/logger";

setLogLevel("info");

Következő lépések

További kódmintákat az alábbi hivatkozásokon talál:

Közreműködés

Ha hozzá szeretne járulni ehhez a kódtárhoz, olvassa el a közreműködői útmutatót, amelyből többet is megtudhat a kód összeállításáról és teszteléséről.

  • Last updated on