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

名稱	位於	必要	類型	Description
endpoint	path	True	string url	僅限主機名 (IoT 中樞 帳戶端點的裝置更新，沒有通訊協定) 。
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	Update	要求的更新版本。
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_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\""
}

定義

名稱	Description
Error	錯誤詳細數據。
ErrorResponse	常見的錯誤回應。
InnerError	物件，包含比目前對象有關錯誤更具體的資訊。
Instructions
Step	更新安裝指示步驟。
StepType	步驟類型。
Update	更新元數據。
UpdateId	更新標識碼。

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	人類可讀取的錯誤表示法。

Instructions

名稱	類型	Description
steps	Step[]	安裝步驟的集合。

Step

更新安裝指示步驟。

名稱	類型	預設值	Description
description	string		步驟描述。
files	string[]		在執行期間要傳遞至處理程式的檔名集合。 如果步驟類型為內嵌，則為必要專案。
handler	string		將執行此步驟之處理程式的身分識別。 如果步驟類型為內嵌，則為必要專案。
handlerProperties	object		執行期間要傳遞至處理程序的參數。
type	StepType	inline	步驟類型。
updateId	UpdateId		參考的子更新身分識別。 如果步驟類型為參考，則為必要專案。

StepType

步驟類型。

名稱	類型	Description
inline	string
reference	string

Update

更新元數據。

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

更新標識碼。

名稱	類型	Description
name	string	更新名稱。
provider	string	更新提供者。
version	string	更新版本。