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 매개 변수

Name	In(다음 안에)	필수	형식	Description
endpoint	path	True	string url	IoT Hub 계정 엔드포인트에 대한 디바이스 업데이트(호스트 이름만, 프로토콜 없음).
instanceId	path	True	string	IoT Hub 계정에 대한 디바이스 업데이트 instance 식별자입니다.
operationId	path	True	string	작업 ID입니다.
api-version	query	True	string	클라이언트 요청과 함께 사용할 API의 버전입니다.

요청 헤더

Name	필수	형식	Description
If-None-Match		string	If-None-Match 조건을 정의합니다. 서버의 ETag가 이 값과 일치하지 않는 경우에만 작업이 수행됩니다.

응답

Name	형식	Description
200 OK	UpdateOperation	작업 상태입니다. 헤더 Retry-After: string
Other Status Codes	ErrorResponse	기본 응답입니다.

보안

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_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\""
}

정의

Name	Description
Error	오류 세부 정보입니다.
ErrorResponse	일반적인 오류 응답입니다.
InnerError	오류에 대한 현재 개체보다 더 구체적인 정보를 포함하는 개체입니다.
OperationStatus	작업 상태입니다.
UpdateId	식별자를 업데이트합니다.
UpdateInfo	정보를 업데이트합니다.
UpdateOperation	작업 메타데이터.

Error

오류 세부 정보입니다.

Name	형식	Description
code	string	서버에서 정의한 오류 코드입니다.
details	Error[]	보고된 오류로 이어진 오류 배열입니다.
innererror	InnerError	오류에 대한 현재 개체보다 더 구체적인 정보를 포함하는 개체입니다.
message	string	사람이 읽을 수 있는 오류 표현입니다.
occurredDateTime	string	오류가 발생한 날짜 및 시간(UTC)입니다.
target	string	오류의 대상입니다.

ErrorResponse

일반적인 오류 응답입니다.

Name	형식	Description
error	Error	오류 세부 정보입니다.

InnerError

오류에 대한 현재 개체보다 더 구체적인 정보를 포함하는 개체입니다.

Name	형식	Description
code	string	포함된 오류에서 제공한 것보다 더 구체적인 오류 코드입니다.
errorDetail	string	내부 오류 또는 예외 메시지입니다.
innerError	InnerError	오류에 대한 현재 개체보다 더 구체적인 정보를 포함하는 개체입니다.
message	string	사람이 읽을 수 있는 오류 표현입니다.

OperationStatus

작업 상태입니다.

Name	형식	Description
Failed	string	백그라운드 작업이 실패로 완료되었습니다.
NotStarted	string	백그라운드 작업이 만들어졌지만 아직 시작되지 않았습니다.
Running	string	백그라운드 작업이 현재 실행 중입니다.
Succeeded	string	백그라운드 작업이 성공적으로 완료되었습니다.

UpdateId

식별자를 업데이트합니다.

Name	형식	Description
name	string	이름을 업데이트합니다.
provider	string	공급자를 업데이트합니다.
version	string	버전을 업데이트합니다.

UpdateInfo

정보를 업데이트합니다.

Name	형식	Description
description	string	설명을 업데이트합니다.
friendlyName	string	친숙한 업데이트 이름입니다.
updateId	UpdateId	식별자를 업데이트합니다.

UpdateOperation

작업 메타데이터.

Name	형식	Description
createdDateTime	string	작업을 만든 날짜 및 시간(UTC)입니다.
error	Error	작업 오류가 발생했습니다(있는 경우).
etag	string	ETag 작업.
lastActionDateTime	string	작업 상태 마지막으로 업데이트된 날짜 및 시간(UTC)입니다.
operationId	string	OperationID
resourceLocation	string	작업이 성공하면 가져온 업데이트의 위치입니다.
status	OperationStatus	작업 상태입니다.
traceId	string	Microsoft 지원 문제 해결에 사용할 수 있는 작업 상관 관계 ID입니다.
update	UpdateInfo	가져오거나 삭제할 업데이트입니다. 가져오기의 경우 이 속성은 가져오기 매니페스트가 성공적으로 처리된 후에만 채워집니다.