Device Update - Get File
버전에서 특정 업데이트 파일을 가져옵니다.
GET https://{endpoint}/deviceUpdate/{instanceId}/updates/providers/{provider}/names/{name}/versions/{version}/files/{fileId}?api-version=2022-10-01
URI 매개 변수
Name | In(다음 안에) | 필수 | 형식 | Description |
---|---|---|---|---|
endpoint
|
path | True |
string url |
IoT Hub 계정 엔드포인트에 대한 디바이스 업데이트(호스트 이름만, 프로토콜 없음). |
file
|
path | True |
string |
파일 식별자입니다. |
instance
|
path | True |
string |
IoT Hub 계정에 대한 디바이스 업데이트 instance 식별자입니다. |
name
|
path | True |
string |
이름을 업데이트합니다. |
provider
|
path | True |
string |
공급자를 업데이트합니다. |
version
|
path | True |
string |
버전을 업데이트합니다. |
api-version
|
query | True |
string |
클라이언트 요청과 함께 사용할 API의 버전입니다. |
요청 헤더
Name | 필수 | 형식 | Description |
---|---|---|---|
If-None-Match |
string |
If-None-Match 조건을 정의합니다. 서버의 ETag가 이 값과 일치하지 않는 경우에만 작업이 수행됩니다. |
응답
Name | 형식 | Description |
---|---|---|
200 OK |
요청된 파일 엔터티입니다. |
|
Other Status Codes |
기본 응답입니다. |
보안
azure_auth
Azure Active Directory OAuth2 Flow
형식:
oauth2
Flow:
implicit
권한 부여 URL:
https://login.microsoftonline.com/common/oauth2/authorize
범위
Name | Description |
---|---|
https://api.adu.microsoft.com/.default | 기본 권한 부여 scope. |
예제
DeviceUpdate_GetFile
샘플 요청
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
샘플 응답
{
"fileId": "abc123",
"fileName": "1v5uww1q.my2",
"sizeInBytes": 1862311,
"hashes": {
"sha256": "OVokcktf61lQXs17MzJCsM98lk48H1Wu1hy7Sp6lLfI="
},
"mimeType": "application/BuildAsync-s4jwikgq.44h",
"etag": "\"26bd8eba-4bb2-4960-a357-ca4d60b5fb4b\""
}
정의
Name | Description |
---|---|
Error |
오류 세부 정보입니다. |
Error |
일반적인 오류 응답입니다. |
Inner |
오류에 대한 현재 개체보다 더 구체적인 정보를 포함하는 개체입니다. |
Update |
파일 메타데이터를 업데이트합니다. |
Update |
파일 기본 메타데이터를 업데이트합니다. |
Update |
관련 파일을 활용하여 페이로드 파일을 다운로드하기 위한 처리기를 다운로드합니다. |
Error
오류 세부 정보입니다.
Name | 형식 | Description |
---|---|---|
code |
string |
서버에서 정의한 오류 코드입니다. |
details |
Error[] |
보고된 오류로 이어진 오류 배열입니다. |
innererror |
오류에 대한 현재 개체보다 더 구체적인 정보를 포함하는 개체입니다. |
|
message |
string |
사람이 읽을 수 있는 오류 표현입니다. |
occurredDateTime |
string |
오류가 발생한 날짜 및 시간(UTC)입니다. |
target |
string |
오류의 대상입니다. |
ErrorResponse
일반적인 오류 응답입니다.
Name | 형식 | Description |
---|---|---|
error |
오류 세부 정보입니다. |
InnerError
오류에 대한 현재 개체보다 더 구체적인 정보를 포함하는 개체입니다.
Name | 형식 | Description |
---|---|---|
code |
string |
포함된 오류에서 제공한 것보다 더 구체적인 오류 코드입니다. |
errorDetail |
string |
내부 오류 또는 예외 메시지입니다. |
innerError |
오류에 대한 현재 개체보다 더 구체적인 정보를 포함하는 개체입니다. |
|
message |
string |
사람이 읽을 수 있는 오류 표현입니다. |
UpdateFile
파일 메타데이터를 업데이트합니다.
Name | 형식 | Description |
---|---|---|
downloadHandler |
관련 파일을 활용하여 페이로드 파일을 다운로드하기 위한 선택적 다운로드 처리기입니다. |
|
etag |
string |
파일 ETag. |
fileId |
string |
가져오기 시 서버에서 생성되는 파일 ID입니다. |
fileName |
string |
파일 이름. |
hashes |
object |
해시 알고리즘을 base64로 인코딩된 해시 값에 매핑합니다. |
mimeType |
string |
파일 MIME 형식입니다. |
properties |
object |
선택적 파일 속성(서비스에서 사용되지 않지만 디바이스에 대한 통과). |
relatedFiles |
DownloadHandler 메타데이터를 함께 사용하여 페이로드 파일을 다운로드하는 선택적 관련 파일 메타데이터입니다. |
|
scanDetails |
string |
맬웨어 방지 검사 세부 정보. |
scanResult |
string |
맬웨어 방지 검사 결과입니다. |
sizeInBytes |
integer |
파일 크기(바이트 수)입니다. |
UpdateFileBase
파일 기본 메타데이터를 업데이트합니다.
Name | 형식 | Description |
---|---|---|
fileName |
string |
파일 이름. |
hashes |
object |
해시 알고리즘을 base64로 인코딩된 해시 값에 매핑합니다. |
mimeType |
string |
파일 MIME 형식입니다. |
properties |
object |
선택적 파일 속성(서비스에서 사용되지 않지만 디바이스에 대한 통과). |
scanDetails |
string |
맬웨어 방지 검사 세부 정보. |
scanResult |
string |
맬웨어 방지 검사 결과입니다. |
sizeInBytes |
integer |
파일 크기(바이트 수)입니다. |
UpdateFileDownloadHandler
관련 파일을 활용하여 페이로드 파일을 다운로드하기 위한 처리기를 다운로드합니다.
Name | 형식 | Description |
---|---|---|
id |
string |
처리기 식별자를 다운로드합니다. |