Device Update - Get Update

Ссылка

Служба:: Device Update

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

Получение определенной версии обновления.

GET https://{endpoint}/deviceUpdate/{instanceId}/updates/providers/{provider}/names/{name}/versions/{version}?api-version=2022-10-01

Параметры URI

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

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

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

Ответы

Имя	Тип	Описание
200 OK	Update	Запрошенная версия обновления.
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_GetUpdate

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

HTTP

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

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

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

{
  "updateId": {
    "provider": "microsoft",
    "name": "adu",
    "version": "1.0.0.0"
  },
  "friendlyName": "Lab Sensor Update v1",
  "description": "Fix for critical vulnerability",
  "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	Идентификатор обновления.

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	Удобочитаемое представление ошибки.

Instructions

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

Step

Шаг инструкции по установке обновления.

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

StepType

Тип шага.

Имя	Тип	Описание
inline	string
reference	string

Update

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

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

UpdateId

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

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

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