Azure CommunicationServiceManagement Client-Bibliothek für JavaScript - Version 5.0.0

Dieses Paket enthält ein isomorphes SDK (läuft sowohl in Node.js als auch in Browsern) für Azure CommunicationServiceManagement-Client.

REST-API für E-Mail-Dienste/Domains/SuppressionLists

Wichtige Links:

Erste Schritte

Derzeit unterstützte Umgebungen

Weitere Informationen finden Sie in unserer Supportrichtlinie.

Voraussetzungen

Installieren Sie das @azure/arm-communication-Paket

Installiere die Azure CommunicationServiceManagement-Client-Bibliothek für JavaScript mit npm:

npm install @azure/arm-communication

Erstellen und Authentifizieren einer CommunicationServiceManagementClient

Um ein Client-Objekt zu erstellen, das auf die Azure CommunicationServiceManagement API zugriff, benötigen Sie das endpoint Ihrer Azure CommunicationServiceManagement-Ressource und ein credential. Der Azure CommunicationServiceManagement-Client kann Azure Active Directory-Zugangsdaten zur Authentifizierung verwenden. Den Endpunkt für deine Azure CommunicationServiceManagement-Ressource findest du unter Azure-Portal.

Sie können sich mit Azure Active Directory authentifizieren, indem Sie eine Berechtigung aus der Bibliothek @azure/identity oder einem bestehenden AAD Token authentifizieren.

Um den unten gezeigten DefaultAzureCredential Anbieter oder andere Anmeldeinformationsanbieter zu verwenden, die mit dem Azure SDK bereitgestellt werden, installieren Sie bitte das @azure/identity Paket:

npm install @azure/identity

Sie müssen außerdem eine neue AAD-Anmeldung registrieren und Zugang zu Azure CommunicationServiceManagement gewähren, indem Sie die geeignete Rolle Ihrem Service Principal zuweisen (Hinweis: Rollen wie "Owner" gewähren nicht die erforderlichen Berechtigungen).

Für weitere Informationen darüber, wie man eine Azure AD-Anwendung erstellt, siehe diesen Leitfaden.

Mithilfe von Node.js- und Node-ähnlichen Umgebungen können Sie die DefaultAzureCredential Klasse verwenden, um den Client zu authentifizieren.

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,
);

Verwenden Sie für Browserumgebungen die InteractiveBrowserCredential aus dem @azure/identity Paket, um sich zu authentifizieren.

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-Bündel

Um diese Clientbibliothek im Browser zu verwenden, müssen Sie zuerst einen Bundler verwenden. Ausführliche Informationen dazu finden Sie in unserer Bündelungsdokumentation.

Wichtige Begriffe

CommunicationServiceManagementClient

CommunicationServiceManagementClient ist die primäre Schnittstelle für Entwickler, die die Client-Bibliothek Azure CommunicationServiceManagement verwenden. Erkunden Sie die Methoden dieses Client-Objekts, um die verschiedenen Funktionen des Azure CommunicationServiceManagement-Dienstes zu verstehen, auf den Sie Zugriff haben.

Troubleshooting

Logging

Das Aktivieren der Protokollierung kann hilfreiche Informationen zu Fehlern aufdecken. Um ein Protokoll von HTTP-Anforderungen und -Antworten anzuzeigen, legen Sie die AZURE_LOG_LEVEL Umgebungsvariable auf infofest. Alternativ kann die Protokollierung zur Laufzeit durch Aufrufen von setLogLevel im @azure/loggeraktiviert werden:

import { setLogLevel } from "@azure/logger";

setLogLevel("info");

Ausführlichere Anweisungen zum Aktivieren von Protokollen finden Sie in den @azure/Logger-Paketdokumenten.

Nächste Schritte

Ausführliche Beispiele zur Verwendung dieser Bibliothek finden Sie in den Beispielen Verzeichnis.

Contributing

Wenn Sie an dieser Bibliothek mitwirken möchten, lesen Sie bitte den mitwirkenden Leitfaden, um mehr über das Erstellen und Testen des Codes zu erfahren.

  • Last updated on