Schema för importmanifest för Azure Device Update för IoT Hub

När du importerar en uppdatering till Azure Device Update för IoT Hub skickar du även en associerad JSON-importmanifestfil som definierar viktig information om uppdateringen. I den här artikeln beskrivs det schema som används för att skapa JSON-importmanifestfilen.

Mer information om importmanifestbegrepp och filstruktur finns i Importmanifestet för Azure Device Update för IoT Hub. Information om hur du skapar filen finns i Förbereda en uppdatering för import till Enhetsuppdatering för IoT Hub.

Schemat

JSON-schemat för importmanifestet finns på SchemaStore.org och består av följande egenskaper. Inga andra egenskaper tillåts.

Uppdatera objekt

Objektet updateID är en unik identifierare för varje uppdatering.

Inga andra egenskaper tillåts.

Till exempel:

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

Kompatibilitetsobjekt

Objektet compatibility beskriver 1–5 egenskaper för en enhet som uppdateringen är kompatibel med. Varje egenskap är ett string typnamn/värde-par. Namnet måste vara 1–32 tecken långt och värdet måste vara 1–64 tecken långt. Du kan inte använda samma exakta uppsättning kompatibilitetsegenskaper med fler än en uppdateringsprovider och namnkombination.

Till exempel:

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

Instruktionsobjekt

Objektet instructions innehåller installationsanvisningarna för uppdateringen. Instruktionsobjektet innehåller en lista över steps som ska utföras. Inga andra egenskaper tillåts.

Steg kan antingen vara kod för att köra eller pekar på andra uppdateringar. Ett stegobjekt används som standardvärde om inget inline-värde anges.

Till exempel:

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

Infogat stegobjekt

Ett inline stegobjekt är ett installationsinstruktionssteg som utför kodkörning.

Inga andra egenskaper tillåts.

Till exempel:

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

Referensstegsobjekt

Ett reference stegobjekt är ett installationsinstruktionssteg för att installera en annan uppdatering.

Inga andra egenskaper tillåts.

Till exempel:

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

Filobjekt

Varje files objekt är en uppdateringsnyttolastfil, till exempel en binär fil, inbyggd programvara eller skriptfil, som måste vara unik i en uppdatering.

Inga andra egenskaper tillåts.

Till exempel:

{
  "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"
        }
    }
  ]
}

Hash-objekt

Objektet hashes innehåller base64-kodade fil-hashar med algoritmnamnen som nycklar. Minst SHA-256-algoritmen måste anges och andra algoritmer kan anges om agenten stöder det. Ett exempel på hur du beräknar hashen korrekt Get-AduFileHashes finns i funktionen i skriptet AduUpdate.psm1.

Andra egenskaper tillåts.

Till exempel:

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

relatedFiles-objekt

Objektet relatedFiles innehåller en samling filer som är relaterade till en eller flera primära nyttolastfiler. Mer information finns i Använda funktionen relaterade filer för att referera till flera uppdateringsfiler.

Andra egenskaper tillåts.

Till exempel:

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

downloadHandler-objekt

Objektet downloadHandler anger hur du bearbetar relaterade filer.

Inga andra egenskaper tillåts.

Till exempel:

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

Relaterat innehåll

• Importera begrepp och manifest
• Förbereda en uppdatering för import
• Importera en uppdatering