你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
此包包含适用于 Azure Atlas 客户端的同构 SDK(在 Node.js 和浏览器中运行)。
关键链接:
入门指南
当前支持的环境
- LTS 版本的 Node.js
- 最新版本的 Safari、Chrome、Edge 和 Firefox。
有关详细信息,请参阅我们的 支持策略。
先决条件
- 一个 Azure 订阅。
安装 @azure/arm-mongodbatlas
包
使用以下命令 npm
安装适用于 JavaScript 的 Azure Atlas 客户端库:
npm install @azure/arm-mongodbatlas
创建和验证 AtlasClient
要创建客户端对象以访问 Azure Atlas API,您需要 endpoint
Azure Atlas 资源的 credential
. Azure Atlas 客户端可以使用 Azure Active Directory 凭据进行身份验证。
可以在 Azure 门户中找到 Azure Atlas 资源的终结点。
可以使用来自
若要使用如下所示的 DefaultAzureCredential 提供程序,或 Azure SDK 提供的其他凭据提供程序,请安装 @azure/identity
包:
npm install @azure/identity
您还需要 注册一个新的 AAD 应用程序,并通过 为您的服务主体分配合适的角色来授予对 Azure Atlas 的访问权限(注意:此类 "Owner"
角色不会授予必要的权限)。
有关如何创建 Azure AD 应用程序的详细信息,请参阅本指南 。
使用 Node.js 和类似 Node 的环境,可以使用 DefaultAzureCredential
类对客户端进行身份验证。
import { AtlasClient } from "@azure/arm-mongodbatlas";
import { DefaultAzureCredential } from "@azure/identity";
const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new AtlasClient(new DefaultAzureCredential(), subscriptionId);
对于浏览器环境,请使用 InteractiveBrowserCredential
包中的 @azure/identity
进行身份验证。
import { InteractiveBrowserCredential } from "@azure/identity";
import { AtlasClient } from "@azure/arm-mongodbatlas";
const subscriptionId = "00000000-0000-0000-0000-000000000000";
const credential = new InteractiveBrowserCredential({
tenantId: "<YOUR_TENANT_ID>",
clientId: "<YOUR_CLIENT_ID>",
});
const client = new AtlasClient(credential, subscriptionId);
JavaScript 捆绑包
若要在浏览器中使用此客户端库,首先需要使用捆绑程序。 有关如何执行此操作的详细信息,请参阅我们的 捆绑文档。
重要概念
Atlas客户端
AtlasClient
是使用 Azure Atlas 客户端库的开发人员的主要接口。 探索此客户端对象上的方法,以了解可以访问的 Azure Atlas 服务的不同功能。
故障排除
伐木业
启用日志记录可能有助于发现有关故障的有用信息。 若要查看 HTTP 请求和响应的日志,请将 AZURE_LOG_LEVEL
环境变量设置为 info
。 或者,可以通过在 setLogLevel
中调用 @azure/logger
在运行时启用日志记录:
import { setLogLevel } from "@azure/logger";
setLogLevel("info");
有关如何启用日志的更详细说明,可以查看 @azure/记录器包文档。
后续步骤
请查看 示例 目录,获取有关如何使用此库的详细示例。
贡献
若要参与此库,请阅读 贡献指南 了解有关如何生成和测试代码的详细信息。