Updates - Get Operations

Служба:

Device Update

Версия API:

2020-09-01

Получение списка всех операций обновления импорта. Завершенные операции хранятся в течение 7 дней перед автоматическим удалением. Эта версия API не возвращает операции удаления.

GET https://{accountEndpoint}/deviceupdate/{instanceId}/v2/updates/operations

С использованием необязательных параметров:

GET https://{accountEndpoint}/deviceupdate/{instanceId}/v2/updates/operations?$filter={$filter}&$top={$top}

Параметры URI

Имя	В	Обязательно	Тип	Описание
accountEndpoint	path	True	string	Конечная точка учетной записи.
instanceId	path	True	string	Идентификатор экземпляра учетной записи.
$filter	query		string	Ограничивает набор возвращаемых операций. Поддерживается только один конкретный фильтр: status eq 'NotStarted' или status eq 'Running'"
$top	query		integer int32	Задает неотрицательное целое число n, которое ограничивает количество элементов, возвращаемых из коллекции. Служба возвращает количество доступных элементов, не превышающее указанное значение n.

Ответы

Имя	Тип	Описание
200 OK	PageableListOfOperations	Сведения об операции.
429 Too Many Requests		Слишком много запросов; существует ограничение скорости на количество операций, которые могут быть выполнены в течение определенного периода времени.

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

azure_auth_implicit

Неявный поток OAuth2 в Azure Active Directory

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

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

azure_auth_code

Поток кода доступа OAuth2 Для Azure Active Directory

Тип: oauth2
Flow: accessCode
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
URL-адрес токена: https://login.microsoftonline.com/common/oauth2/v2.0/token

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

azure_auth_application

Поток приложений OAuth2 в Azure Active Directory

Тип: oauth2
Flow: application
URL-адрес токена: https://login.microsoftonline.com/common/oauth2/v2.0/token

Области

Имя	Описание
.default	область учетных данных клиента

azure_auth_password

Поток паролей OAuth2 в Azure Active Directory

Тип: oauth2
Flow: password
URL-адрес токена: https://login.microsoftonline.com/common/oauth2/v2.0/token

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

Updates_GetOperations

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

HTTP

GET https://contoso.api.adu.microsoft.com/deviceupdate/blue/v2/updates/operations

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

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

200

{
  "value": [
    {
      "operationId": "e4491c54-916f-443d-9094-bcca546ace2f",
      "status": "Succeeded",
      "resourceLocation": "/v2/updates/providers/microsoft/names/adu/versions/1.0.0.0",
      "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\""
    }
  ]
}

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

429

Определения

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

Error

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

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

InnerError

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

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

Operation

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

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

OperationStatus

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

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

PageableListOfOperations

Список операций с поддержкой разбиения по страницам сервера.

Имя	Тип	Описание
nextLink	string	Ссылка на следующую страницу элементов.
value	Operation[]	Коллекция доступных для страниц элементов.

UpdateId

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

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