Compartir a través de

Azure Device Update para IoT Hub biblioteca cliente rest para JavaScript: versión 1.0.0

  • Artículo

La biblioteca proporciona acceso a Device Update para IoT Hub servicio que permite a los clientes publicar actualizaciones para sus dispositivos IoT en la nube y, a continuación, implementar estas actualizaciones en sus dispositivos (aprobar actualizaciones en grupos de dispositivos administrados y aprovisionados en IoT Hub).

Confíe en gran medida en la documentación del servicio y en nuestros documentos de cliente REST para usar esta biblioteca.

Vínculos principales:

Introducción

Entornos admitidos actualmente

  • Node.js versión 14.x.x o superior

Requisitos previos

  • Suscripción a Microsoft Azure: para llamar a los servicios de Microsoft Azure, debe crear una suscripción de Azure.
  • Device Update para IoT Hub instancia
  • instancia de Azure IoT Hub

Instalar el paquete @azure-rest/iot-device-update

Instale la biblioteca cliente de Azure Iot Device Update para JavaScript con npm:

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

Crear y autenticar una DeviceUpdate

Para usar una credencial de token de Azure Active Directory (AAD), proporcione una instancia del tipo de credencial deseado obtenido de la biblioteca de @azure/identity .

Para autenticarse con AAD, primero npm debe instalar @azure/identity.

Después de la instalación, puede elegir el tipo de credencial de @azure/identity que se va a usar. Por ejemplo, Se puede usar DefaultAzureCredential para autenticar al cliente:

Establezca los valores del identificador de cliente, el identificador de inquilino y el secreto de cliente de la aplicación de AAD como variables de entorno: AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET

Use la credencial de token devuelta para autenticar al cliente:

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

Conceptos clave

Cliente REST

Este cliente es uno de nuestros clientes REST. Le recomendamos encarecidamente que lea cómo usar un cliente REST aquí.

Ejemplos

En la sección siguiente se muestra cómo inicializar y autenticar el cliente y, a continuación, obtener todos los dispositivos.

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

Solución de problemas

Registro

La habilitación del registro puede ayudar a descubrir información útil sobre los errores. Para ver un registro de solicitudes y respuestas HTTP, establezca la variable de entorno AZURE_LOG_LEVEL en info. Como alternativa, el registro se puede habilitar en tiempo de ejecución llamando a setLogLevel en @azure/logger:

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

setLogLevel("info");

Para obtener instrucciones más detalladas sobre cómo habilitar los registros, consulte los documentos del paquete @azure/logger.

Pasos siguientes

Contribuciones

Si desea contribuir a esta biblioteca, lea la guía de contribución para obtener más información sobre cómo compilar y probar el código.

Impresiones