Azure CognitiveServicesManagement client library for JavaScript - version 8.1.0

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

Cognitive Services Management-klient

| Package (NPM) | API-referensdokumentation | Exempel

Komma igång

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

Mer information finns i vår supportprincip.

Prerequisites

Installera @azure/arm-cognitiveservices-paketet

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

npm install @azure/arm-cognitiveservices

Skapa och autentisera en CognitiveServicesManagementClient

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

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

Installera -paketet om du vill använda @azure/identity 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 CognitiveServicesManagement genom att tilldela lämplig roll till tjänstens huvudnamn (obs! roller som "Owner" beviljar inte nödvändiga behörigheter).

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

Med hjälp av Node.js- och Node-liknande miljöer kan du använda klassen DefaultAzureCredential för att autentisera klienten.

import { CognitiveServicesManagementClient } from "@azure/arm-cognitiveservices";
import { DefaultAzureCredential } from "@azure/identity";

const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new CognitiveServicesManagementClient(new DefaultAzureCredential(), subscriptionId);

För webbläsarmiljöer använder du InteractiveBrowserCredential från @azure/identity-paketet för att autentisera.

import { InteractiveBrowserCredential } from "@azure/identity";
import { CognitiveServicesManagementClient } from "@azure/arm-cognitiveservices";

const subscriptionId = "00000000-0000-0000-0000-000000000000";
const credential = new InteractiveBrowserCredential({
  tenantId: "<YOUR_TENANT_ID>",
  clientId: "<YOUR_CLIENT_ID>",
});
const client = new CognitiveServicesManagementClient(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

CognitiveServicesManagementClient

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

Troubleshooting

Logging

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:

import { setLogLevel } from "@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.

Contributing

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.