Partager via

Azure Device Update pour IoT Hub bibliothèque cliente Rest pour JavaScript - version 1.0.0

  • Article

La bibliothèque fournit l’accès au service Device Update pour IoT Hub qui permet aux clients de publier des mises à jour pour leurs appareils IoT sur le cloud, puis de déployer ces mises à jour sur leurs appareils (approuver les mises à jour sur des groupes d’appareils gérés et provisionnés dans IoT Hub).

Veuillez vous fier fortement à la documentation du service et à notre documentation cliente REST pour utiliser cette bibliothèque

Liens clés :

Prise en main

Environnements actuellement pris en charge

  • Node.js version 14.x.x ou ultérieure

Prérequis

  • Abonnement Microsoft Azure : pour appeler les services Microsoft Azure, vous devez créer un abonnement Azure
  • Device Update pour IoT Hub instance
  • instance Azure IoT Hub

Installez le package @azure-rest/iot-device-update

Installez la bibliothèque cliente Azure Iot Device Update pour JavaScript avec npm:

npm install @azure-rest/iot-device-update

Créez et authentifiez unDeviceUpdate

Pour utiliser des informations d’identification de jeton Azure Active Directory (AAD), fournissez une instance du type d’informations d’identification souhaité obtenue à partir de la bibliothèque @azure/identité .

Pour vous authentifier auprès d’AAD, vous devez d’abord npm installer @azure/identity.

Après l’installation, vous pouvez choisir le type d’informations d’identification@azure/identity à utiliser. Par exemple, DefaultAzureCredential peut être utilisé pour authentifier le client :

Définissez les valeurs de l’ID client, de l’ID de locataire et de la clé secrète client de l’application AAD en tant que variables d’environnement : AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET

Utilisez les informations d’identification de jeton retournées pour authentifier le client :

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

Concepts clés

Client REST

Ce client est l’un de nos clients REST. Nous vous recommandons vivement de lire comment utiliser un client REST ici.

Exemples

La section suivante vous montre comment initialiser et authentifier votre client, puis obtenir tous les appareils.

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

Résolution des problèmes

Journalisation

L’activation de la journalisation peut vous aider à mieux comprendre les échecs. Pour avoir un journal des requêtes et réponses HTTP, définissez la variable d’environnement AZURE_LOG_LEVEL sur info. Vous pouvez également activer la journalisation au moment de l’exécution en appelant setLogLevel dans @azure/logger :

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

setLogLevel("info");

Pour obtenir des instructions plus détaillées sur l’activation des journaux, consultez les documents relatifs au package @azure/logger.

Étapes suivantes

Contribution

Si vous souhaitez contribuer à cette bibliothèque, lisez le guide de contribution pour en savoir plus sur la génération et le test du code.

Impressions