Device Update - Import Update

Tjänst:: Device Update

API-version:: 2026-06-01

Importera ny uppdateringsversion. Det här är en tidskrävande åtgärd. använd Operation-Location svarshuvudvärde för att söka efter åtgärdsstatus.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string (url)	Enhetsuppdatering för IoT Hub-kontoslutpunkten (endast värdnamn, inget protokoll).
instanceId	path	True	string	Enhetsuppdatering för IoT Hub-kontoinstansidentifierare.
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.

Begärandetext

Name	Typ	Description
updateToImport	ImportUpdateInputItem[]	Uppdateringen som ska importeras (se schema https://json.schemastore.org/azure-deviceupdate-import-manifest-5.0.json för mer information).

Svar

Name	Typ	Description
200 OK	Update	Begäran har slutförts.
202 Accepted		Begäran har godkänts för bearbetning, men bearbetningen har ännu inte slutförts. Sidhuvuden Operation-Location: string
Other Status Codes	ErrorResponse	Ett oväntat felsvar.

Name

Typ

Description

200 OK

Update

Begäran har slutförts.

202 Accepted

Begäran har godkänts för bearbetning, men bearbetningen har ännu inte slutförts.

Sidhuvuden

Operation-Location: string

Other Status Codes

ErrorResponse

Ett oväntat felsvar.

Säkerhet

OAuth2Auth

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

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

Exempel

DeviceUpdate_ImportUpdate

Exempelbegäran

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

Exempelsvar

Statuskod:: 202

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

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

Definitioner

Name	Description
Error	Felinformation.
ErrorResponse	Vanligt felsvar.
FileImportMetadata	Metadata som beskriver en uppdateringsfil.
ImportManifestMetadata	Metadata som beskriver importmanifestet, ett dokument som beskriver filerna och andra metadata om en uppdateringsversion.
ImportUpdateInputItem	Importera metadata för indataobjekt för uppdatering.
InnerError	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
Instructions	Uppdatera installationsinstruktioner-containern.
Step	Uppdatera installationsinstruktionssteget.
StepType	Stegtyp.
Update	Uppdatera metadata.
UpdateId	Uppdatera identifierare.

Error

Objekt

Felinformation.

Name	Typ	Description
code	string	Serverdefinierad felkod.
details	Error[]	En matris med fel som ledde till det rapporterade felet.
innererror	InnerError	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
message	string	En mänsklig läsbar representation av felet.
occurredDateTime	string (date-time)	Datum och tid i UTC när felet inträffade.
target	string	Målet för felet.

ErrorResponse

Objekt

Vanligt felsvar.

Name	Typ	Description
error	Error	Felinformationen.

FileImportMetadata

Objekt

Metadata som beskriver en uppdateringsfil.

Name	Typ	Description
filename	string	Uppdatera filnamnet enligt vad som anges i importmanifestet.
url	string	Azure Blob-plats från vilken uppdateringsfilen kan laddas ned av Enhetsuppdatering för IoT Hub. Detta är vanligtvis en skrivskyddad SAS-skyddad blob-URL med en förfallotid inställd på minst 4 timmar.

ImportManifestMetadata

Objekt

Metadata som beskriver importmanifestet, ett dokument som beskriver filerna och andra metadata om en uppdateringsversion.

Name	Typ	Description
hashes	object	Ett JSON-objekt som innehåller filens hash(es). Minst SHA256-hash krävs. Det här objektet kan ses som en uppsättning nyckel/värde-par där nyckeln är hash-algoritmen, och värdet är hashen för filen som beräknas med hjälp av den algoritmen.
sizeInBytes	integer (int64)	Filstorlek i antal byte.
url	string	Azure Blob-plats från vilken importmanifestet kan laddas ned av Enhetsuppdatering för IoT Hub. Detta är vanligtvis en skrivskyddad SAS-skyddad blob-URL med en förfallotid inställd på minst 4 timmar.

ImportUpdateInputItem

Objekt

Importera metadata för indataobjekt för uppdatering.

Name	Typ	Description
files	FileImportMetadata[]	En eller flera uppdateringsfilegenskaper som filnamn och käll-URL.
friendlyName	string minLength: 1 maxLength: 512	Eget uppdateringsnamn.
importManifest	ImportManifestMetadata	Importera manifestmetadata som käll-URL, filstorlek/hashvärden osv.

InnerError

Objekt

Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.

Name	Typ	Description
code	string	En mer specifik felkod än vad som angavs av det innehållande felet.
errorDetail	string	Det interna felet eller undantagsmeddelandet.
innerError	InnerError	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
message	string	En mänsklig läsbar representation av felet.

Instructions

Objekt

Uppdatera installationsinstruktioner-containern.

Name	Typ	Description
steps	Step[]	Samling installationssteg.

Step

Objekt

Uppdatera installationsinstruktionssteget.

Name	Typ	Standardvärde	Description
description	string minLength: 1 maxLength: 64		Stegbeskrivning.
files	string[]		Samling filnamn som ska skickas till hanteraren under körningen. Krävs om stegtypen är infogad.
handler	string minLength: 1 maxLength: 32		Identitet för den hanterare som ska utföra det här steget. Krävs om stegtypen är infogad.
handlerProperties			Parametrar som ska skickas till hanteraren under körningen.
type	StepType	inline	Stegtyp.
updateId	UpdateId		Refererade till underordnad uppdateringsidentitet. Krävs om stegtypen är referens.

StepType

Uppräkning

Stegtyp.

Värde	Description
inline	Stegtyp som utför kodexekvering.
reference	Stegtyp som installerar en ny uppdatering.

Update

Objekt

Uppdatera metadata.

Name	Typ	Standardvärde	Description
compatibility	object[]		Lista över uppdateringskompatibilitetsinformation.
createdDateTime	string (date-time)		Datum och tid i UTC när uppdateringen skapades.
description	string minLength: 1 maxLength: 512		Uppdateringsbeskrivning som angetts av skaparen.
etag	string		Uppdatera ETag.
friendlyName	string minLength: 1 maxLength: 512		Eget uppdateringsnamn som anges av importören.
importedDateTime	string (date-time)		Datum och tid i UTC när uppdateringen importerades.
installedCriteria	string		Sträng som tolkas av enhetsuppdateringsklienten för att avgöra om uppdateringen är installerad på enheten. Inaktuellt i det senaste importmanifestschemat.
instructions	Instructions		Uppdatera installationsanvisningarna.
isDeployable	boolean	True	Om uppdateringen kan distribueras till en enhet på egen hand.
manifestVersion	string		Schemaversion av manifestet som används för att importera uppdateringen.
referencedBy	UpdateId[]		Lista över uppdateringsidentiteter som refererar till den här uppdateringen.
scanResult	string		Uppdatera aggregerat genomsökningsresultat (beräknat från nyttolastfilgenomsökningsresultat).
updateId	UpdateId		Uppdatera identitet.
updateType	string		Uppdateringstyp. Inaktuellt i det senaste importmanifestschemat.

UpdateId

Objekt

Uppdatera identifierare.

Name	Typ	Description
name	string	Uppdateringsnamn.
provider	string	Uppdateringsprovider.
version	string	Uppdatera version.