Share via

Criar um hub IoT com a API REST (.NET) do fornecedor de recursos

  • Artigo

Pode utilizar a API REST de Recursos Hub IoT para criar e gerir hubs IoT do Azure programaticamente. Este artigo mostra-lhe como utilizar o Recurso Hub IoT para criar um hub IoT com o Postman. Em alternativa, pode utilizar cURL. Se algum destes comandos REST falhar, encontre ajuda com os códigos de erro comuns da API Hub IoT.

Nota

Recomendamos que utilize o módulo Azure Az PowerShell para interagir com o Azure. Veja Instalar o Azure PowerShell para começar. Para saber como migrar para o módulo do Az PowerShell, veja Migrar o Azure PowerShell do AzureRM para o Az.

Pré-requisitos

Obter um token de acesso do Azure

  1. No cmdlet Azure PowerShell ou Cloud Shell do Azure, inicie sessão e, em seguida, obtenha um token com o seguinte comando. Se estiver a utilizar Cloud Shell já tem sessão iniciada, por isso, ignore este passo.

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

    Deverá ver uma resposta na consola semelhante a este JSON (exceto se o token de acesso for longo):

    {
    "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. Num novo pedido do Postman , no separador Autenticação , selecione a lista pendente Tipo e selecione Token de Portador.

    Captura de ecrã que mostra como selecionar o tipo de autorização Token de Portador em **Postman**.

  3. Cole o token de acesso no campo denominado Token.

Tenha em atenção que o token de acesso expira após 5 a 60 minutos, pelo que poderá ter de gerar outro.

Criar um hub IoT

  1. Selecione a lista pendente do comando REST e selecione o comando PUT. Copie o URL abaixo, substituindo os valores no pelos {} seus próprios valores. O {resourceName} valor é o nome que pretende para o seu novo hub IoT. Cole o URL no campo junto ao comando PUT.

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

    Captura de ecrã que mostra como adicionar um comando PUT no Postman.

    Veja o comando PUT no Recurso Hub IoT.

  2. No separador Corpo , selecione raw e JSON nas listas pendentes.

    Captura de ecrã que mostra como adicionar JSON ao corpo do seu pedido no Postman.

  3. Copie o seguinte JSON, substituindo os valores em <> pelo seu próprio. Cole o JSON na caixa no Postman , no separador Corpo . Certifique-se de que o nome do hub IoT corresponde ao do URL PUT. Altere a localização para a sua localização (a localização atribuída ao grupo de recursos).

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

    Veja o comando PUT no Recurso Hub IoT.

  4. Selecione Enviar para enviar o seu pedido e criar um novo hub IoT. Um pedido com êxito devolverá uma resposta 201 Criada com uma impressão JSON das especificações do seu hub IoT. Pode guardar o seu pedido se estiver a utilizar o Postman.

Ver um hub IoT

Para ver todas as especificações do seu novo hub IoT, utilize um pedido GET. Pode utilizar o mesmo URL que utilizou com o pedido PUT, mas tem de apagar o Corpo desse pedido (se ainda não estiver em branco) porque um pedido GET não pode ter um corpo. Eis o modelo de pedido GET:

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

Veja o comando GET no Recurso Hub IoT.

Atualizar um hub IoT

A atualização é tão simples como utilizar o mesmo pedido PUT de quando criámos o hub IoT e editar o corpo JSON para conter parâmetros à sua escolha. Edite o corpo do pedido ao adicionar uma propriedade de etiquetas e, em seguida, execute o pedido 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

A resposta mostrará a nova etiqueta adicionada na consola do . Lembre-se de que poderá ter de atualizar o token de acesso se tiver passado demasiado tempo desde a última vez que gerou um.

Veja o comando PUT no Recurso Hub IoT.

Em alternativa, utilize o comando PATCH no Recurso Hub IoT para atualizar etiquetas.

Eliminar um hub IoT

Se estiver apenas a testar, poderá querer limpar os seus recursos e eliminar o seu novo hub IoT ao enviar um pedido DELETE. certifique-se de que substitui os valores em {} pelos seus próprios valores. O {resourceName} valor é o nome do seu hub IoT.

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

Veja o comando DELETE no Recurso Hub IoT.

Passos seguintes

Uma vez que implementou um hub IoT com a API REST do fornecedor de recursos, poderá querer explorar mais:

Para saber mais sobre como desenvolver para Hub IoT, consulte os seguintes artigos:

Para explorar ainda mais as capacidades do Hub IoT, veja: