IoT Hub REST

  • Makale
  • Okumak için 2 dakika

IoT Hub REST API'leri cihaz, mesajlaşma ve iş hizmetlerinin yanı sıra kaynak sağlayıcısına programlı erişim IoT Hub. Mesajlaşma hizmetlerine Azure’da çalışan bir IoT hizmeti içinden ya da HTTPS isteği gönderip HTTPS yanıtı alabilen herhangi bir uygulama aracılığıyla doğrudan İnternet üzerinden erişebilirsiniz.

Hizmet

  • Cihaz ikizlerini yönetmek için IoT Hub kullanın. Cihaz ikizi özelliklerini alabilir, güncelleştirebilirsiniz ve cihazlarda doğrudan yöntemleri çağırabilirsiniz.
  • IoT hub'larının kimlik kayıt defterindeki cihaz kimliklerini yönetmek için bu API'leri kullanın.
  • Bu API'yi kullanarak IoT Hub. Bir iş zamanlaması, iptal etme veya iş edinme.

Tüm görev işlemleri HTTP/1.1 protokol belirtimi ile uyumlu olur ve her işlem istek hakkında bilgi almak için kullanılan x-ms-request-id bir üst bilgi döndürür. Bu kaynaklara gönderilen isteklerin güvenli olduğundan emin olmanız gerekir. Daha fazla bilgi için IoT Hub belirteçleri oluşturma hakkında daha fazla bilgi için bkz. Geliştirici Kılavuzu – Güvenlik.

Cihaz Mesajlaşması

Cihazdan buluta iletileri bir IoT hub'a göndermek ve IoT hub'larından buluttan cihaza iletileri almak için bu API'leri kullanın. Tüm görev işlemleri HTTP/1.1 protokol belirtimine uygun. Bu kaynaklara gönderilen isteklerin güvenli olduğundan emin olmanız gerekir. Daha fazla bilgi için, IoT Hub belirteçleri oluşturma hakkında belirli bilgiler için bkz. Geliştirici Kılavuzu - Güvenlik.

Kaynak Sağlayıcısı

Kaynaklarınızı yönetmek için bu API'leri IoT Hub kullanın. Bu isteklerin güvenliğini sağlama hakkında daha fazla bilgi için bkz. Azure REST API Başvurusu.

Ortak parametreler ve üst bilgiler

Aşağıdaki bilgiler, aşağıdakilerle ilgili tüm görevler için IoT Hub:

  • {api-version} öğesini URI'de "2018-06-30" ile değiştirin.

  • {subscription-id} öğesini URI'deki abonelik tanımlayıcınız ile değiştirin.

  • {resourceGroupName} öğesini IoT hub'ını içeren (veya içerecek) kaynak grubu adıyla değiştirin.

  • {IoTHubName} yerine IoT hub'nizin adını yazın.

  • Content-Type üst bilginizi application/json olarak ayarlayın.

  • Yetkilendirme üst bilgisi'ni, Güvenlik belirteçlerini kullanma bölümündeki güvenlik belirteçleri bölümünde belirtilen IoT Hub sas belirteci olarak ayarlayın.

  • Etag üst bilgisi, RFC7232'yegöre tek bir cihaz kimliği kapsamındaki tüm isteklerde döndürülür.

  • Tüm PUT/PATCH işlemleri aşağıdaki üst bilgilerin belirtilmelidir: If-Match = [*|<etag from get>]

  • DELETE işlemleri aşağıdaki üst bilgileri içerebilir: If-Match = [*|<etag from get>]

ETag'ların davranışı aşağıda görülebilir:
PUT Kaynak yok Kaynak var
If-Match = "" / yok 201 Oluşturuldu 200 Tamam
If-Match = "*" 412 Önkoşul Başarısız Oldu 200 Tamam
If-Match = "xyz" 412 Önkoşul Başarısız Oldu 200 Tamam / 412 Önkoşul Başarısız Oldu
If-None-Match = "*" 201 Oluşturuldu 412 Önkoşul Başarısız Oldu
DELETE Kaynak yok Kaynak var
If-Match = "" / yok 204 İçerik Yok 200 Tamam
If-Match = "*" 204 İçerik Yok 200 Tamam
If-Match = "xyz" 204 İçerik Yok 200 Tamam / 412 Önkoşul Başarısız Oldu

Zaman uyumsuz çağrılar için:

  • PUT, zaman uyumsuz işlemler için 201 Azure-AsyncOperation üst bilgisi ile oluşturuldu yanıtını verir. Tüm zaman uyumlu (güncelleştirmeler) işlemleri 200 Tamam'ı geri döner.

  • DELETE, Konum ve Retry-After üst bilgileriyle birlikte 202 Kabul Edildi ve mevcut kaynaklar için Azure-AsyncOperation üst bilgisi döndürür.

  • Konum üst bilgisi işlem sonucu url'sini içeriyor

  • Retry-After üst bilgisi saniyeler içinde uygun yeniden deneme aralığını içeriyor

  • Azure-AsyncOperation üst bilgisi Zaman uyumsuz işlem sonucu durumunun URL'sini içeriyor

  • tamamlandığında, işlem sonucu URL'sinin GET'i, özgün işlem zaman uyumlu olarak tamamlamış gibi tam olarak aynı sonucu üretir