Azure iotDps client library for JavaScript - version 6.0.0

Ten pakiet zawiera izomorficzny zestaw SDK (działa zarówno w Node.js, jak i w przeglądarkach) dla klienta usługi Azure iotDps.

Interfejs API do korzystania z funkcji usługi Azure IoT Hub Device Provisioning Service.

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

Zainstaluj bibliotekę klienta usługi Azure iotDps dla języka JavaScript za pomocą npmpolecenia :

npm install @azure/arm-deviceprovisioningservices

Twórz i uwierzytelnij IotDpsClient

Aby utworzyć obiekt klienta w celu uzyskania dostępu do interfejsu API usługi Azure iotDps, potrzebny endpoint jest zasób usługi Azure iotDps i plik credential. Klient usługi Azure iotDps może używać poświadczeń usługi Azure Active Directory do uwierzytelniania. Punkt końcowy zasobu Azure iotDps można znaleźć w Azure Portal.

Możesz uwierzytelnić się w usłudze Azure Active Directory przy użyciu poświadczeń z biblioteki @azure/tożsamości lub istniejącego tokenu usługi 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

Należy również zarejestrować nową aplikację usługi AAD i udzielić dostępu do usługi Azure iotDps , przypisując odpowiednią rolę do jednostki usługi (uwaga: role, takie jak "Owner" nie udzielą niezbędnych uprawnień).

Aby uzyskać więcej informacji na temat tworzenia aplikacji usługi Azure AD, zobacz tym przewodniku.

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

import { IotDpsClient } from "@azure/arm-deviceprovisioningservices";
import { DefaultAzureCredential } from "@azure/identity";

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

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

import { InteractiveBrowserCredential } from "@azure/identity";
import { IotDpsClient } from "@azure/arm-deviceprovisioningservices";

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

IotDpsClient

IotDpsClient jest podstawowym interfejsem dla deweloperów korzystających z biblioteki klienta usługi Azure iotDps. Zapoznaj się z metodami w tym obiekcie klienta, aby zrozumieć różne funkcje usługi Azure iotDps, do której można uzyskać dostęp.

Troubleshooting

Wyrąb

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.