Azure CommunicationServiceManagement client library for JavaScript - wersja 5.0.0

Ten pakiet zawiera izomorficzne SDK (działające zarówno w Node.js, jak i w przeglądarkach) dla klienta CommunicationServiceManagement Azure.

API REST dla usług pocztowych/domen/listów suppressionLists

Kluczowe linki:

Rozpoczęcie pracy

Obecnie obsługiwane środowiska

  • Wersje LTS systemu Node.js
  • Najnowsze wersje przeglądarek Safari, Chrome, Edge i Firefox.

Aby uzyskać więcej informacji, zobacz nasze zasad pomocy technicznej.

Wymagania wstępne

Instalowanie pakietu @azure/arm-communication

Zainstaluj bibliotekę klienta Azure CommunicationServiceManagement dla JavaScript z npm:

npm install @azure/arm-communication

Twórz i uwierzytelnij CommunicationServiceManagementClient

Aby utworzyć obiekt klienta do dostępu do API CommunicationServiceManagement Azure, będziesz potrzebować endpoint swojego zasobu CommunicationServiceManagement Azure oraz credential. Klient Azure CommunicationServiceManagement może używać poświadczeń Azure Active Directory do uwierzytelniania. Punkt końcowy dla swojego Azure zasobu CommunicationServiceManagement znajdziesz w Azure Portal.

Możesz uwierzytelnić się Azure Active Directory używając poświadczenia z biblioteki @azure/identity lub istniejącego tokena AAD.

Aby użyć dostawcy DefaultAzureCredential pokazanego poniżej lub innych dostawców poświadczeń dostarczonych z zestawem Azure SDK, zainstaluj pakiet @azure/identity:

npm install @azure/identity

Będziesz także musiał zarejestrować nową aplikację AAD i przyznać dostęp do Azure CommunicationServiceManagement przypisując odpowiednią rolę swojemu przedstawicielowi usługi (uwaga: role takie jak "Owner" nie przyznają wymaganych uprawnień).

Aby dowiedzieć się więcej o tym, jak stworzyć aplikację Azure AD, sprawdź ten przewodnik.

Korzystając ze środowisk Node.js i środowisk podobnych do węzłów, możesz użyć klasy DefaultAzureCredential do uwierzytelniania klienta.

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

W przypadku środowisk przeglądarki użyj InteractiveBrowserCredential z pakietu @azure/identity do uwierzytelniania.

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

Pakiet JavaScript

Aby użyć tej biblioteki klienta w przeglądarce, najpierw należy użyć pakietu. Aby uzyskać szczegółowe informacje o tym, jak to zrobić, zapoznaj się z naszą dokumentacją dotyczącą tworzenia pakietów .

Kluczowe pojęcia

Zarządzanie Usługami Komunikacyjnymi

CommunicationServiceManagementClient jest głównym interfejsem dla programistów korzystających z biblioteki klienta CommunicationServiceManagement Azure. Poznaj metody tego obiektu klienta, aby zrozumieć różne funkcje usługi Azure CommunicationServiceManagement, do których masz dostęp.

Troubleshooting

Logging

Włączenie rejestrowania może pomóc odkryć przydatne informacje o błędach. Aby wyświetlić dziennik żądań i odpowiedzi HTTP, ustaw zmienną środowiskową AZURE_LOG_LEVEL na info. Alternatywnie rejestrowanie można włączyć w czasie wykonywania, wywołując setLogLevel w @azure/logger:

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

setLogLevel("info");

Aby uzyskać bardziej szczegółowe instrukcje dotyczące włączania dzienników, zapoznaj się z dokumentacją pakietu @azure/logger.

Następne kroki

Zapoznaj się z przykładami katalogu, aby zapoznać się ze szczegółowymi przykładami dotyczącymi korzystania z tej biblioteki.

Contributing

Jeśli chcesz współtworzyć tę bibliotekę, przeczytaj przewodnik dotyczący współtworzenia , aby dowiedzieć się więcej na temat tworzenia i testowania kodu.