Devices - Get Identity

IoT Hub ID 레지스트리에서 디바이스를 가져옵니다.

GET https://fully-qualified-iothubname.azure-devices.net/devices/{id}?api-version=2021-04-12

URI 매개 변수

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

string

디바이스의 고유 식별자입니다.

api-version
query True

string

API의 버전입니다.

응답

Name 형식 Description
200 OK

Device

OK.

정의

Name Description
AuthenticationMechanism
Device
DeviceCapabilities

디바이스에서 사용하도록 설정된 기능의 상태.

SymmetricKey
X509Thumbprint

AuthenticationMechanism

Name 형식 Description
symmetricKey

SymmetricKey

SAS 기반 인증에 사용되는 기본 및 보조 키입니다.

type enum:
  • certificateAuthority
  • none
  • sas
  • selfSigned

서비스에 연결하는 데 사용되는 인증 유형입니다.

x509Thumbprint

X509Thumbprint

x509 기반 인증에 사용되는 기본 및 보조 x509 지문입니다.

Device

Name 형식 Description
authentication

AuthenticationMechanism

디바이스에서 사용하는 인증 메커니즘입니다.

capabilities

DeviceCapabilities

디바이스의 기능 집합입니다. 예를 들어 이 디바이스가 에지 디바이스인지 여부입니다.

cloudToDeviceMessageCount

integer

디바이스로 보낼 현재 큐에 대기 중인 클라우드-디바이스 메시지 수입니다.

connectionState enum:
  • Connected
  • Disconnected

디바이스 상태입니다.

connectionStateUpdatedTime

string

연결 상태가 마지막으로 업데이트된 날짜 및 시간입니다.

deviceId

string

디바이스의 고유 식별자입니다.

deviceScope

string

디바이스의 범위입니다. 에지 디바이스에 대해 자동으로 생성되고 변경할 수 없으며 리프 디바이스에서 수정하여 자식/부모 관계를 만듭니다.

etag

string

RFC7232 따라 디바이스 ID에 대한 약한 ETag를 나타내는 문자열입니다.

generationId

string

IoT Hub 생성된 대/소문자를 구분하는 문자열로, 최대 128자까지 가능합니다. 이 값은 삭제되고 다시 만들 때와 동일한 deviceId로 디바이스를 구분하는 데 사용됩니다.

lastActivityTime

string

디바이스가 마지막으로 연결, 수신 또는 메시지를 보낸 날짜 및 마지막 시간입니다.

parentScopes

string[]

해당하는 경우 상위 수준 에지 디바이스의 범위입니다. 에지 디바이스에만 사용할 수 있습니다.

status enum:
  • disabled
  • enabled

디바이스의 상태. 상태 사용하지 않도록 설정된 경우 디바이스가 서비스에 연결할 수 없습니다.

statusReason

string

디바이스 ID의 이유를 저장하는 128자 길이의 문자열은 상태. UTF-8 문자를 모두 허용합니다.

statusUpdatedTime

string

상태 필드가 마지막으로 업데이트된 날짜 및 시간입니다.

DeviceCapabilities

디바이스에서 사용하도록 설정된 기능의 상태.

Name 형식 Description
iotEdge

boolean

디바이스가 에지 디바이스인지 여부를 결정하는 속성입니다.

SymmetricKey

Name 형식 Description
primaryKey

string

디바이스의 base64로 인코딩된 기본 키입니다.

secondaryKey

string

디바이스의 base64로 인코딩된 보조 키입니다.

X509Thumbprint

Name 형식 Description
primaryThumbprint

string

X509 클라이언트 인증서 기본 지문입니다.

secondaryThumbprint

string

X509 클라이언트 인증서 보조 지문입니다.