Klientská knihovna Azure Device Update pro IoT Hub REST pro JavaScript – verze 1.0.0
Knihovna poskytuje přístup ke službě Device Update pro IoT Hub, která zákazníkům umožňuje publikovat aktualizace pro jejich zařízení IoT do cloudu a pak tyto aktualizace nasadit do svých zařízení (schvalovat aktualizace skupin zařízení spravovaných a zřízených v IoT Hub).
Při používání této knihovny se do značné míry spolehněte na dokumentaci ke službě a naši dokumentaci ke klientům REST .
Klíčové odkazy:
Začínáme
Aktuálně podporovaná prostředí
- Node.js verze 14.x.x nebo novější
Požadavky
- Předplatné Microsoft Azure: Pokud chcete volat služby Microsoft Azure, musíte vytvořit předplatné Azure.
- Aktualizace zařízení pro instanci IoT Hub
- Azure IoT Hub instance
Nainstalujte balíček @azure-rest/iot-device-update
.
Nainstalujte klientskou knihovnu Azure Iot Device Update pro JavaScript pomocí npm
příkazu :
npm install @azure-rest/iot-device-update
Vytvoření a ověření DeviceUpdate
Pokud chcete použít přihlašovací údaje tokenu Azure Active Directory (AAD), zadejte instanci požadovaného typu přihlašovacích údajů získané z knihovny @azure/identity .
Pokud chcete provést ověření pomocí AAD, musíte nejprve npm
nainstalovat @azure/identity
.
Po instalaci můžete zvolit, jaký typ přihlašovacích údajů@azure/identity
chcete použít.
Například DefaultAzureCredential se dá použít k ověření klienta:
Nastavte hodnoty ID klienta, ID tenanta a tajného klíče klienta aplikace AAD jako proměnné prostředí: AZURE_CLIENT_ID, AZURE_TENANT_ID AZURE_CLIENT_SECRET
K ověření klienta použijte vrácené přihlašovací údaje tokenu:
import DeviceUpdate from "@azure-rest/iot-device-update";
import { DefaultAzureCredential } from "@azure/identity";
const client = DeviceUpdate(
"https://<my-instance-id>.api.adu.microsoft.com",
new DefaultAzureCredential()
);
Klíčové koncepty
Klient REST
Tento klient je jedním z našich klientů REST. Důrazně doporučujeme, abyste si zde přečetli, jak používat klienta REST.
Příklady
V následující části se dozvíte, jak inicializovat a ověřit klienta a pak získat všechna zařízení.
import DeviceUpdate from "@azure-rest/iot-device-update";
import { DefaultAzureCredential } from "@azure/identity";
async function main() {
console.log("== List devices ==");
const client = DeviceUpdate(endpoint, new DefaultAzureCredential());
const result = await client
.path("/deviceupdate/{instanceId}/management/devices", instanceId)
.get();
console.log(result);
}
main().catch(console.error);
Řešení potíží
protokolování
Povolení protokolování může pomoct odhalit užitečné informace o selháních. Pokud chcete zobrazit protokol požadavků a odpovědí HTTP, nastavte proměnnou AZURE_LOG_LEVEL
prostředí na info
. Případně je možné protokolování povolit za běhu voláním setLogLevel
v :@azure/logger
import { setLogLevel } from "@azure/logger";
setLogLevel("info");
Podrobnější pokyny k povolení protokolů najdete v dokumentaci k balíčkům @azure/protokolovacího nástroje.
Další kroky
Přispívání
Pokud chcete přispívat do této knihovny, přečtěte si příručku pro přispívání , kde najdete další informace o tom, jak sestavit a otestovat kód.
Související projekty
Azure SDK for JavaScript