Device Update - Import Update

Service:: Device Update

Version d’API:: 2026-06-01

Importez la nouvelle version de mise à jour. Il s’agit d’une longue opération ; utilisez Operation-Location valeur d’en-tête de réponse pour vérifier l’état de l’opération.

POST https://{endpoint}/deviceUpdate/{instanceId}/updates:import?api-version=2026-06-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string (url)	Point de terminaison du compte Device Update pour IoT Hub (nom d’hôte uniquement, aucun protocole).
instanceId	path	True	string	Identificateur d’instance de compte IoT Hub device Update.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom	Type	Description
updateToImport	ImportUpdateInputItem[]	Mise à jour à importer (voir https://json.schemastore.org/azure-deviceupdate-import-manifest-5.0.json de schéma pour plus d’informations).

Réponses

Nom	Type	Description
200 OK	Update	La demande a réussi.
202 Accepted		La demande a été acceptée pour traitement, mais le traitement n’a pas encore été terminé. En-têtes Operation-Location: string
Other Status Codes	ErrorResponse	Réponse d’erreur inattendue.

Nom

Type

Description

200 OK

Update

La demande a réussi.

202 Accepted

La demande a été acceptée pour traitement, mais le traitement n’a pas encore été terminé.

En-têtes

Operation-Location: string

Other Status Codes

ErrorResponse

Réponse d’erreur inattendue.

Sécurité

OAuth2Auth

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
https://api.adu.microsoft.com/.default

Exemples

DeviceUpdate_ImportUpdate

Exemple de requête

HTTP

POST https://contoso.api.adu.microsoft.com/deviceUpdate/blue/updates:import?api-version=2026-06-01

[
  {
    "importManifest": {
      "url": "http://test.blob.core.windows.net/test/uploadimportMan.json",
      "sizeInBytes": 816,
      "hashes": {
        "sha256": "O19LyyncPe1AGstOdkcmozLV8pSbBdqrE18HdYVohRc="
      }
    },
    "files": [
      {
        "filename": "file1.bin",
        "url": "http://test.blob.core.windows.net/test/upload1v5uww1q"
      },
      {
        "filename": "file2.bin",
        "url": "http://test.blob.core.windows.net/test/uploadkrmn5yw0"
      },
      {
        "filename": "file3.bin",
        "url": "http://test.blob.core.windows.net/test/uploaddq52ky5m"
      }
    ]
  }
]

Exemple de réponse

Code d’état:: 202

Operation-Location: /deviceUpdate/blue/updates/operations/e4491c54-916f-443d-9094-bcca546ace2f?api-version=2026-06-01

Code d’état:: 200

{
  "updateId": {
    "provider": "microsoft",
    "name": "adu",
    "version": "1.0.0.0"
  },
  "friendlyName": "Lab Sensor Update v1",
  "description": "Fix for critical vulnerability",
  "compatibility": [
    {
      "deviceManufacturer": "Microsoft",
      "deviceModel": "Toaster"
    }
  ],
  "instructions": {
    "steps": [
      {
        "description": "pre-install script",
        "handler": "microsoft/script:1",
        "handlerProperties": {
          "arguments": "--pre-install"
        },
        "files": [
          "configure.sh"
        ]
      },
      {
        "type": "reference",
        "updateId": {
          "provider": "microsoft",
          "name": "sensor",
          "version": "1.0"
        }
      }
    ]
  },
  "manifestVersion": "5.0",
  "importedDateTime": "2020-04-22T14:01:43.8408797-07:00",
  "createdDateTime": "2019-09-11T17:00:00-07:00",
  "etag": "\"3fed3378-0c67-47d2-b796-296962c66cbb\""
}

Définitions

Nom	Description
Error	Détails de l’erreur.
ErrorResponse	Réponse d’erreur courante.
FileImportMetadata	Métadonnées décrivant un fichier de mise à jour.
ImportManifestMetadata	Métadonnées décrivant le manifeste d’importation, document qui décrit les fichiers et d’autres métadonnées sur une version de mise à jour.
ImportUpdateInputItem	Importez les métadonnées de l’élément d’entrée de mise à jour.
InnerError	Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.
Instructions	Mise à jour le conteneur des instructions d’installation.
Step	Mettre à jour l’étape d’instruction d’installation.
StepType	Type d’étape.
Update	Mettez à jour les métadonnées.
UpdateId	Mettre à jour l’identificateur.

Error

Objet

Détails de l’erreur.

Nom	Type	Description
code	string	Code d’erreur défini par le serveur.
details	Error[]	Tableau d’erreurs qui ont conduit à l’erreur signalée.
innererror	InnerError	Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.
message	string	Une représentation lisible par une personne de l'erreur.
occurredDateTime	string (date-time)	Date et heure UTC lorsque l’erreur s’est produite.
target	string	Cible de l’erreur.

ErrorResponse

Objet

Réponse d’erreur courante.

Nom	Type	Description
error	Error	Détails de l’erreur.

FileImportMetadata

Objet

Métadonnées décrivant un fichier de mise à jour.

Nom	Type	Description
filename	string	Mettez à jour le nom de fichier tel que spécifié dans le manifeste d’importation.
url	string	Emplacement d’objet blob Azure à partir duquel le fichier de mise à jour peut être téléchargé par Device Update pour IoT Hub. Il s’agit généralement d’une URL d’objet blob protégée par SAP en lecture seule avec une expiration définie sur au moins 4 heures.

ImportManifestMetadata

Objet

Métadonnées décrivant le manifeste d’importation, document qui décrit les fichiers et d’autres métadonnées sur une version de mise à jour.

Nom	Type	Description
hashes	object	Objet JSON contenant le ou les hachages du fichier. Au moins SHA256 hash est requis. Cet objet peut être considéré comme un ensemble de paires clé-valeur où la clé est l’algorithme de hachage, et la valeur est le hachage du fichier calculé à l’aide de cet algorithme.
sizeInBytes	integer (int64)	Taille du fichier en nombre d’octets.
url	string	Emplacement d’objet blob Azure à partir duquel le manifeste d’importation peut être téléchargé par Device Update pour IoT Hub. Il s’agit généralement d’une URL d’objet blob protégée par SAP en lecture seule avec une expiration définie sur au moins 4 heures.

ImportUpdateInputItem

Objet

Importez les métadonnées de l’élément d’entrée de mise à jour.

Nom	Type	Description
files	FileImportMetadata[]	Une ou plusieurs propriétés de fichier de mise à jour telles que le nom de fichier et l’URL source.
friendlyName	string minLength: 1 maxLength: 512	Nom de la mise à jour conviviale.
importManifest	ImportManifestMetadata	Importez des métadonnées de manifeste telles que l’URL source, la taille de fichier/hachage, etc.

InnerError

Objet

Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.

Nom	Type	Description
code	string	Code d’erreur plus spécifique que ce qui a été fourni par l’erreur contenante.
errorDetail	string	Message d’erreur interne ou d’exception.
innerError	InnerError	Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.
message	string	Une représentation lisible par une personne de l'erreur.

Instructions

Objet

Mise à jour le conteneur des instructions d’installation.

Nom	Type	Description
steps	Step[]	Collection des étapes d’installation.

Step

Objet

Mettre à jour l’étape d’instruction d’installation.

Nom	Type	Valeur par défaut	Description
description	string minLength: 1 maxLength: 64		Description de l’étape.
files	string[]		Collection de noms de fichiers à passer au gestionnaire pendant l’exécution. Obligatoire si le type d’étape est inline.
handler	string minLength: 1 maxLength: 32		Identité du gestionnaire qui exécutera cette étape. Obligatoire si le type d’étape est inline.
handlerProperties			Paramètres à passer au gestionnaire pendant l’exécution.
type	StepType	inline	Type d’étape.
updateId	UpdateId		Identité de mise à jour enfant référencée. Obligatoire si le type d’étape est référence.

StepType

Énumération

Type d’étape.

Valeur	Description
inline	Type d’étape qui exécute le code.
reference	Un type d’étape qui installe une autre mise à jour.

Update

Objet

Mettez à jour les métadonnées.

Nom	Type	Valeur par défaut	Description
compatibility	object[]		Liste des informations de compatibilité des mises à jour.
createdDateTime	string (date-time)		Date et heure UTC lors de la création de la mise à jour.
description	string minLength: 1 maxLength: 512		Mise à jour de la description spécifiée par le créateur.
etag	string		Mettre à jour ETag.
friendlyName	string minLength: 1 maxLength: 512		Nom de mise à jour convivial spécifié par l’importateur.
importedDateTime	string (date-time)		Date et heure UTC lors de l’importation de la mise à jour.
installedCriteria	string		Chaîne interprétée par le client Device Update pour déterminer si la mise à jour est installée sur l’appareil. Déconseillé dans le dernier schéma de manifeste d’importation.
instructions	Instructions		Mettre à jour les instructions d’installation.
isDeployable	boolean	True	Indique si la mise à jour peut être déployée sur un appareil par elle-même.
manifestVersion	string		Version de schéma du manifeste utilisée pour importer la mise à jour.
referencedBy	UpdateId[]		Liste des identités de mise à jour qui font référence à cette mise à jour.
scanResult	string		Mettre à jour le résultat de l’analyse d’agrégation (calculé à partir des résultats de l’analyse du fichier de charge utile).
updateId	UpdateId		Mettre à jour l’identité.
updateType	string		Type de mise à jour. Déconseillé dans le dernier schéma de manifeste d’importation.

UpdateId

Objet

Mettre à jour l’identificateur.

Nom	Type	Description
name	string	Nom de mise à jour.
provider	string	Mettre à jour le fournisseur.
version	string	Mettre à jour la version.