Dela via

Azure CosmosDBManagement-klientbibliotek för JavaScript – version 16.0.0

  • Artikel

Det här paketet innehåller en isomorf SDK (körs både i Node.js och i webbläsare) för Azure CosmosDBManagement-klienten.

REST API för Azure Cosmos DB Database-tjänstresursprovider

| Package (NPM) | API-referensdokumentation | Exempel

Komma igång

Miljöer som stöds för närvarande

Mer information finns i vår supportprincip.

Förutsättningar

Installera @azure/arm-cosmosdb-paketet

Installera Azure CosmosDBManagement-klientbiblioteket för JavaScript med npm:

npm install @azure/arm-cosmosdb

Skapa och autentisera en CosmosDBManagementClient

Om du vill skapa ett klientobjekt för åtkomst till Azure CosmosDBManagement-API:et behöver du endpoint för din Azure CosmosDBManagement-resurs och en credential. Azure CosmosDBManagement-klienten kan använda Azure Active Directory-autentiseringsuppgifter för att autentisera. Du hittar slutpunkten för din Azure CosmosDBManagement-resurs i Azure-portalen.

Du kan autentisera med Azure Active Directory med hjälp av en autentiseringsuppgift från biblioteket @azure/identitet eller en befintlig AAD-token.

Installera @azure/identity-paketet om du vill använda DefaultAzureCredential- som visas nedan eller andra leverantörer av autentiseringsuppgifter som tillhandahålls med Azure SDK:

npm install @azure/identity

Du måste också registrera ett nytt AAD-program och bevilja åtkomst till Azure CosmosDBManagement genom att tilldela lämplig roll till tjänstens huvudnamn (obs! roller som "Owner" beviljar inte nödvändiga behörigheter). Ange värdena för klient-ID, klient-ID och klienthemlighet för AAD-programmet som miljövariabler: AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET.

Mer information om hur du skapar ett Azure AD-program finns i den här guiden.

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-paket

Om du vill använda det här klientbiblioteket i webbläsaren måste du först använda en bundler. Mer information om hur du gör detta finns i vår paketeringsdokumentation.

Viktiga begrepp

CosmosDBManagementClient

CosmosDBManagementClient är det primära gränssnittet för utvecklare som använder Azure CosmosDBManagement-klientbiblioteket. Utforska metoderna för det här klientobjektet för att förstå de olika funktionerna i Azure CosmosDBManagement-tjänsten som du kan komma åt.

Felsökning

Skogsavverkning

Aktivering av loggning kan hjälpa dig att hitta användbar information om fel. Om du vill se en logg med HTTP-begäranden och svar anger du AZURE_LOG_LEVEL miljövariabeln till info. Du kan också aktivera loggning vid körning genom att anropa setLogLevel i @azure/logger:

const { setLogLevel } = require("@azure/logger");
setLogLevel("info");

Mer detaljerade anvisningar om hur du aktiverar loggar finns i @azure/logger-paketdokumenten.

Nästa steg

Ta en titt på exempel katalog för detaljerade exempel på hur du använder det här biblioteket.

Bidragande

Om du vill bidra till det här biblioteket kan du läsa bidragsguide för att lära dig mer om hur du skapar och testar koden.

visningar