Device Update - Get Update

Referencia

Servicio:: Device Update

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

Obtenga una versión de actualización específica.

GET https://{endpoint}/deviceUpdate/{instanceId}/updates/providers/{provider}/names/{name}/versions/{version}?api-version=2022-10-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string url	Device Update para IoT Hub punto de conexión de la cuenta (solo nombre de host, sin protocolo).
instanceId	path	True	string	Device Update para IoT Hub identificador de instancia de cuenta.
name	path	True	string	Nombre de actualización.
provider	path	True	string	Proveedor de actualización.
version	path	True	string	Actualice la versión.
api-version	query	True	string	Versión de la API que se va a usar con la solicitud de cliente.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
If-None-Match		string	Define la condición If-None-Match. La operación solo se realizará si la ETag del servidor no coincide con este valor.

Respuestas

Nombre	Tipo	Description
200 OK	Update	Versión de actualización solicitada.
Other Status Codes	ErrorResponse	Respuesta predeterminada.

Seguridad

azure_auth

Flujo 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_GetUpdate

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

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-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 instrucciones de instalación.
StepType	Tipo de paso.
Update	Actualizar metadatos.
UpdateId	Identificador de actualización.

Error

Detalles del error.

Nombre	Tipo	Description
code	string	Código de error definido por el servidor.
details	Error[]	Matriz de errores que provocó el 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	Fecha y hora en UTC cuando se produjo el error.
target	string	Destino del error.

ErrorResponse

Respuesta de error común.

Nombre	Tipo	Description
error	Error	Los detalles del error.

InnerError

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

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

Step

Actualice el paso de instrucciones de instalación.

Nombre	Tipo	Valor predeterminado	Description
description	string		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		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

Tipo de paso.

Nombre	Tipo	Description
inline	string
reference	string

Update

Actualizar metadatos.

Nombre	Tipo	Valor predeterminado	Description
compatibility	object[]		Lista de información de compatibilidad de actualizaciones.
createdDateTime	string		Fecha y hora en UTC cuando se creó la actualización.
description	string		Actualice la descripción especificada por creator.
etag	string		Actualice ETag.
friendlyName	string		Nombre de actualización descriptivo especificado por el importador.
importedDateTime	string		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 sí misma.
manifestVersion	string		Versión de esquema del manifiesto que se usa 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 del archivo de carga).
updateId	UpdateId		Identidad de actualización.
updateType	string		Tipo de actualización. En desuso en el esquema de manifiesto de importación más reciente.

UpdateId

Identificador de actualización.

Nombre	Tipo	Description
name	string	Nombre de actualización.
provider	string	Proveedor de actualización.
version	string	Actualice la versión.

Compartir a través de