Device Update - List Updates

Servicio:: Device Update

Versión de la API:: 2022-10-01

Obtenga una lista de todas las actualizaciones que se han importado a Device Update para IoT Hub.

GET https://{endpoint}/deviceUpdate/{instanceId}/updates?api-version=2022-10-01

Con parámetros opcionales:

GET https://{endpoint}/deviceUpdate/{instanceId}/updates?api-version=2022-10-01&search={search}&filter={filter}

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	Versión de la API que se va a usar con la solicitud de cliente.
filter	query		string	Opcional para filtrar las actualizaciones por propiedad isDeployable.
search	query		string	Solicitar actualizaciones que coincidan con una expresión de búsqueda de texto libre.

Respuestas

Nombre	Tipo	Description
200 OK	UpdateList	Todas las actualizaciones importadas o una lista vacía si no hay ninguna.
Other Status Codes	ErrorResponse	Respuesta predeterminada.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

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	Ámbito de autorización predeterminado.

Ejemplos

DeviceUpdate_ListUpdates

Solicitud de ejemplo

HTTP

GET https://contoso.api.adu.microsoft.com/deviceUpdate/blue/updates?api-version=2022-10-01

Respuesta de muestra

status code:: 200

{
  "value": [
    {
      "updateId": {
        "provider": "microsoft",
        "name": "adu",
        "version": "1.0.0.0"
      },
      "description": "Example update.",
      "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-22T21:01:43.8408797+00:00",
      "createdDateTime": "2019-09-12T00:00:00.0000000+00:00",
      "etag": "\"3fed3378-0c67-47d2-b796-296962c66cbb\""
    }
  ]
}

Definiciones

Nombre	Description
Error	Detalles del error.
ErrorResponse	Respuesta de error común.
InnerError	Objeto que contiene información más específica que el objeto actual sobre el error.
Instructions
Step	Actualice el paso de instrucción de instalación.
StepType	Tipo de paso.
Update	Actualizar metadatos.
UpdateId	Identificador de actualización.
UpdateList	Lista de actualizaciones.

Error

Object

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	Representación legible del error.
occurredDateTime	string (date-time)	Fecha y hora en UTC cuando se produjo el error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error común.

Nombre	Tipo	Description
error	Error	Detalles del error.

InnerError

Object

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	Representación legible del error.

Instructions

Object

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

Step

Object

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	object		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
reference

Update

Object

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

Object

Identificador de actualización.

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

UpdateList

Object

Lista de actualizaciones.

Nombre	Tipo	Description
nextLink	string	Vínculo a la página siguiente de elementos.
value	Update[]	Colección de elementos paginables.

Compartir a través de

Device Update - List Updates

Parámetros de identificador URI

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

DeviceUpdate_ListUpdates

Solicitud de ejemplo

Respuesta de muestra

Definiciones

Error

ErrorResponse

InnerError

Instructions

Step

StepType

Update

UpdateId

UpdateList