Device Update - Get Operation Status

Servicio:

Device Update

Versión de la API:

2022-10-01

Recupere el estado de la operación.

GET https://{endpoint}/deviceUpdate/{instanceId}/updates/operations/{operationId}?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.
operationId	path	True	string	Identificador de operació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	UpdateOperation	Estado de la operación. Encabezados Retry-After: string
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_GetOperationStatus

Solicitud de ejemplo

HTTP

GET https://contoso.api.adu.microsoft.com/deviceUpdate/blue/updates/operations/e4491c54-916f-443d-9094-bcca546ace2f?api-version=2022-10-01

Respuesta de muestra

status code:

200

{
  "operationId": "e4491c54-916f-443d-9094-bcca546ace2f",
  "status": "Succeeded",
  "update": {
    "updateId": {
      "provider": "microsoft",
      "name": "adu",
      "version": "1.0.0.0"
    },
    "friendlyName": "Microsoft ADU v1"
  },
  "resourceLocation": "/deviceUpdate/blue/updates/providers/microsoft/names/adu/versions/1.0.0.0?api-version=2022-10-01",
  "traceId": "2b881ef9deaf5d45b0a716ca5b4145ec",
  "createdDateTime": "2020-04-22T21:00:53.2548897+00:00",
  "lastActionDateTime": "2020-04-22T21:01:43.9401420+00:00",
  "etag": "\"a0f7b6f2-3f6c-4eb6-8a59-2f5411c23888\""
}

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.
OperationStatus	Estado de la operación.
UpdateId	Identificador de actualización.
UpdateInfo	Actualizar información.
UpdateOperation	Metadatos de la operació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.

OperationStatus

Estado de la operación.

Nombre	Tipo	Description
Failed	string	La operación en segundo plano finalizó con un error.
NotStarted	string	Operación en segundo plano creada pero no iniciada todavía.
Running	string	La operación en segundo plano se está ejecutando actualmente.
Succeeded	string	La operación en segundo plano finalizó correctamente.

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.

UpdateInfo

Actualizar información.

Nombre	Tipo	Description
description	string	Descripción de la actualización.
friendlyName	string	Nombre de actualización descriptivo.
updateId	UpdateId	Identificador de actualización.

UpdateOperation

Metadatos de la operación.

Nombre	Tipo	Description
createdDateTime	string	Fecha y hora en UTC cuando se creó la operación.
error	Error	Error de operación detectado, si existe.
etag	string	Operación ETag.
lastActionDateTime	string	Fecha y hora en UTC en que se actualizó por última vez el estado de la operación.
operationId	string	Identificador de operación.
resourceLocation	string	Ubicación de la actualización importada cuando la operación se realiza correctamente.
status	OperationStatus	Estado de la operación.
traceId	string	Identidad de correlación de operaciones que puede usar Soporte técnico de Microsoft para solucionar problemas.
update	UpdateInfo	Actualización que se va a importar o eliminar. Para la importación, esta propiedad solo se rellenará después de que el manifiesto de importación se procese correctamente.