Device Update - Get File

Ссылка

Служба:: Device Update

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

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

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string url	Обновление устройства для конечной точки Центр Интернета вещей учетной записи (только имя узла, без протокола).
fileId	path	True	string	Идентификатор файла.
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	UpdateFile	Запрошенная сущность файла.
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_GetFile

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

HTTP

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

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

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

{
  "fileId": "abc123",
  "fileName": "1v5uww1q.my2",
  "sizeInBytes": 1862311,
  "hashes": {
    "sha256": "OVokcktf61lQXs17MzJCsM98lk48H1Wu1hy7Sp6lLfI="
  },
  "mimeType": "application/BuildAsync-s4jwikgq.44h",
  "etag": "\"26bd8eba-4bb2-4960-a357-ca4d60b5fb4b\""
}

Определения

Имя	Описание
Error	Сведения об ошибке.
ErrorResponse	Распространенные ответы об ошибках.
InnerError	Объект, содержащий более конкретные сведения об ошибке, чем текущий объект.
UpdateFile	Обновление метаданных файла.
UpdateFileBase	Обновление основных метаданных файла.
UpdateFileDownloadHandler	Обработчик загрузки для использования связанных файлов для скачивания файла полезных данных.

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

UpdateFile

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

Имя	Тип	Описание
downloadHandler	UpdateFileDownloadHandler	Необязательный обработчик загрузки для использования связанных файлов для скачивания файла полезных данных.
etag	string	ETag файла.
fileId	string	Удостоверение файла, созданное сервером во время импорта.
fileName	string	Имя файла.
hashes	object	Сопоставление алгоритма хэширования с хэш-значениями в кодировке Base64.
mimeType	string	Тип MIME файла.
properties	object	Необязательные свойства файла (не используются службой, но передаются на устройство).
relatedFiles	UpdateFileBase[]	Необязательные метаданные связанных файлов, используемые вместе с метаданными DownloadHandler для скачивания файла полезных данных.
scanDetails	string	Сведения о проверке защиты от вредоносных программ.
scanResult	string	Результат сканирования защиты от вредоносных программ.
sizeInBytes	integer	Размер файла в байтах.

UpdateFileBase

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

Имя	Тип	Описание
fileName	string	Имя файла.
hashes	object	Сопоставление алгоритма хэширования с хэш-значениями в кодировке Base64.
mimeType	string	Тип MIME файла.
properties	object	Необязательные свойства файла (не используются службой, но передаются на устройство).
scanDetails	string	Сведения о проверке защиты от вредоносных программ.
scanResult	string	Результат сканирования защиты от вредоносных программ.
sizeInBytes	integer	Размер файла в байтах.

UpdateFileDownloadHandler

Обработчик загрузки для использования связанных файлов для скачивания файла полезных данных.

Имя	Тип	Описание
id	string	Идентификатор обработчика загрузки.

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