適用於 JavaScript 的 Azure CosmosDBManagement 用戶端連結庫 - 16.0.0 版
此套件包含 Azure CosmosDBManagement 用戶端的同型 SDK(在 Node.js 和瀏覽器中執行)。
Azure Cosmos DB 資料庫服務資源提供者 REST API
原始程式碼 | 套件 (NPM) | API 參考檔 | 範例
開始
目前支持的環境
- LTS 版本的 Node.js
- 最新版的 Safari、Chrome、Edge 和 Firefox。
如需詳細資訊,請參閱我們的 支持原則。
先決條件
安裝 @azure/arm-cosmosdb
套件
使用 npm
安裝適用於 JavaScript 的 Azure CosmosDBManagement 用戶端連結庫:
npm install @azure/arm-cosmosdb
建立和驗證 CosmosDBManagementClient
若要建立客戶端物件來存取 Azure CosmosDBManagement API,您需要 Azure CosmosDBManagement 資源的 endpoint
和 credential
。 Azure CosmosDBManagement 用戶端可以使用 Azure Active Directory 認證進行驗證。
您可以在 Azure 入口網站中找到 Azure CosmosDBManagement 資源的端點,。
您可以使用來自 @azure/ 身分識別連結庫的認證,或 現有的 AAD 令牌,向 Azure Active Directory 進行驗證。
若要使用如下所示的 DefaultAzureCredential 提供者,或 Azure SDK 所提供的其他認證提供者,請安裝 @azure/identity
套件:
npm install @azure/identity
您也需要 註冊新的 AAD 應用程式,並將適當的角色指派給服務主體,以授與 Azure CosmosDBManagement 的存取權(注意:"Owner"
等角色不會授與必要的許可權)。
將 AAD 應用程式的用戶端識別碼、租使用者識別碼和客戶端密碼的值設定為環境變數:AZURE_CLIENT_ID
、AZURE_TENANT_ID
、AZURE_CLIENT_SECRET
。
如需如何建立 Azure AD 應用程式的詳細資訊,請參閱本指南 。
const { CosmosDBManagementClient } = require("@azure/arm-cosmosdb");
const { DefaultAzureCredential } = require("@azure/identity");
// For client-side applications running in the browser, use InteractiveBrowserCredential instead of DefaultAzureCredential. See https://aka.ms/azsdk/js/identity/examples for more details.
const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new CosmosDBManagementClient(new DefaultAzureCredential(), subscriptionId);
// For client-side applications running in the browser, use this code instead:
// const credential = new InteractiveBrowserCredential({
// tenantId: "<YOUR_TENANT_ID>",
// clientId: "<YOUR_CLIENT_ID>"
// });
// const client = new CosmosDBManagementClient(credential, subscriptionId);
JavaScript 套件組合
若要在瀏覽器中使用此用戶端連結庫,您必須先使用配套程式。 如需如何執行這項操作的詳細資訊,請參閱我們的 組合檔。
重要概念
CosmosDBManagementClient
CosmosDBManagementClient
是使用 Azure CosmosDBManagement 用戶端連結庫的開發人員的主要介面。 探索此客戶端物件上的方法,以瞭解您可以存取的 Azure CosmosDBManagement 服務的不同功能。
故障排除
伐木
啟用記錄可能有助於找出有關失敗的實用資訊。 若要查看 HTTP 要求和回應的記錄,請將 AZURE_LOG_LEVEL
環境變數設定為 info
。 或者,您可以在運行時間啟用記錄,方法是在 @azure/logger
中呼叫 setLogLevel
:
const { setLogLevel } = require("@azure/logger");
setLogLevel("info");
如需如何啟用記錄的詳細指示,請參閱
後續步驟
如需如何使用此連結庫的詳細範例,請參閱 範例 目錄。
貢獻
如果您想要參與此連結庫,請閱讀 參與指南,以深入瞭解如何建置和測試程序代碼。