IoT Hub REST

  • Článek
  • 2 min ke čtení

Rozhraní REST API pro IoT Hub nabízejí programový přístup ke službám zařízení, zasílání zpráv a úloh a také k poskytovateli prostředků v IoT Hub. Ke službám zasílání zpráv můžete přistupovat ze služby IoT spuštěné v Azure nebo přímo přes internet z jakékoli aplikace umožňující odeslání požadavku HTTP a příjem odpovědi HTTP.

Služba

  • Pomocí tohoto rozhraní API můžete spravovat IoT Hubch vláken zařízení. Můžete načíst a aktualizovat vlastnosti, které jsou v zařízení, a vyvolat na zařízení přímé metody .
  • Pomocí těchto rozhraní API můžete spravovat identity zařízení v registru identit služby IoT Hub.
  • Pomocí těchto rozhraní API můžete spravovat úlohy v IoT Hub. Můžete naplánovat, zrušit nebo získat úlohu.

Všechny operace úloh odpovídají specifikaci protokolu HTTP/1.1 a každá operace vrátí x-ms-request-id hlavičku, kterou lze použít k získání informací o žádosti. Je potřeba zajistit, aby všechny požadavky na tyto prostředky byly zabezpečené. Další informace najdete v tématu IoT Hub příručka pro vývojáře – zabezpečení pro konkrétní informace o tom, jak vytvářet tokeny zabezpečení.

Zasílání zpráv zařízení

Pomocí těchto rozhraní API ze zařízení můžete posílat zprávy typu zařízení-Cloud do služby IoT Hub a přijímat zprávy z cloudu na zařízení ze služby IoT Hub. Všechny operace úloh odpovídají specifikaci protokolu HTTP/1.1. Je potřeba zajistit, aby všechny požadavky na tyto prostředky byly zabezpečené. Další informace najdete v tématu IoT Hub příručka pro vývojáře – zabezpečení pro konkrétní informace o tom, jak vytvářet tokeny zabezpečení.

Poskytovatel prostředků

Pomocí těchto rozhraní API můžete spravovat nasazení IoT Hubch prostředků. Informace o tom, jak tyto požadavky zabezpečit, najdete v tématu Azure REST API Reference.

Běžné parametry a záhlaví

Následující informace jsou společné pro všechny úlohy související s IoT Hub:

  • Nahraďte {API-Version} znakem "2018-06-30" v identifikátoru URI.

  • Nahraďte {Subscription-ID} identifikátorem vašeho předplatného v identifikátoru URI.

  • Nahraďte {resourceGroupName} názvem skupiny prostředků, která obsahuje (nebo bude obsahovat) vašeho centra IoT.

  • Nahraďte {IoTHubName} názvem vašeho centra IoT.

  • Nastavte hlavičku Content-Type na Application/JSON.

  • Nastavte hlavičkou autorizace na token SAS vytvořený tak, jak je uvedeno v části tokeny zabezpečení v tématu použití tokenů zabezpečení IoT Hub.

  • Hlavička ETag se vrátí ve všech požadavcích oboru pro jednu identitu zařízení, jako na RFC7232.

  • Všechny operace PUT a PATCH vyžadují, aby byly zadány následující hlavičky: If-Match = [*|<etag from get>]

  • Operace odstranění můžou zahrnovat následující hlavičku: If-Match = [*|<etag from get>]

Chování značek ETag lze zobrazit níže:
PUT Prostředek neexistuje. Prostředek existuje
If-Match = ""/chybět 201 vytvořeno 200 OK
If-Match = "*" Předběžná podmínka 412 se nezdařila 200 OK
If-Match = "xyz" Předběžná podmínka 412 se nezdařila Předběžná podmínka 200 OK/412 se nezdařila
If-None-Match = "*" 201 vytvořeno Předběžná podmínka 412 se nezdařila
DELETE Prostředek neexistuje. Prostředek existuje
If-Match = ""/chybět 204 bez obsahu 200 OK
If-Match = "*" 204 bez obsahu 200 OK
If-Match = "xyz" 204 bez obsahu Předběžná podmínka 200 OK/412 se nezdařila

Pro asynchronní volání:

  • Dejte odpověď s 201 vytvořenou s Azure-AsyncOperation hlavičkou pro všechny operace, které jsou asynchronní. Všechny synchronní (aktualizace) operace vrátí 200 OK.

  • Funkce DELETE vrátí hodnotu 202 přijatou s hlavičkou location a Retry-After a také Azure-AsyncOperation hlavičku pro prostředky, které existují.

  • Hlavička umístění obsahuje adresu URL pro výsledek operace.

  • Hlavička Retry-After obsahuje odpovídající interval opakování v sekundách.

  • Hlavička Azure-AsyncOperation obsahuje adresu URL pro stav výsledku asynchronní operace.

  • Po dokončení vygeneruje adresa URL výsledku operace GET na výsledek operace přesně stejný výsledek, jako kdyby byla původní operace dokončena synchronně.