Skapa en IoT-hubb med hjälp av resursproviderns REST API (.NET)

Artikel
05/11/2023

Du kan använda rest-API:et IoT Hub Resource för att skapa och hantera Azure IoT-hubbar programmatiskt. Den här artikeln visar hur du använder IoT Hub-resursen för att skapa en IoT-hubb med Postman. Du kan också använda cURL. Om något av dessa REST-kommandon misslyckas kan du få hjälp med de vanliga felkoderna i IoT Hub API.

Anteckning

Vi rekommenderar att du använder Azure Az PowerShell-modulen för att interagera med Azure. Se Installera Azure PowerShell för att komma igång. Information om hur du migrerar till Az PowerShell-modulen finns i artikeln om att migrera Azure PowerShell från AzureRM till Az.

Förutsättningar

Azure PowerShell modul eller Azure Cloud Shell
Postman eller cURL

Hämta en Azure-åtkomsttoken

I Azure PowerShell-cmdleten eller Azure Cloud Shell loggar du in och hämtar sedan en token med följande kommando. Om du använder Cloud Shell du redan är inloggad hoppar du över det här steget.

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

Du bör se ett svar i konsolen som liknar denna JSON (förutom att åtkomsttoken är lång):

{
    "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"
}

I en ny Postman-begäran går du till fliken Auth och väljer listrutan Typ och väljer Ägartoken.
Klistra in åtkomsttoken i fältet Token.

Tänk på att åtkomsttoken upphör att gälla efter 5–60 minuter, så du kan behöva generera en till.

Skapa en IoT Hub

Välj listrutan REST-kommando och välj KOMMANDOT PUT. Kopiera URL:en nedan och ersätt värdena i {} med dina egna värden. Värdet {resourceName} är det namn du vill ha för din nya IoT-hubb. Klistra in URL:en i fältet bredvid KOMMANDOT PUT.
```
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}?api-version=2021-04-12
```
Se PUT-kommandot i IoT Hub-resursen.
På fliken Brödtext väljer du raw och JSON i listrutorna.
Kopiera följande JSON och ersätt värdena i <> med din egen. Klistra in JSON i rutan i Postman på fliken Brödtext . Kontrollera att ditt IoT-hubbnamn matchar det i DIN PUT-URL. Ändra platsen till din plats (den plats som är tilldelad till resursgruppen).
```
{
    "name": "<my-iot-hub>",
    "location": "<region>",
    "tags": {},
    "properties": {},
    "sku": {
        "name": "S1",
        "tier": "Standard",
        "capacity": 1
    }
}
```
Se PUT-kommandot i IoT Hub-resursen.
Välj Skicka för att skicka din begäran och skapa en ny IoT-hubb. En lyckad begäran returnerar ett 201-skapat svar med en JSON-utskrift av dina IoT Hub-specifikationer. Du kan spara din begäran om du använder Postman.

Visa en IoT-hubb

Om du vill se alla specifikationer för din nya IoT-hubb använder du en GET-begäran. Du kan använda samma URL som du använde med PUT-begäran, men måste radera brödtexten för den begäran (om den inte redan är tom) eftersom en GET-begäran inte kan ha en brödtext. Här är mallen för GET-begäran:

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

Se GET-kommandot i IoT Hub-resursen.

Uppdatera en IoT-hubb

Uppdatering är lika enkelt som att använda samma PUT-begäran från när vi skapade IoT-hubben och redigerar JSON-brödtexten så att den innehåller valfria parametrar. Redigera brödtexten i begäran genom att lägga till en egenskap för taggar och kör sedan PUT-begäran.

{
    "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

Svaret visar den nya taggen som lagts till i konsolen. Kom ihåg att du kan behöva uppdatera din åtkomsttoken om det har gått för mycket tid sedan den senaste gången du genererade en.

Se PUT-kommandot i IoT Hub-resursen.

Du kan också använda PATCH-kommandot i IoT Hub-resursen för att uppdatera taggar.

Ta bort en IoT-hubb

Om du bara testar kanske du vill rensa dina resurser och ta bort din nya IoT-hubb genom att skicka en DELETE-begäran. se till att ersätta värdena i {} med dina egna värden. Värdet {resourceName} är namnet på din IoT-hubb.

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

Se kommandot DELETE i IoT Hub Resurs.

Nästa steg

Eftersom du har distribuerat en IoT-hubb med hjälp av resursproviderns REST API kanske du vill utforska vidare:

Läs mer om funktionerna i rest-API:et för IoT Hub-resursprovider.
Läs Översikt över Azure Resource Manager om du vill veta mer om funktionerna i Azure Resource Manager.

Mer information om hur du utvecklar för IoT Hub finns i följande artiklar:

SDK:er för Azure IoT

Mer information om funktionerna i IoT Hub finns i:

Distribuera AI till gränsenheter med Azure IoT Edge

Share via