Importmanifestschema für Azure Device Update für IoT Hub

Wenn Sie ein Update in Azure Device Update für IoT Hub importieren, übermitteln Sie auch eine zugeordnete JSON-Importmanifestdatei, in der wichtige Informationen zum Update definiert sind. In diesem Artikel wird das Schema beschrieben, das zum Erstellen der JSON-Importmanifestdatei verwendet wird.

Weitere Informationen zu den Konzepten und der Dateistruktur von Importmanifesten finden Sie unter Azure Device Update für IoT Hub-Importmanifest. Informationen zum Erstellen der Datei finden Sie unter Vorbereiten eines Updates für den Import in Device Update for IoT Hub.

Schema

Das JSON-Schema für das Importmanifest wird bei SchemaStore.org gehostet und besteht aus den folgenden Eigenschaften. Andere Eigenschaften sind nicht zulässig.

Objekt aktualisieren

Das updateID Objekt ist ein eindeutiger Bezeichner für jede Aktualisierung.

Andere Eigenschaften sind nicht zulässig.

Beispiel:

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

Kompatibilitätsobjekt

Das compatibility Objekt beschreibt 1-5 Eigenschaften eines Geräts, mit denen dieses Update kompatibel ist. Jede Eigenschaft ist ein string Typ-Name-Wert-Paar. Der Name muss 1 bis 32 Zeichen lang sein, und der Wert muss 1 bis 64 Zeichen lang sein. Sie können nicht genau denselben Satz von Kompatibilitätseigenschaften mit mehr als einem Updateanbieter und einer Namenskombination verwenden.

Beispiel:

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

Instructions-Objekt

Das instructions Objekt stellt die Installationsanweisungen für das Update bereit. Das Anweisungsobjekt enthält eine Liste der auszuführenden steps Anweisungen. Andere Eigenschaften sind nicht zulässig.

Bei den Schritten kann es sich entweder um auszuführenden Code oder um Zeiger auf andere Updates handeln. Ein Schrittobjekt wird standardmäßig verwendet inline , wenn kein type Wert angegeben wird.

Beispiel:

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

Inline-Schritt-Objekt

Ein inline Schrittobjekt ist ein Installationsanweisungsschritt, der die Codeausführung ausführt.

Andere Eigenschaften sind nicht zulässig.

Beispiel:

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

Objekt "Referenzschritt"

Ein reference Schrittobjekt ist ein Installationsanweisungsschritt zum Installieren eines weiteren Updates.

Andere Eigenschaften sind nicht zulässig.

Beispiel:

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

Dateien-Objekt

Bei jedem files Objekt handelt es sich um eine Update-Payload-Datei, z. B. eine Binär-, Firmware- oder Skriptdatei, die innerhalb eines Updates eindeutig sein muss.

Andere Eigenschaften sind nicht zulässig.

Beispiel:

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

Hashes-Objekt

Das hashes Objekt enthält base64-codierte Dateihashes mit den Algorithmusnamen als Schlüssel. Mindestens der SHA-256-Algorithmus muss angegeben werden, und andere Algorithmen können angegeben werden, wenn der Agent unterstützt wird. Ein Beispiel für die korrekte Berechnung des Hashs finden Sie in der Get-AduFileHashes Funktion im Skript AduUpdate.psm1.

Andere Eigenschaften sind zulässig.

Beispiel:

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

relatedFiles-Objekt

Das relatedFiles Objekt enthält eine Sammlung von Dateien, die sich auf eine oder mehrere primäre Nutzlastdateien beziehen. Weitere Informationen finden Sie unter Verwenden der Funktion "Zugehörige Dateien", um auf mehrere Updatedateien zu verweisen.

Andere Eigenschaften sind zulässig.

Beispiel:

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

downloadHandler-Objekt

Das downloadHandler Objekt gibt an, wie alle zugehörigen Dateien verarbeitet werden sollen.

Andere Eigenschaften sind nicht zulässig.

Beispiel:

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

Verwandte Inhalte

• Importieren von Konzepten und Manifesten
• Vorbereiten eines zu importierenden Updates
• Importieren eines Updates