Vytvoření centra IoT pomocí rozhraní REST API poskytovatele prostředků (.NET)

Článek
03/17/2023

K programovému vytváření a správě služeb Azure IoT Hubs můžete použít rozhraní REST API prostředků IoT Hub. V tomto článku se dozvíte, jak pomocí prostředku IoT Hub vytvořit centrum IoT pomocí nástroje Postman. Případně můžete použít cURL. Pokud některý z těchto příkazů REST selže, vyhledejte pomoc s běžnými kódy chyb rozhraní IOT HUB API.

Poznámka

K interakci s Azure doporučujeme použít modul Azure Az PowerShell. Začněte tím, že si projdete téma Instalace Azure PowerShellu. Informace o tom, jak migrovat na modul Az PowerShell, najdete v tématu Migrace Azure PowerShellu z AzureRM na Az.

Požadavky

modul Azure PowerShell nebo Azure Cloud Shell
Postman nebo cURL

Získání přístupového tokenu Azure

V rutině Azure PowerShell nebo Azure Cloud Shell se přihlaste a načtěte token pomocí následujícího příkazu. Pokud používáte Cloud Shell jste už přihlášení, tak tento krok přeskočte.
```
az account get-access-token --resource https://management.azure.com
```
V konzole by se měla zobrazit odpověď podobná tomuto kódu JSON (s výjimkou dlouhého přístupového tokenu):
```
{
    "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"
}
```
V novém požadavku Postman na kartě Ověřování vyberte rozevírací seznam Typ a zvolte Nosný token.
Vložte přístupový token do pole označeného tokenem.

Mějte na paměti, že platnost přístupového tokenu vyprší po 5 až 60 minutách, takže možná budete muset vygenerovat další.

Vytvoření centra IoT

Vyberte rozevírací seznam příkazů REST a zvolte příkaz PUT. Zkopírujte níže uvedené adresy URL a nahraďte hodnoty v souboru {} vlastními hodnotami. Hodnota {resourceName} je název, který chcete použít pro nové centrum IoT. Vložte adresu URL do pole vedle příkazu PUT.
```
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}?api-version=2021-04-12
```
Podívejte se na příkaz PUT v IoT Hub Prostředku.
Na kartě Text vyberte v rozevíracích seznamech raw a JSON .
Zkopírujte následující kód JSON a nahraďte hodnoty v <> souboru vlastními. Vložte JSON do pole v Postmanu na kartě Text . Ujistěte se, že název vašeho centra IoT odpovídá názvu ve vaší adrese PUT URL. Změňte umístění na vaše umístění (umístění přiřazené vaší skupině prostředků).
```
{
    "name": "<my-iot-hub>",
    "location": "<region>",
    "tags": {},
    "properties": {},
    "sku": {
        "name": "S1",
        "tier": "Standard",
        "capacity": 1
    }
}
```
Podívejte se na příkaz PUT v IoT Hub Prostředku.
Výběrem možnosti Odeslat odešlete žádost a vytvoříte nové centrum IoT. Úspěšný požadavek vrátí odpověď 201 Created s výtiskem JSON specifikací služby IoT Hub. Pokud používáte Nástroj Postman, můžete žádost uložit.

Zobrazení centra IoT

Pokud chcete zobrazit všechny specifikace nového centra IoT, použijte požadavek GET. Můžete použít stejnou adresu URL, kterou jste použili s požadavkem PUT, ale musíte vymazat text tohoto požadavku (pokud už není prázdný), protože požadavek GET nemůže obsahovat text. Tady je šablona požadavku GET:

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

Podívejte se na příkaz GET v IoT Hub Prostředku.

Aktualizace centra IoT

Aktualizace je stejně jednoduchá jako použití stejného požadavku PUT, ze které jsme vytvořili centrum IoT, a úpravou textu JSON tak, aby obsahoval parametry podle vašeho výběru. Upravte text požadavku přidáním vlastnosti značek a pak spusťte požadavek 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

V odpovědi se zobrazí nová značka přidaná v konzole. Nezapomeňte, že pokud od posledního vygenerování uplynulo příliš mnoho času, možná budete muset aktualizovat přístupový token.

Podívejte se na příkaz PUT v IoT Hub Prostředku.

Případně můžete značky aktualizovat pomocí příkazu PATCH v prostředku IoT Hub.

Odstranění centra IoT

Pokud jenom testujete, možná budete chtít vyčistit prostředky a odstranit nové centrum IoT odesláním požadavku DELETE. nezapomeňte nahradit hodnoty v souboru {} vlastními hodnotami. Hodnota {resourceName} je název vašeho centra IoT.

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

Podívejte se na příkaz DELETE v IoT Hub Prostředku.