Skema manifes impor Azure Device Update for IoT Hub

Saat mengimpor pembaruan ke Azure Device Update for Iot Hub, Anda juga mengirimkan file manifes impor JSON terkait yang menentukan informasi penting tentang pembaruan. Artikel ini menjelaskan skema yang digunakan untuk membuat file manifes impor JSON.

Untuk mempelajari selengkapnya tentang mengimpor konsep manifes dan struktur file, lihat Manifes impor Azure Device Update for IoT Hub. Untuk mempelajari cara membuat file, lihat Menyiapkan pembaruan untuk diimpor ke Device Update for IoT Hub.

Skema

Skema JSON manifes impor dihosting di SchemaStore.org dan terdiri dari properti berikut. Tidak ada properti lain yang diizinkan.

Perbarui objek

Objek updateID adalah pengidentifikasi unik untuk setiap pembaruan.

Tidak ada properti lain yang diizinkan.

Contohnya:

{
  "updateId": {
    "provider": "Contoso",
    "name": "Toaster",
    "version": "1.0"
  }
}

Objek kompatibilitas

Objek menjelaskan compatibility 1-5 properti perangkat yang kompatibel dengan pembaruan ini. Setiap properti adalah string pasangan jenis nama-nilai. Panjang nama harus 1-32 karakter dan panjang nilainya harus 1-64 karakter. Anda tidak dapat menggunakan kumpulan properti kompatibilitas yang sama persis dengan lebih dari satu penyedia pembaruan dan kombinasi nama.

Contohnya:

{
  "compatibility": [
    {
      "manufacturer": "Contoso",
      "model": "Toaster"
    }
  ]
}

Objek instruksi

Objek instructions menyediakan instruksi penginstalan pembaruan. Objek instruksi berisi daftar steps yang akan dilakukan. Tidak ada properti lain yang diizinkan.

Langkah-langkah dapat berupa kode untuk dijalankan atau penunjuk ke pembaruan lain. Objek langkah default ke inline jika tidak ada type nilai yang disediakan.

Contohnya:

{
  "instructions": {
    "steps": [
      {
        "type": "inline",
        ...
      },
      {
        "type": "reference",
        ...
      }
    ]
  }
}

Objek langkah sebaris

Objek inline langkah adalah langkah instruksi penginstalan yang melakukan eksekusi kode.

Tidak ada properti lain yang diizinkan.

Contohnya:

{
  "steps": [
    {
      "description": "pre-install script",
      "handler": "microsoft/script:1",
      "handlerProperties": {
        "arguments": "--pre-install"
      },
      "files": [
        "configure.sh"
      ]
    }
  ]
}

Objek langkah referensi

Objek reference langkah adalah langkah instruksi penginstalan untuk menginstal pembaruan lain.

Tidak ada properti lain yang diizinkan.

Contohnya:

{
  "steps": [
    {
      "type": "reference",
      "updateId": {
        "provider": "Contoso",
        "name": "Toaster.HeatingElement",
        "version": "1.0"
      }
    }
  ]
}

Objek file

Setiap files objek adalah file payload pembaruan, seperti file biner, firmware, atau skrip, yang harus unik dalam pembaruan.

Tidak ada properti lain yang diizinkan.

Contohnya:

{
  "files": [
    {  
      "fileName": "full-image-file-name",
      "sizeInBytes": 12345,
      "hashes": {...},
      "relatedFiles": [
        {
          "fileName": "delta-from-v1-file-name",
          "sizeInBytes": 1234,
          "hashes": {
            "SHA256": "delta-from-v1-file-hash"
          },
          "properties": {...}
        }  
      ],
      "downloadHandler": {
        "id": "microsoft/delta:1"
        }
    }
  ]
}

Objek hash

Objek hashes berisi hash file yang dikodekan base64 dengan nama algoritma sebagai kunci. Setidaknya algoritma SHA-256 harus ditentukan, dan algoritma lain dapat ditentukan jika didukung oleh agen. Untuk contoh cara menghitung hash dengan benar, lihat Get-AduFileHashes fungsi dalam skrip AduUpdate.psm1.

Properti lain diperbolehkan.

Contohnya:

{
  "hashes": {
    "sha256": "/CD7Sn6fiknWa3NgcFjGlJ+ccA81s1QAXX4oo5GHiFA="
  }
}

objek relatedFiles

Objek relatedFiles berisi kumpulan file yang terkait dengan satu atau beberapa file payload utama. Untuk informasi selengkapnya, lihat Menggunakan fitur file terkait untuk mereferensikan beberapa file pembaruan.

Properti lain diperbolehkan.

Contohnya:

"relatedFiles": [
  {
    "filename": "in1_in2_deltaupdate.dat",
    "sizeInBytes": 102910752,
    "hashes": {
      "sha256": "2MIldV8LkdKenjJasgTHuYi+apgtNQ9FeL2xsV3ikHY="
    },
    "properties": {
      "microsoft.sourceFileHashAlgorithm": "sha256",
      "microsoft.sourceFileHash": "YmFYwnEUddq2nZsBAn5v7gCRKdHx+TUntMz5tLwU+24="
    }
  }
],

objek downloadHandler

Objek downloadHandler menentukan cara memproses file terkait.

Tidak ada properti lain yang diizinkan.

Contohnya:

"downloadHandler": {
  "id": "microsoft/delta:1"
}

Konten terkait

• Mengimpor konsep dan manifes
• Menyiapkan pembaruan untuk diimpor
• Mengimpor pembaruan