Device Update - Import Update

Servicio:: Device Update

Versión de la API:: 2026-06-01

Importe la nueva versión de actualización. Se trata de una operación de larga duración; use Operation-Location valor del encabezado de respuesta para comprobar el estado de la operación.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string (url)	El punto de conexión de la cuenta de Device Update para IoT Hub (solo nombre de host, sin protocolo).
instanceId	path	True	string	Identificador de instancia de cuenta de Device Update para IoT Hub.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Cuerpo de la solicitud

Nombre	Tipo	Description
updateToImport	ImportUpdateInputItem[]	La actualización que se va a importar (consulte https://json.schemastore.org/azure-deviceupdate-import-manifest-5.0.json de esquema para obtener más información).

Respuestas

Nombre	Tipo	Description
200 OK	Update	La solicitud se ha realizado correctamente.
202 Accepted		La solicitud se ha aceptado para su procesamiento, pero el procesamiento aún no se ha completado. Encabezados Operation-Location: string
Other Status Codes	ErrorResponse	Una respuesta de error inesperada.

Nombre

Tipo

Description

200 OK

Update

La solicitud se ha realizado correctamente.

202 Accepted

La solicitud se ha aceptado para su procesamiento, pero el procesamiento aún no se ha completado.

Encabezados

Operation-Location: string

Other Status Codes

ErrorResponse

Una respuesta de error inesperada.

Seguridad

OAuth2Auth

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

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

Ejemplos

DeviceUpdate_ImportUpdate

Solicitud de ejemplo

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

Respuesta de muestra

status code:: 202

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

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

Definiciones

Nombre	Description
Error	Detalles del error.
ErrorResponse	Respuesta de error común.
FileImportMetadata	Metadatos que describen un archivo de actualización.
ImportManifestMetadata	Metadatos que describen el manifiesto de importación, un documento que describe los archivos y otros metadatos sobre una versión de actualización.
ImportUpdateInputItem	Importar metadatos de elemento de entrada de actualización.
InnerError	Objeto que contiene información más específica que el objeto actual sobre el error.
Instructions	Actualizar instrucciones de instalación contenedor.
Step	Actualice el paso de instrucción de instalación.
StepType	Tipo de paso.
Update	Actualizar metadatos.
UpdateId	Identificador de actualización.

Error

Objeto

Detalles del error.

Nombre	Tipo	Description
code	string	Código de error definido por el servidor.
details	Error[]	Matriz de errores que llevaron al error notificado.
innererror	InnerError	Objeto que contiene información más específica que el objeto actual sobre el error.
message	string	Una representación en lenguaje natural del error.
occurredDateTime	string (date-time)	Fecha y hora en UTC cuando se produjo el error.
target	string	Destino del error.

ErrorResponse

Objeto

Respuesta de error común.

Nombre	Tipo	Description
error	Error	Detalles del error.

FileImportMetadata

Objeto

Metadatos que describen un archivo de actualización.

Nombre	Tipo	Description
filename	string	Actualice el nombre de archivo tal como se especifica dentro del manifiesto de importación.
url	string	Ubicación del blob de Azure desde la que device Update para IoT Hub puede descargar el archivo de actualización. Normalmente, se trata de una dirección URL de blob protegida por SAS de solo lectura con una expiración establecida en al menos 4 horas.

ImportManifestMetadata

Objeto

Metadatos que describen el manifiesto de importación, un documento que describe los archivos y otros metadatos sobre una versión de actualización.

Nombre	Tipo	Description
hashes	object	Objeto JSON que contiene los hash(es) del archivo. Se requiere al menos hash SHA256. Este objeto se puede considerar como un conjunto de pares clave-valor donde la clave es el algoritmo hash y el valor es el hash del archivo calculado mediante ese algoritmo.
sizeInBytes	integer (int64)	Tamaño del archivo en número de bytes.
url	string	Ubicación del blob de Azure desde la que device Update para IoT Hub puede descargar el manifiesto de importación. Normalmente, se trata de una dirección URL de blob protegida por SAS de solo lectura con una expiración establecida en al menos 4 horas.

ImportUpdateInputItem

Objeto

Importar metadatos de elemento de entrada de actualización.

Nombre	Tipo	Description
files	FileImportMetadata[]	Una o varias propiedades de archivo de actualización, como nombre de archivo y dirección URL de origen.
friendlyName	string minLength: 1 maxLength: 512	Nombre de actualización descriptivo.
importManifest	ImportManifestMetadata	Importe metadatos de manifiesto, como la dirección URL de origen, el tamaño o los hashes de archivo, etc.

InnerError

Objeto

Objeto que contiene información más específica que el objeto actual sobre el error.

Nombre	Tipo	Description
code	string	Código de error más específico que el proporcionado por el error contenedor.
errorDetail	string	Mensaje interno de error o excepción.
innerError	InnerError	Objeto que contiene información más específica que el objeto actual sobre el error.
message	string	Una representación en lenguaje natural del error.

Instructions

Objeto

Actualizar instrucciones de instalación contenedor.

Nombre	Tipo	Description
steps	Step[]	Colección de pasos de instalación.

Step

Objeto

Actualice el paso de instrucción de instalación.

Nombre	Tipo	Valor predeterminado	Description
description	string minLength: 1 maxLength: 64		Descripción del paso.
files	string[]		Colección de nombres de archivo que se van a pasar al controlador durante la ejecución. Obligatorio si el tipo de paso está insertado.
handler	string minLength: 1 maxLength: 32		Identidad del controlador que ejecutará este paso. Obligatorio si el tipo de paso está insertado.
handlerProperties			Parámetros que se van a pasar al controlador durante la ejecución.
type	StepType	inline	Tipo de paso.
updateId	UpdateId		Identidad de actualización secundaria a la que se hace referencia. Obligatorio si se hace referencia al tipo de paso.

StepType

Enumeración

Tipo de paso.

Valor	Description
inline	Tipo de paso que realiza la ejecución del código.
reference	Tipo de paso que instala otra actualización.

Update

Objeto

Actualizar metadatos.

Nombre	Tipo	Valor predeterminado	Description
compatibility	object[]		Lista de información de compatibilidad de actualizaciones.
createdDateTime	string (date-time)		Fecha y hora en UTC cuando se creó la actualización.
description	string minLength: 1 maxLength: 512		Actualice la descripción especificada por el creador.
etag	string		Actualizar ETag.
friendlyName	string minLength: 1 maxLength: 512		Nombre de actualización descriptivo especificado por el importador.
importedDateTime	string (date-time)		Fecha y hora en UTC cuando se importó la actualización.
installedCriteria	string		Cadena interpretada por el cliente de Device Update para determinar si la actualización está instalada en el dispositivo. En desuso en el esquema de manifiesto de importación más reciente.
instructions	Instructions		Actualice las instrucciones de instalación.
isDeployable	boolean	True	Si la actualización se puede implementar en un dispositivo por su cuenta.
manifestVersion	string		Versión de esquema del manifiesto usado para importar la actualización.
referencedBy	UpdateId[]		Lista de identidades de actualización que hacen referencia a esta actualización.
scanResult	string		Actualizar el resultado del examen agregado (calculado a partir de los resultados del examen de archivos de carga).
updateId	UpdateId		Actualizar identidad.
updateType	string		Tipo de actualización. En desuso en el esquema de manifiesto de importación más reciente.

UpdateId

Objeto

Identificador de actualización.

Nombre	Tipo	Description
name	string	Nombre de actualización.
provider	string	Actualizar proveedor.
version	string	Actualizar versión.