Updates - Get Operation

リファレンス

サービス:: Device Update

API バージョン:: 2020-09-01

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

GET https://{accountEndpoint}/deviceupdate/{instanceId}/v2/updates/operations/{operationId}

URI パラメーター

名前	/	必須	型	説明
accountEndpoint	path	True	string	アカウントエンドポイント。
instanceId	path	True	string	アカウントインスタンス識別子。
operationId	path	True	string	操作識別子。

要求ヘッダー

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

応答

名前	型	説明
200 OK	Operation	操作の状態。ヘッダー Retry-After: string
404 Not Found		見つかりません。
429 Too Many Requests		要求が多すぎます。期間内に実行できる操作の数にはレート制限があります。
Other Status Codes		変更されません。

セキュリティ

azure_auth_implicit

Azure Active Directory OAuth2 暗黙的フロー

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

スコープ

名前	説明
user_impersonation	ユーザーアカウントの借用

azure_auth_code

Azure Active Directory OAuth2 AccessCode フロー

型: oauth2
フロー: accessCode
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Token URL (トークン URL): https://login.microsoftonline.com/common/oauth2/v2.0/token

スコープ

名前	説明
user_impersonation	ユーザーアカウントの借用

azure_auth_application

Azure Active Directory OAuth2 アプリケーションフロー

型: oauth2
フロー: application
Token URL (トークン URL): https://login.microsoftonline.com/common/oauth2/v2.0/token

スコープ

名前	説明
.default	クライアント資格情報スコープ

azure_auth_password

Azure Active Directory OAuth2 パスワードフロー

型: oauth2
フロー: password
Token URL (トークン URL): https://login.microsoftonline.com/common/oauth2/v2.0/token

スコープ

名前	説明
user_impersonation	ユーザーアカウントの借用

例

Updates_GetOperation

要求のサンプル

HTTP

GET https://contoso.api.adu.microsoft.com/deviceupdate/blue/v2/updates/operations/e4491c54-916f-443d-9094-bcca546ace2f

応答のサンプル

状態コード:: 200

{
  "operationId": "e4491c54-916f-443d-9094-bcca546ace2f",
  "status": "Succeeded",
  "resourceLocation": "/v2/updates/providers/microsoft/names/adu/versions/1.0.0.0",
  "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\""
}

状態コード:: 304

状態コード:: 404

状態コード:: 429

定義

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

Error

エラーの詳細。

名前	型	説明
code	string	サーバー定義のエラーコード。
details	Error[]	報告されたエラーの原因となったエラーの配列。
innererror	InnerError	エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。
message	string	エラーの人間が判読できる表現。
occurredDateTime	string	エラーが発生した UTC の日付と時刻。
target	string	エラーのターゲット。

InnerError

エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。

名前	型	説明
code	string	含まれているエラーによって提供されたものよりも具体的なエラーコード。
errorDetail	string	内部エラーまたは例外メッセージ。
innerError	InnerError	エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。
message	string	エラーの人間が判読できる表現。

Operation

操作メタデータ。

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

OperationStatus

操作の状態。

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

UpdateId

識別子を更新します。

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