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 パラメーター

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

要求ヘッダー

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

応答

名前	型	説明
200 OK	UpdateFile	要求されたファイルエンティティ。
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_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\""
}

定義

名前	説明
Error	エラーの詳細。
ErrorResponse	一般的なエラー応答。
InnerError	エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。
UpdateFile	ファイルメタデータを更新します。
UpdateFileBase	ファイルの基本的なメタデータを更新します。
UpdateFileDownloadHandler	関連ファイルを利用してペイロードファイルをダウンロードするためのダウンロードハンドラー。

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

UpdateFile

ファイルメタデータを更新します。

名前	型	説明
downloadHandler	UpdateFileDownloadHandler	関連ファイルを利用してペイロードファイルをダウンロードするためのオプションのダウンロードハンドラー。
etag	string	ファイル ETag。
fileId	string	インポート時にサーバーによって生成されるファイル ID。
fileName	string	ファイル名。
hashes	object	base64 でエンコードされたハッシュ値へのハッシュアルゴリズムのマッピング。
mimeType	string	ファイル MIME の種類。
properties	object	オプションのファイルプロパティ (サービスでは使用されませんが、デバイスへのパススルー)。
relatedFiles	UpdateFileBase[]	オプションの関連ファイルメタデータが DownloadHandler メタデータと共に使用され、ペイロードファイルがダウンロードされます。
scanDetails	string	マルウェア対策スキャンの詳細。
scanResult	string	マルウェア対策スキャンの結果。
sizeInBytes	integer	ファイルサイズ (バイト数)。

UpdateFileBase

ファイルの基本的なメタデータを更新します。

名前	型	説明
fileName	string	ファイル名。
hashes	object	base64 でエンコードされたハッシュ値へのハッシュアルゴリズムのマッピング。
mimeType	string	ファイル MIME の種類。
properties	object	オプションのファイルプロパティ (サービスでは使用されませんが、デバイスへのパススルー)。
scanDetails	string	マルウェア対策スキャンの詳細。
scanResult	string	マルウェア対策スキャンの結果。
sizeInBytes	integer	ファイルサイズ (バイト数)。

UpdateFileDownloadHandler

関連ファイルを利用してペイロードファイルをダウンロードするためのダウンロードハンドラー。

名前	型	説明
id	string	ハンドラー識別子をダウンロードします。

次の方法で共有