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 參數

名稱	位於	必要	類型	Description
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 版本。

要求標頭

名稱	必要	類型	Description
If-None-Match		string	定義 If-None-Match 條件。只有在伺服器上的 ETag 不符合此值時，才會執行作業。

回應

名稱	類型	Description
200 OK	UpdateFile	要求的檔案實體。
Other Status Codes	ErrorResponse	默認回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
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\""
}

定義

名稱	Description
Error	錯誤詳細數據。
ErrorResponse	常見的錯誤回應。
InnerError	物件，包含比目前對象有關錯誤的更特定資訊。
UpdateFile	更新檔案元數據。
UpdateFileBase	更新檔案基本元數據。
UpdateFileDownloadHandler	用來利用相關檔案下載承載檔案的下載處理程式。

Error

錯誤詳細數據。

名稱	類型	Description
code	string	伺服器定義的錯誤碼。
details	Error[]	導致回報錯誤的錯誤陣列。
innererror	InnerError	物件，包含比目前對象有關錯誤的更特定資訊。
message	string	人類看得懂的錯誤表示法。
occurredDateTime	string	發生錯誤的 UTC 日期和時間。
target	string	錯誤的目標。

ErrorResponse

常見的錯誤回應。

名稱	類型	Description
error	Error	錯誤詳細資料。

InnerError

物件，包含比目前對象有關錯誤的更特定資訊。

名稱	類型	Description
code	string	比包含錯誤所提供的錯誤碼更具體。
errorDetail	string	內部錯誤或例外狀況訊息。
innerError	InnerError	物件，包含比目前對象有關錯誤的更特定資訊。
message	string	人類看得懂的錯誤表示法。

UpdateFile

更新檔案元數據。

名稱	類型	Description
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

更新檔案基本元數據。

名稱	類型	Description
fileName	string	檔案名稱
hashes	object	哈希演算法與base64編碼哈希值的對應。
mimeType	string	檔案MIME類型。
properties	object	選擇性檔案屬性 (服務未取用，但傳遞至裝置) 。
scanDetails	string	反惡意代碼掃描詳細數據。
scanResult	string	反惡意代碼掃描結果。
sizeInBytes	integer	檔案大小 (以位元組數為單位)。

UpdateFileDownloadHandler

用來利用相關檔案下載承載檔案的下載處理程式。

名稱	類型	Description
id	string	下載處理程式識別碼。

共用方式為