Sdílet prostřednictvím

Klientská knihovna azure Mixed Reality Authentication pro JavaScript – verze 1.0.0-beta.1

Služby hybridní reality, jako je Azure Remote Rendering, k ověřování používají službu tokenů zabezpečení hybridní reality (STS). Tento balíček podporuje výměnu přihlašovacích údajů účtu hybridní reality pro přístupový token ze služby STS, který lze použít pro přístup ke službám hybridní reality.

Klíčové odkazy:

  • | zdrojového kódu
  • | balíčku(NPM)
  • Referenční dokumentace k rozhraní API |
  • ukázky

Začínáme

Aktuálně podporovaná prostředí

Požadavky

Instalace balíčku @azure/mixed-reality-authentication

Nainstalujte klientskou knihovnu Azure Mixed Reality Authentication pro JavaScript pomocí npm:

npm install @azure/mixed-reality-authentication

Vytvoření a ověření MixedRealityStsClient

Pokud chcete vytvořit objekt klienta pro vyžádání přístupového tokenu pro službu Mixed Reality, budete potřebovat account identifier a account domain prostředku služby Mixed Reality a credential.

Služby hybridní reality podporují několik různých forem ověřování:

  • Ověřování pomocí klíče účtu
    • Klíče účtu umožňují rychle začít používat služby hybridní reality. Než ale aplikaci nasadíte do produkčního prostředí, doporučujeme aplikaci aktualizovat tak, aby používala ověřování Azure AD.
  • Ověřování tokenu Azure Active Directory (AD)
    • Pokud vytváříte podnikovou aplikaci a vaše společnost používá Azure AD jako svůj systém identit, můžete ve své aplikaci použít ověřování Azure AD založené na uživatelích. Pak udělíte přístup k účtům hybridní reality pomocí stávajících skupin zabezpečení Azure AD. Můžete také udělit přístup přímo uživatelům ve vaší organizaci.
    • V opačném případě doporučujeme získat tokeny Azure AD z webové služby, která podporuje vaši aplikaci. Tuto metodu doporučujeme pro produkční aplikace, protože umožňuje vyhnout se vkládání přihlašovacích údajů pro přístup ke službě hybridní reality ve vaší klientské aplikaci.

Ověřování pomocí klíče účtu

Pomocí webu Azure Portal přejděte k prostředku služby Mixed Reality a načtěte account key.

Jakmile máte klíč účtu, můžete k ověření klienta použít třídu AzureKeyCredential následujícím způsobem:

const { AzureKeyCredential } = require("@azure/core-auth");

const { MixedRealityStsClient } = require("@azure/mixed-reality-authentication");

const accountId = "<ACCOUNTD ID>";
const accountDomain = "<ACCOUNT_DOMAIN>";
const accountKey = "<ACCOUNT_KEY>";

const client = new MixedRealityStsClient(
  accountId,
  accountDomain,
  new AzureKeyCredential(accountKey)
);

Poznámka: Ověřování pomocí klíče účtu se nedoporučuje pro produkční aplikace.

Použití přihlašovacích údajů Azure Active Directory

Ověřování pomocí klíče účtu se používá ve většině příkladů, ale můžete se také ověřit pomocí azure Active Directory pomocí knihovny Azure Identity Library. Toto je doporučená metoda pro produkční aplikace. Pokud chcete použít poskytovatele DefaultAzureCredential zobrazené níže nebo jiné zprostředkovatele přihlašovacích údajů poskytnuté sadou Azure SDK, nainstalujte balíček @azure/identity:

npm install @azure/identity

Budete také muset [zaregistrovat novou aplikaci AAD][register_aad_app] a udělit přístup k vašemu prostředku hybridní reality přiřazením příslušné role pro službu Mixed Reality instančnímu objektu.

Nastavte hodnoty ID klienta, ID tenanta a tajného klíče klienta aplikace AAD jako proměnné prostředí: AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET.

const { MixedRealityStsClient } = require("@azure/mixed-reality-authentication");
const { DefaultAzureCredential } = require("@azure/identity");

const client = new MixedRealityStsClient(accountId, accountDomain, new DefaultAzureCredential());

Klíčové koncepty

MixedRealityStsClient

MixedRealityStsClient je klientská knihovna používaná pro přístup ke službě Zabezpečení hybridní reality pro získání přístupového tokenu.

Tokeny získané ze služby ZABEZPEČENÍ hybridní reality mají životnost 24 hodin.

Návratová hodnota

Návratová hodnota úspěšného volání getToken je GetTokenResponse, což je AccessToken z @azure/core-http .

Příklady

Načtení přístupového tokenu

const { AzureKeyCredential } = require("@azure/core-auth");

const { MixedRealityStsClient } = require("@azure/mixed-reality-authentication");

const accountId = "<ACCOUNTD ID>";
const accountDomain = "<ACCOUNT_DOMAIN>";
const accountKey = "<ACCOUNT_KEY>";

const client = new MixedRealityStsClient(
  accountId,
  accountDomain,
  new AzureKeyCredential(accountKey)
);

const token = await client.getToken();

Složitější scénáře ověřování najdete v tématu Azure Identity.

Použití přístupového tokenu v klientské knihovně hybridní reality

Některé klientské knihovny hybridní reality můžou místo přihlašovacích údajů přijmout přístupový token. Například:

// GetMixedRealityAccessTokenFromWebService is a hypothetical method that retrieves
// a Mixed Reality access token from a web service. The web service would use the
// MixedRealityStsClient and credentials to obtain an access token to be returned
// to the client.
const accessToken = await GetMixedRealityAccessTokenFromWebService();

const account = new SpatialAnchorsAccount(accountId, accountDomain);
const client = new SpatialAnchorsClient(account, accessToken);

Poznámka: Výše uvedené SpatialAnchorsClient využití je hypotetické a nemusí odrážet skutečnou knihovnu. Projděte si dokumentaci ke klientské knihovně, kterou používáte, a zjistěte, jestli a jak se to může podporovat.

Řešení problémů

Protokolování

Povolení protokolování může pomoct odhalit užitečné informace o chybách. Pokud chcete zobrazit protokol požadavků a odpovědí HTTP, nastavte proměnnou prostředí AZURE_LOG_LEVEL na info. Případně můžete protokolování povolit za běhu voláním setLogLevel v @azure/logger:

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

setLogLevel("info");

Podrobnější pokyny k povolení protokolů najdete v dokumentaci k @azure/protokolovacímu balíčku.

Další kroky

Podrobné příklady použití této knihovny najdete v ukázkách adresáři.

Přispívající

Tento projekt vítá příspěvky a návrhy. Většina příspěvků vyžaduje souhlas s licenční smlouvou s přispěvatelem (CLA), která deklaruje, že máte právo a ve skutečnosti nám udělíte práva k používání vašeho příspěvku. Podrobnosti najdete v https://cla.microsoft.com.

Když odešlete žádost o přijetí změn, robot CLA automaticky určí, jestli potřebujete poskytnout CLA, a odpovídajícím způsobem vyzdobit žádost o přijetí změn (např. popisek, komentář). Stačí postupovat podle pokynů poskytovaných robotem. Stačí to udělat jen jednou napříč všemi úložištěmi pomocí naší cla.

Tento projekt přijal pravidla chování microsoftu open source . Další informace najdete v nejčastějších dotazech k kodexu chování nebo kontaktujte opencode@microsoft.com s dalšími dotazy nebo komentáři.

Pokud chcete přispívat do této knihovny, přečtěte si průvodce přispívání a přečtěte si další informace o vytváření a testování kódu.

imprese

  • Last updated on