Schéma de manifeste d’importation Azure Device Update pour IoT Hub

Lorsque vous importez une mise à jour dans Azure Device Update pour IoT Hub, vous soumettez également un fichier manifeste d’importation JSON associé qui définit des informations importantes sur la mise à jour. Cet article décrit le schéma utilisé pour créer le fichier manifeste d’importation JSON.

Pour en savoir plus sur les concepts de manifeste d’importation et la structure des fichiers, consultez Manifeste d’importation Azure Device Update pour IoT Hub. Pour savoir comment créer le fichier, consultez Préparer une mise à jour à importer dans Device Update pour IoT Hub.

Schéma

Le schéma JSON du manifeste d’importation est hébergé chez SchemaStore.org et se compose des propriétés suivantes. Aucune autre propriété n’est autorisée.

Mettre à jour un objet

L’objet updateID est un identificateur unique pour chaque mise à jour.

Aucune autre propriété n’est autorisée.

Par exemple:

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

Objet de compatibilité

L’objet compatibility décrit 1 à 5 propriétés d’un appareil avec lequel cette mise à jour est compatible. Chaque propriété est une string paire nom-valeur de type. Le nom doit comporter de 1 à 32 caractères et la valeur de 1 à 64 caractères. Vous ne pouvez pas utiliser le même ensemble exact de propriétés de compatibilité avec plus d’une combinaison de fournisseur de mise à jour et de nom.

Par exemple:

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

Objet Instructions

L’objet instructions fournit les instructions d’installation de la mise à jour. L’objet instructions contient une liste de steps à effectuer. Aucune autre propriété n’est autorisée.

Les étapes peuvent être du code à exécuter ou des pointeurs vers d’autres mises à jour. La valeur par défaut d’un objet step n’est fournie si inline aucune valeur n’est type fournie.

Par exemple:

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

Objet d’étape en ligne

Un inline objet step est une étape d’instruction d’installation qui effectue l’exécution du code.

Aucune autre propriété n’est autorisée.

Par exemple:

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

Objet d’étape de référence

Un reference objet step est une instruction d’installation permettant d’installer une autre mise à jour.

Aucune autre propriété n’est autorisée.

Par exemple:

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

Objet Files

Chaque files objet est un fichier de charge utile de mise à jour, tel qu’un fichier binaire, un microprogramme ou un fichier de script, qui doit être unique dans une mise à jour.

Aucune autre propriété n’est autorisée.

Par exemple:

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

Objet Hashes

L’objet hashes contient des hachages de fichiers codés en base64 avec les noms de l’algorithme sous forme de clés. Au moins l’algorithme SHA-256 doit être spécifié, et d’autres algorithmes peuvent être spécifiés si pris en charge par l’agent. Pour obtenir un exemple de calcul correct du hachage, consultez la Get-AduFileHashes fonction dans le script AduUpdate.psm1.

D’autres propriétés sont autorisées.

Par exemple:

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

Objet relatedFiles

L’objet relatedFiles contient une collection de fichiers associés à un ou plusieurs fichiers de charge utile primaires. Pour plus d’informations, consultez Utiliser la fonctionnalité Fichiers associés pour référencer plusieurs fichiers de mise à jour.

D’autres propriétés sont autorisées.

Par exemple:

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

downloadHandler, objet

L’objet downloadHandler spécifie comment traiter les fichiers associés.

Aucune autre propriété n’est autorisée.

Par exemple:

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

Contenu connexe

• Importer des concepts et un manifeste
• Préparer une mise à jour à importer
• Importer une mise à jour