Device Update - Get Operation Status

サービス:

Device Update

API バージョン:

2022-10-01

操作の状態を取得します。

GET https://{endpoint}/deviceUpdate/{instanceId}/updates/operations/{operationId}?api-version=2022-10-01

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string url	IoT Hub アカウント エンドポイントの Device Update (ホスト名のみ、プロトコルなし)。
instanceId	path	True	string	IoT Hub アカウント インスタンス識別子の Device Update。
operationId	path	True	string	操作識別子。
api-version	query	True	string	クライアント要求で使用される API のバージョン。

要求ヘッダー

名前	必須	型	説明
If-None-Match		string	If-None-Match 条件を定義します。 操作は、サーバー上の ETag がこの値と一致しない場合にのみ実行されます。

応答

名前	型	説明
200 OK	UpdateOperation	操作の状態。 ヘッダー Retry-After: string
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_GetOperationStatus

要求のサンプル

HTTP

GET https://contoso.api.adu.microsoft.com/deviceUpdate/blue/updates/operations/e4491c54-916f-443d-9094-bcca546ace2f?api-version=2022-10-01

応答のサンプル

状態コード:

200

{
  "operationId": "e4491c54-916f-443d-9094-bcca546ace2f",
  "status": "Succeeded",
  "update": {
    "updateId": {
      "provider": "microsoft",
      "name": "adu",
      "version": "1.0.0.0"
    },
    "friendlyName": "Microsoft ADU v1"
  },
  "resourceLocation": "/deviceUpdate/blue/updates/providers/microsoft/names/adu/versions/1.0.0.0?api-version=2022-10-01",
  "traceId": "2b881ef9deaf5d45b0a716ca5b4145ec",
  "createdDateTime": "2020-04-22T21:00:53.2548897+00:00",
  "lastActionDateTime": "2020-04-22T21:01:43.9401420+00:00",
  "etag": "\"a0f7b6f2-3f6c-4eb6-8a59-2f5411c23888\""
}

定義

名前	説明
Error	エラーの詳細。
ErrorResponse	一般的なエラー応答。
InnerError	エラーに関する現在のオブジェクトよりも具体的な情報を含む オブジェクト。
OperationStatus	操作の状態。
UpdateId	識別子を更新します。
UpdateInfo	情報を更新します。
UpdateOperation	操作メタデータ。

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	エラーの人間が判読できる表現。

OperationStatus

操作の状態。

名前	型	説明
Failed	string	バックグラウンド操作が失敗して終了しました。
NotStarted	string	バックグラウンド操作は作成されましたが、まだ開始されていません。
Running	string	バックグラウンド操作は現在実行中です。
Succeeded	string	バックグラウンド操作は成功して終了しました。

UpdateId

識別子を更新します。

名前	型	説明
name	string	更新名。
provider	string	更新プロバイダー。
version	string	バージョンを更新します。

UpdateInfo

情報を更新します。

名前	型	説明
description	string	説明を更新します。
friendlyName	string	フレンドリ更新プログラムの名前。
updateId	UpdateId	識別子を更新します。

UpdateOperation

操作メタデータ。

名前	型	説明
createdDateTime	string	操作が作成された UTC の日付と時刻。
error	Error	操作エラーが発生しました (存在する場合)。
etag	string	操作 ETag。
lastActionDateTime	string	操作の状態が最後に更新された日時 (UTC)。
operationId	string	操作 ID です。
resourceLocation	string	操作が成功したときのインポートされた更新プログラムの場所。
status	OperationStatus	操作の状態。
traceId	string	Microsoft サポートでトラブルシューティングに使用できる操作の関連付け ID。
update	UpdateInfo	インポートまたは削除される更新プログラム。 インポートの場合、このプロパティはインポート マニフェストが正常に処理された後にのみ設定されます。