Device Management - Get Device Module

서비스:: Device Update

API 버전:: 2022-10-01

IoT Hub용 디바이스 업데이트에 연결된 디바이스 모듈의 디바이스 모듈 속성 및 최신 배포 상태를 가져옵니다.

GET https://{endpoint}/deviceUpdate/{instanceId}/management/devices/{deviceId}/modules/{moduleId}?api-version=2022-10-01

URI 매개 변수

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

응답

Name	형식	Description
200 OK	Device	디바이스 속성 및 최신 배포 상태입니다.
Other Status Codes	ErrorResponse	기본 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 흐름

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
https://api.adu.microsoft.com/.default	기본 권한 부여 범위입니다.

예제

DeviceManagement_GetDevice

샘플 요청

HTTP

GET https://contoso.api.adu.microsoft.com/deviceUpdate/blue/management/devices/deviceId/modules/moduleId?api-version=2022-10-01

샘플 응답

상태 코드:: 200

{
  "deviceId": "device1",
  "moduleId": "module1",
  "deviceClassId": "deviceClassId1",
  "lastAttemptedUpdate": {
    "updateId": {
      "provider": "provider1",
      "name": "name1",
      "version": "2.0.0.0"
    }
  },
  "deploymentStatus": "Failed",
  "installedUpdate": {
    "updateId": {
      "provider": "provider1",
      "name": "name1",
      "version": "1.0.0.0"
    }
  },
  "onLatestUpdate": false,
  "lastInstallResult": {
    "resultCode": 200,
    "extendedResultCode": 0,
    "resultDetails": "",
    "stepResults": [
      {
        "update": {
          "updateId": {
            "provider": "microsoft",
            "name": "peripheralcamera",
            "version": "1.0"
          }
        },
        "resultCode": 200,
        "extendedResultCode": 0,
        "resultDetails": ""
      },
      {
        "update": {
          "updateId": {
            "provider": "microsoft",
            "name": "peripheralspeaker",
            "version": "1.0"
          }
        },
        "resultCode": 200,
        "extendedResultCode": 0,
        "resultDetails": ""
      }
    ]
  }
}

정의

Name	Description
Device	디바이스 메타데이터.
DeviceDeploymentState	배포 상태입니다.
Error	오류 세부 정보입니다.
ErrorResponse	일반적인 오류 응답입니다.
InnerError	오류에 대한 현재 개체보다 더 구체적인 정보를 포함하는 개체입니다.
InstallResult	업데이트의 설치 결과 및 그 아래의 모든 단계 결과입니다.
StepResult	업데이트 중인 단계 결과입니다.
UpdateId	업데이트 식별자입니다.
UpdateInfo	정보를 업데이트합니다.

Device

Object

디바이스 메타데이터.

Name	형식	Description
deploymentStatus	DeviceDeploymentState	마지막 배포에서 디바이스의 상태입니다.
deviceClassId	string	디바이스 클래스 ID입니다.
deviceId	string	디바이스 ID입니다.
groupId	string	디바이스 그룹 ID입니다.
installedUpdate	UpdateInfo	디바이스에 현재 설치된 업데이트입니다.
lastAttemptedUpdate	UpdateInfo	디바이스가 마지막으로 설치하려고 시도한 업데이트입니다.
lastDeploymentId	string	디바이스에 대한 마지막 배포에 대한 배포 식별자
lastInstallResult	InstallResult	마지막 설치 결과입니다.
moduleId	string	디바이스 모듈 ID입니다.
onLatestUpdate	boolean	최신 업데이트(디바이스의 디바이스 클래스 및 그룹에 가장 호환되는 업데이트)가 디바이스에 설치되어 있는지 여부를 나타내는 부울 플래그

DeviceDeploymentState

열거형

배포 상태입니다.

값	Description
Succeeded	배포가 성공적으로 완료되었습니다.
InProgress	배포가 진행 중입니다.
Canceled	배포가 취소되었습니다.
Failed	배포가 실패로 완료되었습니다.

Error

Object

오류 세부 정보입니다.

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

ErrorResponse

Object

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

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

InnerError

Object

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

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

InstallResult

Object

업데이트의 설치 결과 및 그 아래의 모든 단계 결과입니다.

Name	형식	Description
extendedResultCode	integer	확장 결과 코드 설치
resultCode	integer	결과 코드를 설치합니다.
resultDetails	string	설치 결과에 대한 자세한 내용을 포함하는 문자열
stepResults	StepResult[]	단계 결과 배열

StepResult

Object

업데이트 중인 단계 결과입니다.

Name	형식	Description
description	string	단계 설명입니다.
extendedResultCode	integer	확장 결과 코드 설치
resultCode	integer	결과 코드를 설치합니다.
resultDetails	string	설치 결과에 대한 자세한 내용을 포함하는 문자열
update	UpdateInfo	참조 형식인 경우 이 단계가 설치하는 업데이트입니다.

UpdateId

Object

업데이트 식별자입니다.

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

UpdateInfo

Object

정보를 업데이트합니다.

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