通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

适用于 JavaScript 的 Azure 混合现实 身份验证客户端库 - 版本 1.0.0-beta.1

  • 项目

混合现实服务（如 Azure 空间定位点、Azure 远程渲染等）使用 混合现实 安全令牌服务 (STS) 进行身份验证。 此包支持从 STS 交换混合现实帐户凭据，该令牌可用于访问混合现实服务。

关键链接：

混合现实服务身份验证关系图

入门

目前支持的环境

先决条件

安装 @azure/mixed-reality-authentication 包

使用 npm安装适用于 JavaScript 的 Azure 混合现实 身份验证客户端库：

npm install @azure/mixed-reality-authentication

创建 MixedRealityStsClient 并对其进行身份验证

若要创建客户端对象以请求混合现实服务的访问令牌，需要account identifier混合现实服务资源的 和 account domain 以及 。credential

混合现实服务支持几种不同形式的身份验证：

  • 帐户密钥身份验证
    • 使用帐户密钥可以快速开始使用混合现实服务。 但是，在将应用程序部署到生产环境之前，我们建议你将应用更新为使用 Azure AD 身份验证。
  • Azure Active Directory (AD) 令牌身份验证
    • 如果你正在生成企业应用程序，并且你的公司使用 Azure AD 作为其标识系统，则你可以在应用中使用基于用户的 Azure AD 身份验证。 然后，使用现有的 Azure AD 安全组授予对混合现实帐户的访问权限。 还可以直接向组织中的用户授予访问权限。
    • 否则，我们建议从支持你的应用的 Web 服务获取 Azure AD 令牌。 建议将此方法用于生产应用程序，因为它可避免在客户端应用程序中嵌入用于访问混合现实服务的凭据。

有关详细说明和信息，请参阅 此处 。

使用帐户密钥身份验证

使用 Azure 门户浏览到混合现实服务资源并检索 account key。

拥有帐户密钥后，可以使用 AzureKeyCredential 类对客户端进行身份验证，如下所示：

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)
);

注意： 不建议 将帐户密钥身份验证用于生产应用程序。

使用 Azure Active Directory 凭据

大多数示例中都使用帐户密钥身份验证，但也可以使用 Azure 标识库通过 Azure Active Directory 进行身份验证。 这是建议用于生产应用程序的方法。 若要使用如下所示的 DefaultAzureCredential 提供程序或 Azure SDK 提供的其他凭据提供程序，请安装包 @azure/identity ：

npm install @azure/identity

还需要注册新的 AAD 应用程序，并通过将混合现实服务的相应角色分配给服务主体来授予对混合现实资源的访问权限。

将 AAD 应用程序的客户端 ID、租户 ID 和客户端机密的值设置为环境变量： 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());

关键概念

MixedRealityStsClient

MixedRealityStsClient是用于访问 混合现实 STS 以获取访问令牌的客户端库。

从混合现实 STS 获取的令牌的生存期为 24 小时。

返回值

成功调用 getTokenGetTokenResponse的返回值为 ，它是AccessToken来自 @azure/core-http 的 。

示例

检索访问令牌

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();

有关更复杂的身份验证方案，请参阅 上面的 身份验证示例或 Azure 标识 。

在混合现实客户端库中使用访问令牌

某些混合现实客户端库可能会接受访问令牌来代替凭据。 例如：

// 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);

注意：上述 SpatialAnchorsClient 用法是假设的，可能不会反映实际库。 请参阅所使用的客户端库的文档，确定是否以及如何支持此功能。

疑难解答

日志记录

启用日志记录可能有助于发现有关故障的有用信息。 若要查看 HTTP 请求和响应的日志，请将 AZURE_LOG_LEVEL 环境变量设置为 info。 或者，可以在运行时通过调用 @azure/logger 中的 setLogLevel 来启用日志记录：

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

setLogLevel("info");

有关如何启用日志的更详细说明，请查看 @azure/logger 包文档。

后续步骤

请查看 示例 目录，获取有关如何使用此库的详细示例。

贡献

本项目欢迎贡献和建议。 大多数贡献要求你同意贡献者许可协议 (CLA)，并声明你有权（并且确实有权）授予我们使用你的贡献的权利。 有关详细信息，请访问 https://cla.microsoft.com 。

提交拉取请求时，CLA 机器人将自动确定你是否需要提供 CLA，并相应地修饰 PR（例如标签、注释）。 直接按机器人提供的说明操作。 只需使用 CLA 对所有存储库执行一次这样的操作。

此项目采用了 Microsoft 开放源代码行为准则。 有关详细信息，请参阅行为准则常见问题解答，或如果有任何其他问题或意见，请与 联系。

若要为此库做出贡献，请阅读贡献指南，详细了解如何生成和测试代码。

曝光数