次の方法で共有


Device Update - List Updates

IoT Hubの Device Update にインポートされたすべての更新プログラムの一覧を取得します。

GET https://{endpoint}/deviceUpdate/{instanceId}/updates?api-version=2022-10-01
GET https://{endpoint}/deviceUpdate/{instanceId}/updates?api-version=2022-10-01&search={search}&filter={filter}

URI パラメーター

名前 / 必須 説明
endpoint
path True

string

url

IoT Hub アカウント エンドポイントの Device Update (ホスト名のみ、プロトコルなし)。

instanceId
path True

string

IoT Hub アカウント インスタンス識別子の Device Update。

api-version
query True

string

クライアント要求で使用される API のバージョン。

filter
query

string

isDeployable プロパティで更新プログラムをフィルター処理する場合は省略可能です。

search
query

string

自由テキスト検索式に一致する更新を要求します。

応答

名前 説明
200 OK

UpdateList

インポートされたすべての更新プログラム。存在しない場合は空のリスト。

Other Status Codes

ErrorResponse

既定の応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前 説明
https://api.adu.microsoft.com/.default 既定の承認スコープ。

DeviceUpdate_ListUpdates

要求のサンプル

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

応答のサンプル

{
  "value": [
    {
      "updateId": {
        "provider": "microsoft",
        "name": "adu",
        "version": "1.0.0.0"
      },
      "description": "Example update.",
      "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

識別子を更新します。

UpdateList

更新プログラムの一覧。

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

インストール手順を更新します。

名前 規定値 説明
description

string

手順の説明。

files

string[]

実行中にハンドラーに渡されるファイル名のコレクション。 ステップの種類がインラインの場合は必須です。

handler

string

この手順を実行するハンドラーの ID。 ステップの種類がインラインの場合は必須です。

handlerProperties

object

実行中にハンドラーに渡されるパラメーター。

type

StepType

inline

ステップの種類。

updateId

UpdateId

子更新 ID を参照しました。 ステップの種類が参照の場合は必須。

StepType

ステップの種類。

名前 説明
inline

string

reference

string

Update

メタデータを更新します。

名前 規定値 説明
compatibility

object[]

更新プログラムの互換性情報の一覧。

createdDateTime

string

更新が作成された UTC の日付と時刻。

description

string

作成者が指定した説明を更新します。

etag

string

ETag を更新します。

friendlyName

string

インポーターによって指定されたフレンドリ更新プログラム名。

importedDateTime

string

更新プログラムがインポートされた UTC の日付と時刻。

installedCriteria

string

更新プログラムがデバイスにインストールされているかどうかを判断するために、Device Update クライアントによって解釈される文字列。 最新のインポート マニフェスト スキーマでは非推奨です。

instructions

Instructions

インストール手順を更新します。

isDeployable

boolean

True

更新プログラムをデバイスに単独で展開できるかどうか。

manifestVersion

string

更新プログラムのインポートに使用されるマニフェストのスキーマ バージョン。

referencedBy

UpdateId[]

この更新プログラムを参照する更新プログラム ID の一覧。

scanResult

string

集計スキャン結果を更新します (ペイロード ファイルのスキャン結果から計算されます)。

updateId

UpdateId

更新プログラム ID。

updateType

string

更新の種類。 最新のインポート マニフェスト スキーマでは非推奨です。

UpdateId

識別子を更新します。

名前 説明
name

string

更新名。

provider

string

更新プロバイダー。

version

string

バージョンを更新します。

UpdateList

更新プログラムの一覧。

名前 説明
nextLink

string

アイテムの次のページへのリンク。

value

Update[]

ページング可能な項目のコレクション。