Device Update - Import Update

Yeni güncelleştirme sürümünü içeri aktar. Bu uzun süre çalışan bir işlemdir; işlem durumunu denetlemek için Operation-Location yanıt üst bilgisi değerini kullanın.

POST https://{endpoint}/deviceUpdate/{instanceId}/updates:import?api-version=2026-06-01

URI Parametreleri

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

string (url)

IoT Hub hesabı 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

minLength: 1

Bu işlem için kullanılacak API sürümü.

İstek Gövdesi

Name Tür Description
updateToImport

ImportUpdateInputItem[]

İçeri aktarılacak güncelleştirme (ayrıntılar için şema https://json.schemastore.org/azure-deviceupdate-import-manifest-5.0.json bakın).

Yanıtlar

Name Tür Description
200 OK

Update

İstek başarılı oldu.

202 Accepted

İstek işleme için kabul edildi, ancak işleme henüz tamamlanmadı.

Üst Bilgiler

Operation-Location: string

Other Status Codes

ErrorResponse

Beklenmeyen bir hata yanıtı.

Güvenlik

OAuth2Auth

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

Kapsamlar

Name Description
https://api.adu.microsoft.com/.default

Örnekler

DeviceUpdate_ImportUpdate

Örnek isteği

POST https://contoso.api.adu.microsoft.com/deviceUpdate/blue/updates:import?api-version=2026-06-01

[
  {
    "importManifest": {
      "url": "http://test.blob.core.windows.net/test/uploadimportMan.json",
      "sizeInBytes": 816,
      "hashes": {
        "sha256": "O19LyyncPe1AGstOdkcmozLV8pSbBdqrE18HdYVohRc="
      }
    },
    "files": [
      {
        "filename": "file1.bin",
        "url": "http://test.blob.core.windows.net/test/upload1v5uww1q"
      },
      {
        "filename": "file2.bin",
        "url": "http://test.blob.core.windows.net/test/uploadkrmn5yw0"
      },
      {
        "filename": "file3.bin",
        "url": "http://test.blob.core.windows.net/test/uploaddq52ky5m"
      }
    ]
  }
]

Örnek yanıt

Operation-Location: /deviceUpdate/blue/updates/operations/e4491c54-916f-443d-9094-bcca546ace2f?api-version=2026-06-01
{
  "updateId": {
    "provider": "microsoft",
    "name": "adu",
    "version": "1.0.0.0"
  },
  "friendlyName": "Lab Sensor Update v1",
  "description": "Fix for critical vulnerability",
  "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-22T14:01:43.8408797-07:00",
  "createdDateTime": "2019-09-11T17:00:00-07:00",
  "etag": "\"3fed3378-0c67-47d2-b796-296962c66cbb\""
}

Tanımlar

Name Description
Error

Hata ayrıntıları.

ErrorResponse

Yaygın hata yanıtı.

FileImportMetadata

Güncelleştirme dosyasını açıklayan meta veriler.

ImportManifestMetadata

İçeri aktarma bildirimini açıklayan meta veriler, güncelleştirme sürümüyle ilgili dosyaları ve diğer meta verileri açıklayan bir belge.

ImportUpdateInputItem

Güncelleştirme giriş öğesi meta verilerini içeri aktar.

InnerError

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

Instructions

Kurulum talimatlarını konteyner olarak güncelledin.

Step

Yükleme yönergesi adımlarını güncelleştirin.

StepType

Adım türü.

Update

Meta verileri güncelleştirin.

UpdateId

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

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 belirli bilgiler içeren bir nesne.

message

string

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

occurredDateTime

string (date-time)

Hatanın oluştuğu TARIH ve SAAT UTC.

target

string

Hatanın hedefi.

ErrorResponse

Yaygın hata yanıtı.

Name Tür Description
error

Error

Hata ayrıntıları.

FileImportMetadata

Güncelleştirme dosyasını açıklayan meta veriler.

Name Tür Description
filename

string

İçeri aktarma bildiriminde belirtilen dosya adını güncelleştirin.

url

string

IoT Hub için Cihaz Güncelleştirmesi tarafından güncelleştirme dosyasının indirilebildiği Azure Blob konumu. Bu genellikle son kullanma süresi en az 4 saat olarak ayarlanmış salt okunur sas korumalı blob URL'dir.

ImportManifestMetadata

İçeri aktarma bildirimini açıklayan meta veriler, güncelleştirme sürümüyle ilgili dosyaları ve diğer meta verileri açıklayan bir belge.

Name Tür Description
hashes

object

Dosyanın karmalarını içeren bir JSON nesnesi. En azından SHA256 karması gereklidir. Bu nesne, anahtarın karma algoritma olduğu ve değerin bu algoritma kullanılarak hesaplanan dosyanın karması olduğu bir anahtar-değer çiftleri kümesi olarak düşünülebilir.

sizeInBytes

integer (int64)

Bayt sayısı cinsinden dosya boyutu.

url

string

IoT Hub için Cihaz Güncelleştirmesi tarafından içeri aktarma bildiriminin indirilebildiği Azure Blob konumu. Bu genellikle son kullanma süresi en az 4 saat olarak ayarlanmış salt okunur sas korumalı blob URL'dir.

ImportUpdateInputItem

Güncelleştirme giriş öğesi meta verilerini içeri aktar.

Name Tür Description
files

FileImportMetadata[]

Dosya adı ve kaynak URL gibi bir veya daha fazla güncelleştirme dosyası özelliği.

friendlyName

string

minLength: 1
maxLength: 512

Kolay güncelleştirme adı.

importManifest

ImportManifestMetadata

Kaynak URL, dosya boyutu/karmalar gibi bildirim meta verilerini içeri aktarma.

InnerError

Hatayla ilgili geçerli nesneden daha belirli 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 belirli bilgiler içeren bir nesne.

message

string

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

Instructions

Kurulum talimatlarını konteyner olarak güncelledin.

Name Tür Description
steps

Step[]

Yükleme adımlarının koleksiyonu.

Step

Yükleme yönergesi adımlarını güncelleştirin.

Name Tür Default value Description
description

string

minLength: 1
maxLength: 64

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

minLength: 1
maxLength: 32

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

handlerProperties

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

type

StepType

inline

Adım türü.

updateId

UpdateId

Başvuruda olunan alt güncelleştirme kimliği. Adım türü başvuruysa gereklidir.

StepType

Adım türü.

Değer Description
inline

Kod çalıştırma işlemi gerçekleştiren adım tipi.

reference

Bir güncelleme daha yükleyen adım türü.

Update

Meta verileri güncelleştirin.

Name Tür Default value Description
compatibility

object[]

Güncelleştirme uyumluluğu bilgilerinin listesi.

createdDateTime

string (date-time)

Güncelleştirmenin oluşturulduğu UTC tarihi ve saati.

description

string

minLength: 1
maxLength: 512

Oluşturucu tarafından belirtilen açıklamayı güncelleştirin.

etag

string

ETag'i güncelleştirin.

friendlyName

string

minLength: 1
maxLength: 512

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

importedDateTime

string (date-time)

Güncelleştirmenin içeri aktarıldığı UTC tarihi ve 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.