Aracılığıyla paylaş


Device Update - List Updates

IoT Hub için Cihaz Güncelleştirmesi'ne aktarılan tüm güncelleştirmelerin listesini alın.

GET https://{endpoint}/deviceUpdate/{instanceId}/updates?api-version=2022-10-01
GET https://{endpoint}/deviceUpdate/{instanceId}/updates?api-version=2022-10-01&search={search}&filter={filter}

URI Parametreleri

Name İçinde Gerekli Tür Description
endpoint
path True

string

url

IoT Hub hesap uç noktası için Cihaz Güncelleştirmesi (yalnızca konak adı, protokol yok).

instanceId
path True

string

IoT Hub hesap örneği tanımlayıcısı için Cihaz Güncelleştirmesi.

api-version
query True

string

İstemci isteğiyle kullanılacak API'nin sürümü.

filter
query

string

IsDeployable özelliğine göre güncelleştirmeleri filtrelemek için isteğe bağlı.

search
query

string

Serbest metin arama ifadesiyle eşleşen güncelleştirmeleri isteme.

Yanıtlar

Name Tür Description
200 OK

UpdateList

İçeri aktarılan tüm güncelleştirmeler veya yoksa boş liste.

Other Status Codes

ErrorResponse

Varsayılan yanıt.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Flow

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name Description
https://api.adu.microsoft.com/.default Varsayılan yetkilendirme kapsamı.

Örnekler

DeviceUpdate_ListUpdates

Örnek isteği

GET https://contoso.api.adu.microsoft.com/deviceUpdate/blue/updates?api-version=2022-10-01

Örnek yanıt

{
  "value": [
    {
      "updateId": {
        "provider": "microsoft",
        "name": "adu",
        "version": "1.0.0.0"
      },
      "description": "Example update.",
      "compatibility": [
        {
          "deviceManufacturer": "Microsoft",
          "deviceModel": "Toaster"
        }
      ],
      "instructions": {
        "steps": [
          {
            "description": "pre-install script",
            "handler": "microsoft/script:1",
            "handlerProperties": {
              "arguments": "--pre-install"
            },
            "files": [
              "configure.sh"
            ]
          },
          {
            "type": "reference",
            "updateId": {
              "provider": "microsoft",
              "name": "sensor",
              "version": "1.0"
            }
          }
        ]
      },
      "manifestVersion": "5.0",
      "importedDateTime": "2020-04-22T21:01:43.8408797+00:00",
      "createdDateTime": "2019-09-12T00:00:00.0000000+00:00",
      "etag": "\"3fed3378-0c67-47d2-b796-296962c66cbb\""
    }
  ]
}

Tanımlar

Name Description
Error

Hata ayrıntıları.

ErrorResponse

Yaygın hata yanıtı.

InnerError

Hatayla ilgili geçerli nesneden daha özel bilgiler içeren bir nesne.

Instructions
Step

Güncelleştirme yükleme yönergesi adımı.

StepType

Adım türü.

Update

Meta verileri güncelleştirin.

UpdateId

Tanımlayıcıyı güncelleştirin.

UpdateList

Güncelleştirme listesi.

Error

Hata ayrıntıları.

Name Tür Description
code

string

Sunucu tanımlı hata kodu.

details

Error[]

Bildirilen hataya yol açan bir hata dizisi.

innererror

InnerError

Hatayla ilgili geçerli nesneden daha özel bilgiler içeren bir nesne.

message

string

Hatanın insan tarafından okunabilen bir gösterimi.

occurredDateTime

string

Hatanın oluştuğu tarih ve utc saati.

target

string

Hatanın hedefi.

ErrorResponse

Yaygın hata yanıtı.

Name Tür Description
error

Error

Hata ayrıntıları.

InnerError

Hatayla ilgili geçerli nesneden daha özel bilgiler içeren bir nesne.

Name Tür Description
code

string

İçeren hata tarafından sağlanandan daha özel bir hata kodu.

errorDetail

string

İç hata veya özel durum iletisi.

innerError

InnerError

Hatayla ilgili geçerli nesneden daha özel bilgiler içeren bir nesne.

message

string

Hatanın insan tarafından okunabilen bir gösterimi.

Instructions

Name Tür Description
steps

Step[]

Yükleme adımları koleksiyonu.

Step

Güncelleştirme yükleme yönergesi adımı.

Name Tür Default value Description
description

string

Adım açıklaması.

files

string[]

Yürütme sırasında işleyiciye geçirilecek dosya adlarının koleksiyonu. Adım türü satır içiyse gereklidir.

handler

string

Bu adımı yürütecek işleyicinin kimliği. Adım türü satır içiyse gereklidir.

handlerProperties

object

Yürütme sırasında işleyiciye geçirilecek parametreler.

type

StepType

inline

Adım türü.

updateId

UpdateId

Başvuruda bulundu alt güncelleştirme kimliği. Adım türü başvuru ise gereklidir.

StepType

Adım türü.

Name Tür Description
inline

string

reference

string

Update

Meta verileri güncelleştirin.

Name Tür Default value Description
compatibility

object[]

Güncelleştirme uyumluluğu bilgilerinin listesi.

createdDateTime

string

Güncelleştirmenin oluşturulduğu tarih ve utc saati.

description

string

Oluşturucu tarafından belirtilen güncelleştirme açıklaması.

etag

string

ETag'i güncelleştirin.

friendlyName

string

İçeri aktarıcı tarafından belirtilen kolay güncelleştirme adı.

importedDateTime

string

Güncelleştirmenin içeri aktarıldığı TARIH ve UTC saati.

installedCriteria

string

Güncelleştirmenin cihazda yüklü olup olmadığını belirlemek için Cihaz Güncelleştirmesi istemcisi tarafından yorumlanan dize. En son içeri aktarma bildirimi şemasında kullanım dışı bırakıldı.

instructions

Instructions

Yükleme yönergelerini güncelleştirin.

isDeployable

boolean

True

Güncelleştirmenin bir cihaza kendi başına dağıtılıp dağıtılamayacağı.

manifestVersion

string

Güncelleştirmeyi içeri aktarmak için kullanılan bildirimin şema sürümü.

referencedBy

UpdateId[]

Bu güncelleştirmeye başvuran güncelleştirme kimliklerinin listesi.

scanResult

string

Toplu tarama sonucunu güncelleştirme (yük dosyası tarama sonuçlarından hesaplanır).

updateId

UpdateId

Kimliği güncelleştirin.

updateType

string

Güncelleştirme türü. En son içeri aktarma bildirimi şemasında kullanım dışı bırakıldı.

UpdateId

Tanımlayıcıyı güncelleştirin.

Name Tür Description
name

string

Adı güncelleştirin.

provider

string

Sağlayıcıyı güncelleştirin.

version

string

Sürümü güncelleştirin.

UpdateList

Güncelleştirme listesi.

Name Tür Description
nextLink

string

Öğelerin sonraki sayfasına bağlantı.

value

Update[]

Sayfalanabilir öğeler koleksiyonu.