Importation de mises à jour dans Device Update pour IoT Hub : schéma et autres informations

Si vous souhaitez importer une mise à jour dans Device Update pour IoT Hub, veillez à consulter d’abord les concepts et le guide pratique. Si vous êtes intéressé par les détails du schéma de manifeste d’importation ou par des informations sur les autorisations d’API, consultez les sections ci-dessous.

Le schéma JSON du manifeste d’importation est hébergé sur SchemaStore.org.

schéma

Aucune propriété supplémentaire n’est autorisée.

Objet updateId

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

Aucune propriété supplémentaire n’est autorisée.

Par exemple :

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

objet compatibilité

L’objet compatibilité décrit les propriétés d’un appareil avec lequel cette mise à jour est compatible.

• Type : object
• Nombre minimal de propriétés : 1
• Nombre maximal de propriétés : 5

Chaque propriété est une paire nom-valeur de type chaîne.

• Longueur minimale du nom de propriété : 1
• Longueur maximale du nom de propriété : 32
• Longueur minimale de la valeur de propriété : 1
• Longueur maximale de la valeur de propriété : 64

Le même ensemble de propriétés de compatibilité ne peut pas être utilisé avec plus d’une combinaison de fournisseur de mise à jour et de nom.

Par exemple :

{
  "compatibility": [
    {
      "deviceManufacturer": "Contoso",
      "deviceModel": "Toaster"
    }
  ]
}

Objet instructions

L’objet instructions fournit les instructions d’installation de mise à jour. L’objet instructions contient une liste d’étapes à suivre. Ces étapes peuvent être du code à exécuter ou un pointeur vers une autre mise à jour.

Aucune propriété supplémentaire n’est autorisée.

Par exemple :

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

Objet inlineStep

Un objet étape inline est une étape d’instruction d’installation qui exécute du code.

Aucune propriété supplémentaire n’est autorisée.

Par exemple :

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

Objet referenceStep

Un objet étape reference est une étape d’instruction d’installation qui installe une autre mise à jour.

Aucune propriété supplémentaire n’est autorisée.

Par exemple :

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

Objet file

Un objet fichier est un fichier de charge utile de mise à jour, par exemple, binaire, microprogramme, script, etc. Chaque objet fichier doit être unique au sein d’une mise à jour.

Aucune propriété supplémentaire n’est autorisée.

Par exemple :

{
  "files": [
    {
      "filename": "configure.sh",
      "sizeInBytes": 7558,
      "hashes": {...}
    }
  ]
}

Objet fileHashes

Hachages de fichier encodés en base64 avec le nom d’algorithme en tant que clé. 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 calcul correct du hachage, voir la fonction Get-AduFileHashes dans le script AduUpdate.psm1.

Des propriétés supplémentaires sont autorisées.

Par exemple :

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

Étapes suivantes

En savoir plus sur les concepts d’importation.

Si vous êtes prêt, suivez le Guide pratique d’importation, qui vous guidera pas à pas tout au long du processus d’importation.