Creación de un centro de IoT mediante la API de REST del proveedor de recursos (.NET)

  • Artículo

Puede usar la API de REST de recursos de IoT Hub para crear y administrar los centros de Azure IoT mediante programación. En este artículo se muestra cómo usar el recurso de IoT Hub para crear un centro de IoT mediante Postman. Como alternativa, puede usar cURL. Si se produce un error en alguno de estos comandos REST, busque ayuda con los códigos de error comunes de la API de IoT Hub.

Nota:

Se recomienda usar el módulo Azure Az de PowerShell para interactuar con Azure. Consulte Instalación de Azure PowerShell para empezar. Para más información sobre cómo migrar al módulo Az de PowerShell, consulte Migración de Azure PowerShell de AzureRM a Az.

Requisitos previos

Obtención de un token de acceso de Azure

  1. Inicie sesión en el cmdlet Azure PowerShell o Azure Cloud Shell y, a continuación, recupere un token con el siguiente comando. Si está usando Cloud Shell ya tiene sesión iniciada, así que omita este paso.

    az account get-access-token --resource https://management.azure.com

    Debería ver una respuesta en la consola similar a este JSON (excepto que el token de acceso es largo):

    {
    "accessToken": "eyJ ... pZA",
    "expiresOn": "2022-09-16 20:57:52.000000",
    "subscription": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "tenant": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "tokenType": "Bearer"
}

  2. En una nueva solicitud de Postman, en la pestaña Autenticación, seleccione la lista desplegable Tipo y elija Token de Portador.

    Captura de pantalla que muestra cómo seleccionar el tipo de Token de Portador de autorización en **Postman**.

  3. Pegue el token de acceso en el campo con la etiqueta Token.

Tenga en cuenta que el token de acceso expira después de que pasen entre 5 y 60 minutos, por lo que es posible que tenga que generar otro.

Creación de un centro de IoT

  1. Seleccione la lista desplegable de comandos REST y elija el comando PUT. Copie la dirección URL siguiente y reemplace los valores en {} por sus propios valores. El {resourceName} valor es el nombre que le gustaría para su nuevo centro de IoT. Pegue la dirección URL en el campo situado junto al comando PUT.

    PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}?api-version=2021-04-12

    Captura de pantalla que muestra cómo agregar un comando PUT en Postman.

    Consulte el comando PUT en el recurso de IoT Hub.

  2. En la pestaña Cuerpo, seleccione RAW y JSON en las listas desplegables.

    Captura de pantalla que muestra cómo agregar JSON al cuerpo de su solicitud en Postman.

  3. Copie el siguiente código JSON, reemplazando los valores de <> por los suyos propios. Pegue el código JSON en el cuadro de Postman en la pestaña Cuerpo. Asegúrese de que el nombre de su centro de IoT coincida con el de la dirección URL PUT. Cambie la ubicación a su ubicación (la ubicación asignada a su grupo de recursos).

    {
    "name": "<my-iot-hub>",
    "location": "<region>",
    "tags": {},
    "properties": {},
    "sku": {
        "name": "S1",
        "tier": "Standard",
        "capacity": 1
    }
}

    Consulte el comando PUT en el recurso de IoT Hub.

  4. Seleccione Enviar para enviar la solicitud y crear un nuevo centro de IoT. Una solicitud correcta devolverá una respuesta 201 Created con una impresión JSON de sus especificaciones de IoT Hub. Puede guardar su solicitud si usa Postman.

Ver un centro de IoT

Para ver todas las especificaciones de su nuevo centro de IoT, use una solicitud GET. Puede usar la misma dirección URL que usó con la solicitud PUT, pero debe borrar el Cuerpo de esa solicitud (si aún no está en blanco) porque una solicitud GET no puede tener un cuerpo. Esta es la plantilla de solicitud GET:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}?api-version=2018-04-01

Consulte el comandoGET en el recurso de IoT Hub.

Actualizar un centro de IoT

La actualización es tan sencilla como usar la misma solicitud PUT de cuando creamos el centro de IoT y editar el cuerpo JSON para que contenga parámetros de su elección. Edite el cuerpo de la solicitud agregando una propiedad etiquetas y, a continuación, ejecute la solicitud PUT.

{
    "name": "<my-iot-hub>",
    "location": "westus2",
    "tags": {
        "Animal": "Cat"
    },
    "properties": {},
    "sku": {
        "name": "S1",
        "tier": "Standard",
        "capacity": 1
    }
}

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}?api-version=2018-04-01

La respuesta mostrará la nueva etiqueta agregada en la consola. Recuerde que es posible que tenga que actualizar el token de acceso si ha transcurrido demasiado tiempo desde la última vez que generó uno.

Consulte el comando PUT en el recurso de IoT Hub.

Como alternativa, use el comandoPATCH en el recurso de IoT Hub para actualizar las etiquetas.

Eliminar un centro de IoT

Si solo está probando, es posible que quiera limpiar los recursos y eliminar su nuevo centro de IoT mediante el envío de una solicitud DELETE. Asegúrese de reemplazar las variables en {} por sus propios valores. El {resourceName} valor es el nombre de su centro de IoT.

DELETE https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}?api-version=2018-04-01

Consulte el comandoDELETE en el recurso de IoT Hub.

Pasos siguientes

Desde que ha implementó un centro de IoT con la API de REST del proveedor de recursos, es posible que quiera profundizar más en este tema:

Para obtener más información sobre cómo desarrollar para IoT Hub, consulte los siguientes artículos:

Para explorar aún más las funcionalidades de IoT Hub, consulte: