Device Update - List Updates

Служба:: Device Update

Версия API:: 2022-10-01

Получите список всех обновлений, импортированных в центр Интернета вещей.

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

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

GET https://{endpoint}/deviceUpdate/{instanceId}/updates?api-version=2022-10-01&search={search}&filter={filter}

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string (url)	Конечная точка учетной записи Центра Интернета вещей (только имя узла, протокол отсутствует).
instanceId	path	True	string	Идентификатор экземпляра учетной записи Центра Интернета вещей.
api-version	query	True	string	Версия API для использования с клиентским запросом.
filter	query		string	Необязательно фильтровать обновления по свойству IsDeployable.
search	query		string	Запрос обновлений, соответствующих выражению поиска свободного текста.

Ответы

Имя	Тип	Описание
200 OK	UpdateList	Все импортированные обновления или пустой список, если нет.
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_ListUpdates

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

HTTP

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

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

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

{
  "value": [
    {
      "updateId": {
        "provider": "microsoft",
        "name": "adu",
        "version": "1.0.0.0"
      },
      "description": "Example update.",
      "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\""
    }
  ]
}

Определения

Имя	Описание
Error	Сведения об ошибке.
ErrorResponse	Распространенный ответ на ошибку.
InnerError	Объект, содержащий более конкретные сведения, чем текущий объект об ошибке.
Instructions
Step	Обновление шага инструкции установки.
StepType	Тип шага.
Update	Обновление метаданных.
UpdateId	Идентификатор обновления.
UpdateList	Список обновлений.

Error

Object

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

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

ErrorResponse

Object

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

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

InnerError

Object

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

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

Instructions

Object

Имя	Тип	Описание
steps	Step[]	Коллекция шагов установки.

Step

Object

Обновление шага инструкции установки.

Имя	Тип	Default value	Описание
description	string minLength: 1 maxLength: 64		Описание шага.
files	string[]		Коллекция имен файлов, передаваемых обработчику во время выполнения. Требуется, если тип шага является встроенным.
handler	string minLength: 1 maxLength: 32		Удостоверение обработчика, выполняющего этот шаг. Требуется, если тип шага является встроенным.
handlerProperties	object		Параметры, передаваемые обработчику во время выполнения.
type	StepType	inline	Тип шага.
updateId	UpdateId		Ссылка на удостоверение дочернего обновления. Требуется, если тип шага является ссылкой.

StepType

Перечисление

Тип шага.

Значение	Описание
inline
reference

Update

Object

Обновление метаданных.

Имя	Тип	Default value	Описание
compatibility	object[]		Список сведений о совместимости обновлений.
createdDateTime	string (date-time)		Дата и время в формате UTC при создании обновления.
description	string minLength: 1 maxLength: 512		Обновление описания, указанного создателем.
etag	string		Обновление ETag.
friendlyName	string minLength: 1 maxLength: 512		Понятное имя обновления, указанное импортом.
importedDateTime	string (date-time)		Дата и время в формате UTC при импорте обновления.
installedCriteria	string		Строка, интерпретируемая клиентом центра обновления устройств, чтобы определить, установлено ли обновление на устройстве. Не рекомендуется использовать последнюю схему манифеста импорта.
instructions	Instructions		Обновление инструкций по установке.
isDeployable	boolean	True	Может ли обновление быть развернуто на устройстве самостоятельно.
manifestVersion	string		Версия манифеста схемы, используемая для импорта обновления.
referencedBy	UpdateId[]		Список удостоверений обновления, ссылающихся на это обновление.
scanResult	string		Обновите статистический результат сканирования (вычисляется из результатов сканирования полезных данных).
updateId	UpdateId		Обновление удостоверения.
updateType	string		Тип обновления. Не рекомендуется использовать последнюю схему манифеста импорта.

UpdateId

Object

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

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

UpdateList

Object

Список обновлений.

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

Поделиться через

Device Update - List Updates

Параметры URI

Ответы

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

azure_auth

Области

Примеры

DeviceUpdate_ListUpdates

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

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

Определения

Error

ErrorResponse

InnerError

Instructions

Step

StepType

Update

UpdateId

UpdateList