你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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	IoT 中心帐户的设备更新终结点仅 (主机名，不) 协议。
fileId	path	True	string	文件标识符。
instanceId	path	True	string	IoT 中心帐户实例标识符的设备更新。
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

Azure Active Directory OAuth2 流

类型: oauth2
流向: 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	下载处理程序标识符。

通过