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 envoyez é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 du fichier, 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é à 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 à chaque mise à jour.

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

Par exemple :

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

Objet Compatibilité

L’objet compatibility décrit les propriétés 1 à 5 d’un appareil avec lequel cette mise à jour est compatible. Chaque propriété est une paire nom/valeur de type string. Le nom doit contenir de 1 à 32 caractères et la valeur doit contenir de 1 à 64 caractères. Vous ne pouvez pas utiliser le même ensemble 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. Un objet d’étape est défini par défaut sur inline si aucune valeur type n’est fournie.

Par exemple :

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

Objet d’étape inline

Un objet d’étape inline est une étape d’instruction d’installation qui exécute 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 objet d’étape reference est une étape d’instruction d’installation qui installe 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 Fichiers

Chaque objet files est un fichier de charge utile de mise à jour, tel qu’un fichier binaire, un microprogramme ou un 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 Hachages

L’objet hashes contient des hachages de fichiers encodés en base64 avec les noms d’algorithmes en tant que clés. L’algorithme SHA-256 doit être impérativement spécifié. D’autres algorithmes peuvent également être spécifiés si l’agent les prend en charge. Pour un exemple de la façon de calculer le hachage correctement, consultez la fonction Get-AduFileHashes 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 liés à un ou plusieurs fichiers de charge utile principale. Pour plus d’informations, consultez Utiliser la fonctionnalité de 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="
    }
  }
],

Objet downloadHandler

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

• Manifeste et concepts d’importation
• Préparer une mise à jour à importer
• Importer une mise à jour