Azure Identity Beépülő modul Visual Studio Code-hitelesítéshez

Ez a csomag egy beépülő modult biztosít a JavaScripthez készült Azure Identity-kódtárhoz (@azure/identity), amely a Visual Studio Code "Azure Account" bővítményén keresztül engedélyezi a hitelesítést. Ez a beépülő modul biztosítja az in @azure/identity függőségeitVisualStudioCodeCredential, és lehetővé teszi, hogy önállóan vagy a részeként DefaultAzureCredentialhasználja.

Forráskód | Minták

Első lépések

import { useIdentityPlugin } from "@azure/identity";
import { vsCodePlugin } from "@azure/identity-vscode";

useIdentityPlugin(vsCodePlugin);

Előfeltételek

• Egy Azure-előfizetés.
• A Visual Studio Code és az "Azure Account" bővítmény telepítése

A csomag telepítése

Ezt a csomagot úgy tervezték, hogy az Azure Identity for JavaScripttel használható legyen. Telepítse mindkettőt @azure/identity és ezt a csomagot a használatával npm:

$ npm install --save @azure/identity
$ npm install --save-dev @azure/identity-vscode

Támogatott környezetek

A JavaScripthez készült Azure Identity beépülő modulok támogatják a Node.js stabil (páros számozott) verzióit a 12-es verziótól kezdve. Bár a beépülő modulok más Node-verziókban is futhatnak, a támogatás nem garantált. @azure/identity-vscode nem támogatja a böngészőkörnyezeteket.

Fő fogalmak

Ha most először használja @azure/identity a vagy az Microsoft Identitásplatform (Azure Active Directory), javasoljuk, hogy először olvassa el a Használat @azure/identity a Microsoft Identity Platformmal című cikket. Ez a dokumentum részletesebben ismerteti a platformot és az Azure-fiók helyes konfigurálását.

Azure Identity beépülő modulok

@azure/identity A 2.0.0-s verziótól a JavaScript identitásügyfél-kódtára tartalmaz egy beépülő modul API-t. Ez a csomag (@azure/identity-vscode) egy beépülő modulobjektumot exportál, amelyet argumentumként kell átadnia a csomag legfelső szintű useIdentityPlugin függvényének @azure/identity . Engedélyezze a hitelesítést a Visual Studio Code "Azure Account" bővítményén keresztül az alábbiak szerint:

import { useIdentityPlugin } from "@azure/identity";
import { vsCodePlugin } from "@azure/identity-vscode";

useIdentityPlugin(vsCodePlugin);

A hívása useIdentityPluginután a VisualStudioCodeCredential@azure/identity csomagból származó fájl engedélyezve lesz. Ha ezt a beépülő modult nem használják, akkor VisualStudioCodeCredential dobni fog egy CredentialUnavailableError, és nem lesz elérhető a DefaultAzureCredentialrészeként.

Visual Studio Code-hitelesítés

VisualStudioCodeCredential az "Azure-fiók" bővítmény hitelesítési munkamenetét használja. A hitelesítő adatok használatához be kell jelentkeznie az Azure-fiókjába a bővítmény használatával. Ehhez nyissa meg a Visual Studio Code-ot, győződjön meg arról, hogy a bővítmény telepítve van, és jelentkezzen be a Parancskatalógusból az "Azure: Bejelentkezés" lehetőséggel egy böngészőablak megnyitásához és az Azure-ba való bejelentkezéshez. Másik lehetőségként választhatja az "Azure: Bejelentkezés eszközkóddal" lehetőséget az eszközkód-folyamat használatához.

A bejelentkezés után előfordulhat, hogy ki kell választania egy előfizetést (például ha több Azure-előfizetéssel rendelkezik), és a menüben módosíthatja az aktív előfizetést az "Azure: Előfizetések kiválasztása" bejegyzés kiválasztásához.

Példák

A beépülő modul regisztrálása után a többi hitelesítőadat-osztályhoz hasonló módon használhatja VisualStudioCodeCredential a következőben @azure/identity:

import { useIdentityPlugin, VisualStudioCodeCredential } from "@azure/identity";
import { vsCodePlugin } from "@azure/identity-vscode";

useIdentityPlugin(vsCodePlugin);

async function main() {
  const credential = new VisualStudioCodeCredential();

  // The graph.microsoft.com scope is used as an example
  const scope = "https://graph.microsoft.com/.default";

  // Print out part of the access token
  console.log((await credential.getToken(scope)).token.substr(0, 10), "...");
}

main().catch((error) => {
  console.error("An error occurred:", error);
  process.exit(1);
});

Használhatja azt is DefaultAzureCredential, amely megkísérli a hitelesítést a Visual Studio Code "Azure Account" bővítményével, ha elérhető:

import { useIdentityPlugin, DefaultAzureCredential } from "@azure/identity";
import { vsCodePlugin } from "@azure/identity-vscode";

useIdentityPlugin(vsCodePlugin);

async function main() {
  // With the plugin enabled above, `DefaultAzureCredential` will use
  // Visual Studio Code's "Azure Account" extension to authenticate if
  // it is available.
  const credential = new DefaultAzureCredential();

  // This will print a JWT access_token and its expiration timestamp
  // The graph.microsoft.com scope is used as an example
  console.log("Token:", await credential.getToken("https://graph.microsoft.com/.default"));
}

main().catch((error) => {
  console.error("An error occurred:", error);
  process.exit(1);
});

Hibaelhárítás

Naplózás

A naplózás engedélyezése hasznos információkat deríthet fel a hibákról. A HTTP-kérések és -válaszok naplójának megtekintéséhez állítsa a környezeti változót értékre AZURE_LOG_LEVELinfo. A naplózás futásidőben is engedélyezhető a következő hívásával setLogLevel@azure/logger:

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

setLogLevel("info");

Következő lépések

Visszajelzés küldése

Ha hibákat tapasztal, vagy javaslatai vannak, nyisson meg egy problémát.

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 buildeléséhez és teszteléséhez.