Device Update - Import Update

Service:: Device Update

API-versie:: 2026-06-01

Nieuwe updateversie importeren. Dit is een langdurige bewerking; gebruik Operation-Location waarde voor antwoordheader om te controleren op de bewerkingsstatus.

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

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string (url)	De apparaatupdate voor het eindpunt van het IoT Hub-account (alleen hostnaam, geen protocol).
instanceId	path	True	string	De apparaatupdate voor de exemplaar-id van het IoT Hub-account.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name	Type	Description
updateToImport	ImportUpdateInputItem[]	De update die moet worden geïmporteerd (zie schema https://json.schemastore.org/azure-deviceupdate-import-manifest-5.0.json voor meer informatie).

Antwoorden

Name	Type	Description
200 OK	Update	De aanvraag is voltooid.
202 Accepted		De aanvraag is geaccepteerd voor verwerking, maar de verwerking is nog niet voltooid. Kopteksten Operation-Location: string
Other Status Codes	ErrorResponse	Een onverwachte foutreactie.

Name

Type

Description

200 OK

Update

De aanvraag is voltooid.

202 Accepted

De aanvraag is geaccepteerd voor verwerking, maar de verwerking is nog niet voltooid.

Kopteksten

Operation-Location: string

Other Status Codes

ErrorResponse

Een onverwachte foutreactie.

Beveiliging

OAuth2Auth

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

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

Voorbeelden

DeviceUpdate_ImportUpdate

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:: 202

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

Statuscode:: 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\""
}

Definities

Name	Description
Error	Foutdetails.
ErrorResponse	Veelvoorkomende foutreactie.
FileImportMetadata	Metagegevens die een updatebestand beschrijven.
ImportManifestMetadata	Metagegevens die het importmanifest beschrijven, een document waarin de bestanden en andere metagegevens over een updateversie worden beschreven.
ImportUpdateInputItem	Importeer de metagegevens van het invoeritem.
InnerError	Een object met meer specifieke informatie dan het huidige object over de fout.
Instructions	Update installatie-instructies container.
Step	De installatie-instructiestap bijwerken.
StepType	Staptype.
Update	Metagegevens bijwerken.
UpdateId	Id bijwerken.

Error

Object

Foutdetails.

Name	Type	Description
code	string	Door de server gedefinieerde foutcode.
details	Error[]	Een matrix met fouten die hebben geleid tot de gemelde fout.
innererror	InnerError	Een object met meer specifieke informatie dan het huidige object over de fout.
message	string	Een leesbare weergave van de fout.
occurredDateTime	string (date-time)	Datum en tijd in UTC wanneer de fout is opgetreden.
target	string	Het doel van de fout.

ErrorResponse

Object

Veelvoorkomende foutreactie.

Name	Type	Description
error	Error	De foutgegevens.

FileImportMetadata

Object

Metagegevens die een updatebestand beschrijven.

Name	Type	Description
filename	string	Werk de bestandsnaam bij zoals opgegeven in het importmanifest.
url	string	Azure Blob-locatie waaruit het updatebestand kan worden gedownload door Device Update for IoT Hub. Dit is doorgaans een alleen-lezen SAS-beveiligde blob-URL met een vervaldatum die is ingesteld op ten minste 4 uur.

ImportManifestMetadata

Object

Metagegevens die het importmanifest beschrijven, een document waarin de bestanden en andere metagegevens over een updateversie worden beschreven.

Name	Type	Description
hashes	object	Een JSON-object met de hash(sen) van het bestand. Ten minste SHA256-hash is vereist. Dit object kan worden beschouwd als een set sleutel-waardeparen waarbij de sleutel het hash-algoritme is en de waarde de hash is van het bestand dat met dat algoritme wordt berekend.
sizeInBytes	integer (int64)	Bestandsgrootte in het aantal bytes.
url	string	Azure Blob-locatie waaruit het importmanifest kan worden gedownload door Device Update for IoT Hub. Dit is doorgaans een alleen-lezen SAS-beveiligde blob-URL met een vervaldatum die is ingesteld op ten minste 4 uur.

ImportUpdateInputItem

Object

Importeer de metagegevens van het invoeritem.

Name	Type	Description
files	FileImportMetadata[]	Een of meer eigenschappen van bestanden bijwerken, zoals bestandsnaam en bron-URL.
friendlyName	string minLength: 1 maxLength: 512	Beschrijvende updatenaam.
importManifest	ImportManifestMetadata	Importeer manifestmetagegevens zoals bron-URL, bestandsgrootte/hashes, enzovoort.

InnerError

Object

Een object met meer specifieke informatie dan het huidige object over de fout.

Name	Type	Description
code	string	Een specifiekere foutcode dan de foutcode die is opgegeven door de bijbehorende fout.
errorDetail	string	Het interne foutbericht of het uitzonderingsbericht.
innerError	InnerError	Een object met meer specifieke informatie dan het huidige object over de fout.
message	string	Een leesbare weergave van de fout.

Instructions

Object

Update installatie-instructies container.

Name	Type	Description
steps	Step[]	Verzameling van installatiestappen.

Step

Object

De installatie-instructiestap bijwerken.

Name	Type	Default value	Description
description	string minLength: 1 maxLength: 64		Beschrijving van stap.
files	string[]		Verzameling bestandsnamen die tijdens de uitvoering aan de handler moeten worden doorgegeven. Vereist als het staptype inline is.
handler	string minLength: 1 maxLength: 32		Identiteit van handler die deze stap uitvoert. Vereist als het staptype inline is.
handlerProperties			Parameters die tijdens de uitvoering aan de handler moeten worden doorgegeven.
type	StepType	inline	Staptype.
updateId	UpdateId		Er wordt verwezen naar de identiteit van onderliggende updates. Vereist als het staptype verwijzing is.

StepType

Opsomming

Staptype.

Waarde	Description
inline	Staptype dat code-uitvoering uitvoert.
reference	Staptype dat een nieuwe update installeert.

Update

Object

Metagegevens bijwerken.

Name	Type	Default value	Description
compatibility	object[]		Lijst met updatecompatibiliteitsgegevens.
createdDateTime	string (date-time)		De datum en tijd in UTC waarop de update is gemaakt.
description	string minLength: 1 maxLength: 512		Beschrijving bijwerken die is opgegeven door de maker.
etag	string		ETag bijwerken.
friendlyName	string minLength: 1 maxLength: 512		Beschrijvende updatenaam die is opgegeven door importer.
importedDateTime	string (date-time)		Datum en tijd in UTC toen de update werd geïmporteerd.
installedCriteria	string		Tekenreeks die wordt geïnterpreteerd door de Device Update-client om te bepalen of de update op het apparaat is geïnstalleerd. Afgeschaft in het meest recente importmanifestschema.
instructions	Instructions		Installatie-instructies bijwerken.
isDeployable	boolean	True	Of de update op een apparaat zelf kan worden geïmplementeerd.
manifestVersion	string		Schemaversie van het manifest dat wordt gebruikt voor het importeren van de update.
referencedBy	UpdateId[]		Lijst met update-identiteiten die naar deze update verwijzen.
scanResult	string		Samenvoegingsscanresultaat bijwerken (berekend op basis van scanresultaten van nettoladingbestanden).
updateId	UpdateId		Identiteit bijwerken.
updateType	string		Type update. Afgeschaft in het meest recente importmanifestschema.

UpdateId

Object

Id bijwerken.

Name	Type	Description
name	string	Naam bijwerken.
provider	string	Updateprovider.
version	string	Updateversie.