Azure CommunicationServiceManagement klientbibliotek för JavaScript - version 5.0.0

Detta paket innehåller ett isomorft SDK (körs både i Node.js och i webbläsare) för Azure CommunicationServiceManagement-klient.

REST API för e-posttjänster/domäner/suppressionlistor

Nyckellänkar:

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-communication-paketet

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

npm install @azure/arm-communication

Skapa och autentisera en CommunicationServiceManagementClient

För att skapa ett klientobjekt för att få tillgång till Azure CommunicationServiceManagement API behöver du endpoint för din Azure CommunicationServiceManagement-resurs och en credential. Azure CommunicationServiceManagement-klienten kan använda Azure Active Directory-uppgifter för autentisering. Du kan hitta slutpunkten för din Azure CommunicationServiceManagement-resurs i Azure Portal.

Du kan autentisera dig med Azure Active Directory med en legitimation från biblioteket @azure/identity 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 SDKs:

npm install @azure/identity

Du måste också registrera en ny AAD-ansökan och ge tillgång till Azure CommunicationServiceManagement genom att ge din tjänstechef rätt roll (observera: roller som "Owner" ger inte nödvändiga behörigheter).

För mer information om hur man skapar en Azure AD-applikation, kolla in denna guide.

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

import { CommunicationServiceManagementClient } from "@azure/arm-communication";
import { DefaultAzureCredential } from "@azure/identity";

const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new CommunicationServiceManagementClient(
  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 { CommunicationServiceManagementClient } from "@azure/arm-communication";

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

CommunicationServiceManagementClient

CommunicationServiceManagementClient är det primära gränssnittet för utvecklare som använder klientbiblioteket Azure CommunicationServiceManagement. Utforska metoderna på detta klientobjekt för att förstå de olika funktionerna i Azure CommunicationServiceManagement-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 dokument för @azure/logger-paket.

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.