다음을 통해 공유


Device Update - List Updates

IoT Hub 디바이스 업데이트로 가져온 모든 업데이트 목록을 가져옵니다.

GET https://{endpoint}/deviceUpdate/{instanceId}/updates?api-version=2022-10-01
GET https://{endpoint}/deviceUpdate/{instanceId}/updates?api-version=2022-10-01&search={search}&filter={filter}

URI 매개 변수

Name In(다음 안에) 필수 형식 Description
endpoint
path True

string

url

IoT Hub 계정 엔드포인트에 대한 디바이스 업데이트(호스트 이름만, 프로토콜 없음).

instanceId
path True

string

IoT Hub 계정에 대한 디바이스 업데이트 instance 식별자입니다.

api-version
query True

string

클라이언트 요청과 함께 사용할 API의 버전입니다.

filter
query

string

isDeployable 속성으로 업데이트를 필터링하려면 선택 사항입니다.

search
query

string

자유 텍스트 검색 식과 일치하는 업데이트를 요청합니다.

응답

Name 형식 Description
200 OK

UpdateList

가져온 모든 업데이트 또는 없는 경우 빈 목록입니다.

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_ListUpdates

샘플 요청

GET https://contoso.api.adu.microsoft.com/deviceUpdate/blue/updates?api-version=2022-10-01

샘플 응답

{
  "value": [
    {
      "updateId": {
        "provider": "microsoft",
        "name": "adu",
        "version": "1.0.0.0"
      },
      "description": "Example update.",
      "compatibility": [
        {
          "deviceManufacturer": "Microsoft",
          "deviceModel": "Toaster"
        }
      ],
      "instructions": {
        "steps": [
          {
            "description": "pre-install script",
            "handler": "microsoft/script:1",
            "handlerProperties": {
              "arguments": "--pre-install"
            },
            "files": [
              "configure.sh"
            ]
          },
          {
            "type": "reference",
            "updateId": {
              "provider": "microsoft",
              "name": "sensor",
              "version": "1.0"
            }
          }
        ]
      },
      "manifestVersion": "5.0",
      "importedDateTime": "2020-04-22T21:01:43.8408797+00:00",
      "createdDateTime": "2019-09-12T00:00:00.0000000+00:00",
      "etag": "\"3fed3378-0c67-47d2-b796-296962c66cbb\""
    }
  ]
}

정의

Name Description
Error

오류 세부 정보입니다.

ErrorResponse

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

InnerError

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

Instructions
Step

설치 명령 단계를 업데이트합니다.

StepType

단계 유형입니다.

Update

메타데이터를 업데이트합니다.

UpdateId

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

UpdateList

업데이트 목록입니다.

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

사람이 읽을 수 있는 오류 표현입니다.

Instructions

Name 형식 Description
steps

Step[]

설치 단계의 컬렉션입니다.

Step

설치 명령 단계를 업데이트합니다.

Name 형식 Default value Description
description

string

단계 설명.

files

string[]

실행 중에 처리기에 전달할 파일 이름의 컬렉션입니다. 단계 유형이 인라인인 경우 필요합니다.

handler

string

이 단계를 실행할 처리기의 ID입니다. 단계 유형이 인라인인 경우 필요합니다.

handlerProperties

object

실행 중에 처리기에 전달할 매개 변수입니다.

type

StepType

inline

단계 유형입니다.

updateId

UpdateId

참조된 자식 업데이트 ID입니다. 단계 유형이 참조인 경우 필요합니다.

StepType

단계 유형입니다.

Name 형식 Description
inline

string

reference

string

Update

메타데이터를 업데이트합니다.

Name 형식 Default value Description
compatibility

object[]

업데이트 호환성 정보 목록입니다.

createdDateTime

string

업데이트가 만들어진 날짜 및 시간(UTC)입니다.

description

string

작성자가 지정한 설명을 업데이트합니다.

etag

string

ETag를 업데이트합니다.

friendlyName

string

가져오기자가 지정한 친숙한 업데이트 이름입니다.

importedDateTime

string

업데이트를 가져온 날짜 및 시간(UTC)입니다.

installedCriteria

string

디바이스 업데이트 클라이언트에서 업데이트가 디바이스에 설치되어 있는지 확인하기 위해 해석되는 문자열입니다. 최신 가져오기 매니페스트 스키마에서 사용되지 않습니다.

instructions

Instructions

설치 지침을 업데이트합니다.

isDeployable

boolean

True

업데이트를 디바이스에 자체적으로 배포할 수 있는지 여부입니다.

manifestVersion

string

업데이트를 가져오는 데 사용되는 매니페스트의 스키마 버전입니다.

referencedBy

UpdateId[]

이 업데이트를 참조하는 업데이트 ID 목록입니다.

scanResult

string

집계 검사 결과를 업데이트합니다(페이로드 파일 검사 결과에서 계산됨).

updateId

UpdateId

ID를 업데이트합니다.

updateType

string

업데이트 유형입니다. 최신 가져오기 매니페스트 스키마에서 사용되지 않습니다.

UpdateId

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

Name 형식 Description
name

string

이름을 업데이트합니다.

provider

string

공급자를 업데이트합니다.

version

string

버전을 업데이트합니다.

UpdateList

업데이트 목록입니다.

Name 형식 Description
nextLink

string

항목의 다음 페이지에 대한 링크입니다.

value

Update[]

페이지가 지정 가능한 항목의 컬렉션입니다.