Device Update - Get Operation Status

Служба:

Device Update

Версия API:

2022-10-01

Получение состояния операции.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string url	Обновление устройства для конечной точки Центр Интернета вещей учетной записи (только имя узла, без протокола).
instanceId	path	True	string	Обновление устройства для Центр Интернета вещей идентификатор экземпляра учетной записи.
operationId	path	True	string	Идентификатор операции.
api-version	query	True	string	Версия API для использования с клиентским запросом.

Заголовок запроса

Имя	Обязательно	Тип	Описание
If-None-Match		string	Определяет условие If-None-Match. Операция будет выполняться только в том случае, если ETag на сервере не соответствует этому значению.

Ответы

Имя	Тип	Описание
200 OK	UpdateOperation	Состояние операции. Заголовки Retry-After: string
Other Status Codes	ErrorResponse	Ответ по умолчанию.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
https://api.adu.microsoft.com/.default	Область авторизации по умолчанию.

Примеры

DeviceUpdate_GetOperationStatus

Образец запроса

HTTP

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

Пример ответа

Код состояния:

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

Определения

Имя	Описание
Error	Сведения об ошибке.
ErrorResponse	Распространенные ответы об ошибках.
InnerError	Объект, содержащий более конкретные сведения об ошибке, чем текущий объект.
OperationStatus	Состояние операции.
UpdateId	Идентификатор обновления.
UpdateInfo	Обновление сведений.
UpdateOperation	Метаданные операции.

Error

Сведения об ошибке.

Имя	Тип	Описание
code	string	Код ошибки, определяемый сервером.
details	Error[]	Массив ошибок, которые привели к сообщаемой ошибке.
innererror	InnerError	Объект, содержащий более конкретные сведения об ошибке, чем текущий объект.
message	string	Удобочитаемое представление ошибки.
occurredDateTime	string	Дата и время в формате UTC, когда произошла ошибка.
target	string	Цель ошибки.

ErrorResponse

Распространенные ответы об ошибках.

Имя	Тип	Описание
error	Error	Сведения об ошибке.

InnerError

Объект, содержащий более конкретные сведения об ошибке, чем текущий объект.

Имя	Тип	Описание
code	string	Более конкретный код ошибки, чем предоставленный содержащей ошибкой.
errorDetail	string	Внутреннее сообщение об ошибке или исключении.
innerError	InnerError	Объект, содержащий более конкретные сведения об ошибке, чем текущий объект.
message	string	Удобочитаемое представление ошибки.

OperationStatus

Состояние операции.

Имя	Тип	Описание
Failed	string	Фоновая операция завершилась ошибкой.
NotStarted	string	Фоновая операция создана, но еще не запущена.
Running	string	Фоновая операция в настоящее время выполняется.
Succeeded	string	Фоновая операция завершилась успешно.

UpdateId

Идентификатор обновления.

Имя	Тип	Описание
name	string	Имя обновления.
provider	string	Поставщик обновлений.
version	string	Обновление версии.

UpdateInfo

Обновление сведений.

Имя	Тип	Описание
description	string	Обновление описания.
friendlyName	string	Понятное имя обновления.
updateId	UpdateId	Идентификатор обновления.

UpdateOperation

Метаданные операции.

Имя	Тип	Описание
createdDateTime	string	Дата и время создания операции в формате UTC.
error	Error	Обнаружена ошибка операции, если она есть.
etag	string	ETag операции.
lastActionDateTime	string	Дата и время последнего обновления состояния операции в формате UTC.
operationId	string	Идентификатор операции.
resourceLocation	string	Расположение импортированного обновления при успешном выполнении операции.
status	OperationStatus	Состояние операции.
traceId	string	Удостоверение корреляции операций, которое может использоваться служба поддержки Майкрософт для устранения неполадок.
update	UpdateInfo	Импортируемое или удаляемое обновление. Для импорта это свойство будет заполнено только после успешной обработки манифеста импорта.