Device Update - List Operation Statuses
Obtenga una lista de todas las operaciones de actualización de importación. Las operaciones completadas se conservan durante 7 días antes de eliminarse automáticamente. Esta versión de API no devuelve las operaciones de eliminación.
GET https://{endpoint}/deviceUpdate/{instanceId}/updates/operations?api-version=2022-10-01
GET https://{endpoint}/deviceUpdate/{instanceId}/updates/operations?filter={filter}&top={top}&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). |
instance
|
path | True |
string |
Device Update para IoT Hub identificador de instancia de cuenta. |
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 operaciones por propiedad status. Solo se admite un filtro específico: "status eq 'NotStarted' o status eq 'Running'" |
|
top
|
query |
integer int32 |
Especifica un entero no negativo n que limita el número de elementos devueltos de una colección. El servicio devuelve el número de elementos disponibles hasta pero no mayor que el valor especificado n. |
Respuestas
Nombre | Tipo | Description |
---|---|---|
200 OK |
Detalles de la operación. |
|
Other Status Codes |
Respuesta predeterminada. |
Seguridad
azure_auth
Flujo OAuth2 de Azure Active Directory
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nombre | Description |
---|---|
https://api.adu.microsoft.com/.default | Ámbito de autorización predeterminado. |
Ejemplos
DeviceUpdate_ListOperationStatuses
Sample Request
GET https://contoso.api.adu.microsoft.com/deviceUpdate/blue/updates/operations?api-version=2022-10-01
Sample Response
{
"value": [
{
"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. |
Error |
Respuesta de error común. |
Inner |
Objeto que contiene información más específica que el objeto actual sobre el error. |
Operation |
Estado de la operación. |
Update |
Identificador de actualización. |
Update |
Actualizar información. |
Update |
Metadatos de la operación. |
Update |
Lista de operaciones con compatibilidad con la paginación del servidor. |
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 |
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 |
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 |
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 |
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 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 |
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 |
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. |
UpdateOperationsList
Lista de operaciones con compatibilidad con la paginación del servidor.
Nombre | Tipo | Description |
---|---|---|
nextLink |
string |
Vínculo a la página siguiente de elementos. |
value |
Colección de elementos paginables. |