IoT Hub REST
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
- Toto rozhraní API slouží ke správě dvojčat zařízení IoT Hub. Na zařízeních můžete načítat a aktualizovat vlastnosti dvojčete zařízení a vyvolat přímé metody .
- Tato rozhraní API slouží ke správě identit zařízení v registru identit služby IoT Hub.
- Tato rozhraní API slouží ke správě úloh v IoT Hub. Můžete naplánovat, zrušit nebo získat úlohu.
Všechny operace úkolů odpovídají specifikaci protokolu HTTP/1.1 a každá operace vrací hlavičku x-ms-request-id
, kterou lze použít k získání informací o požadavku. 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í, kde najdete podrobnosti o vytváření tokenů zabezpečení.
Zasílání zpráv zařízení
Pomocí těchto rozhraní API ze zařízení můžete odesílat zprávy zařízení-cloud do centra IoT a přijímat zprávy z cloudu na zařízení ze služby IoT Hub. Všechny operace úkolů 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 o vytváření tokenů zabezpečení najdete v tématu IoT Hub Příručka pro vývojáře – zabezpečení.
Poskytovatel prostředků
Tato rozhraní API slouží ke správě nasazení prostředků IoT Hub. Informace o tom, jak tyto požadavky zabezpečit, najdete v referenčních informacích k rozhraní Azure REST API.
Běžné parametry a záhlaví
Následující informace jsou společné pro všechny úkoly související s IoT Hub:
Nahraďte {api-version} v identifikátoru URI textem 2018-06-30.
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še centrum IoT.
Nahraďte {IoTHubName} názvem vašeho centra IoT.
Nastavte hlavičku Content-Type na application/json.
Nastavte autorizační hlavičku na token SAS vytvořený tak, jak je uvedeno v části Tokeny zabezpečenív části Používání tokenů zabezpečení IoT Hub.
Hlavička značky Etag se vrátí ve všech požadavcích vymezených na jednu identitu zařízení podle rfc7232.
Všechny operace PUT/PATCH vyžadují zadání následujících hlaviček:
If-Match = [*|<etag from get>]
Operace DELETE můžou obsahovat následující hlavičku:
If-Match = [*|<etag from get>]
Chování značek ETag najdete níže:
PUT | Prostředek neexistuje. | Prostředek existuje. |
---|---|---|
If-Match = "" / chybí | 201 Vytvořeno | 200 OK |
If-Match = "*" | 412 – Předběžná podmínka se nezdařila | 200 OK |
If-Match = "xyz" | 412 – Předběžná podmínka se nezdařila | 200 OK / 412 – Předběžná podmínka se nezdařila |
If-None-Match = "*" | 201 Vytvořeno | 412 – Předběžná podmínka se nezdařila |
DELETE | Prostředek neexistuje. | Prostředek existuje. |
---|---|---|
If-Match = "" / chybí | 204 Žádný obsah | 200 OK |
If-Match = "*" | 204 Žádný obsah | 200 OK |
If-Match = "xyz" | 204 Žádný obsah | 200 OK / 412 – Předběžná podmínka se nezdařila |
Asynchronní volání:
PUT odpovídá pomocí hlavičky 201 Created with Azure-AsyncOperation pro všechny operace, které jsou asynchronní. Všechny synchronní operace (aktualizace) vrátí 200 OK.
Funkce DELETE vrátí hodnotu 202 Accept with Location a Retry-After headers a také Azure-AsyncOperation hlavičku pro existující prostředky.
Hlavička umístění obsahuje adresu URL pro výsledek operace.
Retry-After hlavička obsahuje odpovídající interval opakování v sekundách.
Azure-AsyncOperation hlavička obsahuje adresu URL pro stav výsledku operace Async
Po dokončení vygeneruje adresa URL get na výsledek operace přesně stejný výsledek, jako kdyby se původní operace dokončila synchronně.