Modules - Create Or Update Identity
IoT Hub 디바이스에 대한 모듈 ID를 만들거나 업데이트합니다. moduleId 및 generationId는 사용자가 업데이트할 수 없습니다.
PUT https://fully-qualified-iothubname.azure-devices.net/devices/{id}/modules/{mid}?api-version=2021-04-12URI 매개 변수
| Name | In(다음 안에) | 필수 | 형식 | Description |
|---|---|---|---|---|
|
id
|
path | True |
string |
디바이스의 고유 식별자입니다. |
|
mid
|
path | True |
string |
모듈의 고유 식별자입니다. |
|
api-version
|
query | True |
string |
API의 버전입니다. |
요청 헤더
| Name | 필수 | 형식 | Description |
|---|---|---|---|
| If-Match |
string |
RFC7232 따라 모듈의 약한 ETag를 나타내는 문자열입니다. 모듈을 만들 때는 설정하지 말고 모듈을 업데이트할 때 설정할 수 있습니다. |
요청 본문
| Name | 형식 | Description |
|---|---|---|
| authentication |
서비스 및 에지 허브에 연결할 때 모듈에서 사용하는 인증 메커니즘입니다. |
|
| cloudToDeviceMessageCount |
integer |
모듈에 전송하기 위해 현재 큐에 있는 클라우드 대 모듈 메시지 수입니다. |
| connectionState |
enum:
|
디바이스의 연결 상태입니다. |
| connectionStateUpdatedTime |
string |
연결 상태가 마지막으로 업데이트된 날짜 및 시간입니다. |
| deviceId |
string |
디바이스의 고유 식별자입니다. |
| etag |
string |
RFC7232 따라 모듈 ID에 대한 약한 ETag를 나타내는 문자열입니다. |
| generationId |
string |
대/소문자를 구분하는 문자열이 생성된 IoT Hub 최대 128자 길이입니다. 이 값은 모듈이 삭제되고 다시 만들어진 경우 동일한 moduleId를 사용하여 모듈을 구분하는 데 사용됩니다. |
| lastActivityTime |
string |
디바이스가 메시지를 마지막으로 연결, 수신 또는 보낸 날짜 및 시간입니다. |
| managedBy |
string |
이 모듈을 관리하는 사람을 식별합니다. 예를 들어, 에지 런타임이 이 모듈을 소유하는 경우 이 값은 "IotEdge"입니다. |
| moduleId |
string |
모듈의 고유 식별자입니다. |
응답
| Name | 형식 | Description |
|---|---|---|
| 200 OK |
OK. |
|
| 201 Created |
만들어졌습니다. |
정의
| Name | Description |
|---|---|
|
Authentication |
|
| Module |
디바이스의 모듈 ID입니다. |
|
Symmetric |
|
| X509Thumbprint |
AuthenticationMechanism
| Name | 형식 | Description |
|---|---|---|
| symmetricKey |
SAS 기반 인증에 사용되는 기본 및 보조 키입니다. |
|
| type |
enum:
|
서비스에 연결하는 데 사용되는 인증 유형입니다. |
| x509Thumbprint |
x509 기반 인증에 사용되는 기본 및 보조 x509 지문입니다. |
Module
디바이스의 모듈 ID입니다.
| Name | 형식 | Description |
|---|---|---|
| authentication |
서비스 및 에지 허브에 연결할 때 모듈에서 사용하는 인증 메커니즘입니다. |
|
| cloudToDeviceMessageCount |
integer |
모듈에 전송하기 위해 현재 큐에 있는 클라우드 대 모듈 메시지 수입니다. |
| connectionState |
enum:
|
디바이스의 연결 상태입니다. |
| connectionStateUpdatedTime |
string |
연결 상태가 마지막으로 업데이트된 날짜 및 시간입니다. |
| deviceId |
string |
디바이스의 고유 식별자입니다. |
| etag |
string |
RFC7232 따라 모듈 ID에 대한 약한 ETag를 나타내는 문자열입니다. |
| generationId |
string |
대/소문자를 구분하는 문자열이 생성된 IoT Hub 최대 128자 길이입니다. 이 값은 모듈이 삭제되고 다시 만들어진 경우 동일한 moduleId를 사용하여 모듈을 구분하는 데 사용됩니다. |
| lastActivityTime |
string |
디바이스가 메시지를 마지막으로 연결, 수신 또는 보낸 날짜 및 시간입니다. |
| managedBy |
string |
이 모듈을 관리하는 사람을 식별합니다. 예를 들어, 에지 런타임이 이 모듈을 소유하는 경우 이 값은 "IotEdge"입니다. |
| moduleId |
string |
모듈의 고유 식별자입니다. |
SymmetricKey
| Name | 형식 | Description |
|---|---|---|
| primaryKey |
string |
디바이스의 base64로 인코딩된 기본 키입니다. |
| secondaryKey |
string |
디바이스의 base64로 인코딩된 보조 키입니다. |
X509Thumbprint
| Name | 형식 | Description |
|---|---|---|
| primaryThumbprint |
string |
X509 클라이언트 인증서 기본 지문입니다. |
| secondaryThumbprint |
string |
X509 클라이언트 인증서 보조 지문입니다. |