Azure IoT Central V3(미리 보기)
Azure IoT Central을 사용하면 대규모로 IoT 디바이스를 쉽게 연결, 모니터링 및 관리할 수 있습니다. IoT Central V3 커넥터를 사용하면 규칙이 실행되면 워크플로를 트리거하고, 명령을 실행하고, 속성을 업데이트하고, 디바이스에서 원격 분석을 가져오는 등의 작업을 수행할 수 있습니다. Azure IoT Central V3 애플리케이션에서 이 커넥터를 사용합니다.
이 커넥터는 다음 제품 및 지역에서 사용할 수 있습니다.
| 서비스 | 클래스 | Regions |
|---|---|---|
| Copilot Studio | Premium | 다음을 제외한 모든 Power Automate 지역 : - 미국 정부(GCC) - 미국 정부(GCC High) - 21Vianet에서 운영하는 중국 클라우드 - 미국 국방부(DoD) |
| 논리 앱 | 스탠다드 | 다음을 제외한 모든 Logic Apps 지역 : - Azure Government 지역 - Azure 중국 지역 - 미국 국방부(DoD) |
| Power Apps | Premium | 다음을 제외한 모든 Power Apps 지역 : - 미국 정부(GCC) - 미국 정부(GCC High) - 21Vianet에서 운영하는 중국 클라우드 - 미국 국방부(DoD) |
| Power Automate | Premium | 다음을 제외한 모든 Power Automate 지역 : - 미국 정부(GCC) - 미국 정부(GCC High) - 21Vianet에서 운영하는 중국 클라우드 - 미국 국방부(DoD) |
| 연락처 | |
|---|---|
| 이름 | Azure IoT Central 기술 지원 |
| URL | https://aka.ms/iotcentral-create-technical-support-ticket-trial |
| 커넥터 메타데이터 | |
|---|---|
| 게시자 | Microsoft Corporation |
| 웹 사이트 | https://azure.microsoft.com/services/iot-central/ |
| 개인 정보 보호 정책 | https://privacy.microsoft.com |
| 카테고리 | 사물 인터넷 |
Azure IoT Central V3 커넥터를 사용하여 Azure IoT Central V3 애플리케이션을 워크플로에 연결할 수 있습니다. 규칙이 실행되면 커넥터를 사용하여 워크플로를 실행할 수 있습니다. 이를 사용하여 원격 분석 데이터 및 속성과 같은 IoT 디바이스에서 최신 정보를 가져올 수 있습니다. 명령을 보내고 적절한 항목을 업데이트하여 IoT 디바이스를 업데이트하는 데 사용할 수도 있습니다.
필수 조건
- 이 커넥터를 사용하려면 Azure IoT Central V3 종량제You-Go 애플리케이션의 사용자여야 합니다.
- Microsoft Entra ID 회사 또는 학교 계정을 사용해야 합니다.
자격 증명을 가져오는 방법
워크플로에 이 커넥터를 추가하려면 먼저 연결하려는 Azure IoT Central 애플리케이션의 사용자인 Microsoft Entra ID 회사 또는 학교 계정에 로그인해야 합니다.
출시 정보
2021년 9월
- 이제 Azure IoT Central V3 커넥터가 일반 공급 1.0 REST API 화면에 맞게 업데이트되었습니다. 이제 모든 커넥터 작업은 DTDLv2 형식 을 지원하며 DTDLv1 기반 모델에 대한 지원은 더 이상 사용되지 않습니다.
- Azure IoT Central의 최신 디바이스 템플릿 기능에 대한 지원을 추가하도록 업데이트된 작업
Run a device commandGet/Update device propertiesGet device telemetry value이제 이러한 작업은 루트 및 구성 요소 기능을 모두 지원합니다. - 새 디바이스 모듈 작업 집합이 추가되었습니다. 이러한 작업을 통해 디바이스 모듈 및 모듈 구성 요소 모두의 명령, 속성, 원격 분석과 상호 작용하는 워크플로를 만들 수 있습니다.
-
Get/Create/Update/Delete a device최신 Azure IoT Central REST API에 맞게 업데이트된 작업입니다. - 작업
Get device cloud properties이며Update device cloud properties현재 해당 작업 및 에 속Get device properties합니다Update device properties. 새 작업을 사용하면 워크플로가 디바이스 속성 및 클라우드 속성과 동시에 상호 작용할 수 있습니다.
사용 중단 알림: CY21이 끝날 때까지 아래 목록에서 사용되지 않는 것으로 표시된 작업은 새 워크플로를 빌드할 때 더 이상 사용할 수 없습니다. 이러한 작업을 참조하는 기존 워크플로는 2022년 3월까지 계속 작동합니다. 이제 Azure IoT Central 내에서 지원되는 새로 발표된 작업을 활용하도록 워크플로를 업데이트하는 것이 좋습니다.
2021년 11월
- Azure IoT Central 애플리케이션에 대한 디바이스 및 디바이스 템플릿을 나열하기 위한 새로운 작업이 추가되었습니다. 이러한 작업에는 페이지 매김 지원이 포함됩니다.
- 새 사용자 관리 작업 집합이 커넥터에 추가되어 워크플로가 애플리케이션의 사용자를 만들고, 업데이트하고, 나열하고, 삭제할 수 있습니다.
- 이제 워크플로는 새
Get device command response작업을 사용하여 디바이스 명령의 최신 실행을 가져올 수 있습니다. 이 작업 집합은 루트, 구성 요소 및 모듈 명령을 지원합니다.
알려진 문제 및 제한 사항
- Microsoft Power Automate에서 이 커넥터를 사용하려면 IoT Central 애플리케이션에 한 번 이상 로그인해야 합니다. 그렇지 않으면 애플리케이션 드롭다운에 애플리케이션이 표시되지 않습니다.
- Microsoft 개인 계정(예: @hotmail.com@live.com@outlook.com 도메인)은 IoT Central 커넥터에 로그인할 수 없습니다. Microsoft Entra ID 회사 또는 학교 계정을 사용해야 합니다.
연결을 만드는 중
커넥터는 다음 인증 유형을 지원합니다.
| Credentials | Credentials | 모든 지역 | 공유할 수 없음 |
| 기본값 [사용되지 않음] | 이 옵션은 명시적 인증 유형이 없는 이전 연결에만 해당되며 이전 버전과의 호환성을 위해서만 제공됩니다. | 모든 지역 | 공유할 수 없음 |
Credentials
인증 ID: 1stparty
적용 가능: 모든 지역
Credentials
공유 가능한 연결이 아닙니다. 전원 앱이 다른 사용자와 공유되면 다른 사용자에게 새 연결을 명시적으로 만들라는 메시지가 표시됩니다.
기본값 [사용되지 않음]
적용 가능: 모든 지역
이 옵션은 명시적 인증 유형이 없는 이전 연결에만 해당되며 이전 버전과의 호환성을 위해서만 제공됩니다.
공유 가능한 연결이 아닙니다. 전원 앱이 다른 사용자와 공유되면 다른 사용자에게 새 연결을 명시적으로 만들라는 메시지가 표시됩니다.
제한 한도
| Name | 호출 | 갱신 기간 |
|---|---|---|
| 연결당 API 호출 | 100 | 60초 |
동작
| ID로 디바이스 가져오기 |
디바이스 ID별로 기존 디바이스에 대한 세부 정보를 가져옵니다. |
| ID로 디바이스 가져오기(사용되지 않음) |
디바이스 ID로 기존 디바이스에 대한 세부 정보를 가져옵니다(사용되지 않음). |
| ID별 디바이스 템플릿 가져오기 |
ID별로 기존 디바이스 템플릿에 대한 세부 정보를 가져옵니다. |
| 관계 목록 |
디바이스 ID에 따라 모든 관계를 나열합니다. |
| 구성 요소 명령 실행 |
구성 요소에서 명령을 실행합니다. |
| 구성 요소 명령 응답 가져오기 |
디바이스 구성 요소 명령에 대한 마지막 응답을 가져옵니다. |
| 구성 요소 원격 분석 값 가져오기 |
구성 요소에서 마지막 원격 분석 값을 가져옵니다. |
| 디바이스 관계 가져오기 |
디바이스 ID 및 관계 ID별로 기존 디바이스 관계에 대한 세부 정보를 가져옵니다. |
| 디바이스 관계 만들기 |
디바이스 ID와 관계 ID가 지정된 경우 지정된 디바이스와 새 디바이스 간에 새 디바이스 관계를 만듭니다. |
| 디바이스 관계 삭제 |
디바이스 ID 및 관계 ID별로 기존 디바이스 관계를 삭제합니다. |
| 디바이스 관계 업데이트 |
디바이스 ID와 관계 ID가 지정된 경우 지정된 디바이스와 새 디바이스 간의 기존 디바이스 관계를 업데이트합니다. |
| 디바이스 그룹 ID로 디바이스 가져오기 |
애플리케이션의 디바이스 그룹에 있는 디바이스 목록을 가져옵니다. |
| 디바이스 그룹 가져오기 |
ID별로 기존 디바이스 그룹에 대한 세부 정보를 가져옵니다. |
| 디바이스 그룹 나열 |
애플리케이션의 디바이스 그룹 목록을 가져옵니다. |
| 디바이스 그룹 만들기 |
디바이스 그룹을 만들거나 업데이트합니다. |
| 디바이스 그룹 삭제 |
ID로 기존 디바이스 그룹 삭제 |
| 디바이스 나열 |
애플리케이션의 디바이스 목록을 가져옵니다. |
| 디바이스 만들기 또는 업데이트 |
새 디바이스를 만들거나 디바이스 ID별로 기존 디바이스를 업데이트합니다. |
| 디바이스 만들기 또는 업데이트(사용되지 않음) |
새 디바이스를 만들거나 디바이스 ID별로 기존 디바이스를 업데이트합니다. (사용되지 않음) |
| 디바이스 만들기 또는 업데이트(사용되지 않음) |
새 디바이스를 만들거나 디바이스 ID로 기존 디바이스를 업데이트합니다(사용되지 않음). |
| 디바이스 명령 실행 |
디바이스에서 명령을 실행합니다. |
| 디바이스 명령 실행(사용되지 않음) |
디바이스에서 명령을 실행합니다(사용되지 않음). |
| 디바이스 명령 응답 가져오기 |
디바이스 명령에 대한 마지막 응답을 가져옵니다. |
| 디바이스 삭제 |
디바이스 ID로 기존 디바이스를 삭제합니다. |
| 디바이스 삭제(사용되지 않음) |
디바이스 ID로 기존 디바이스를 삭제합니다(사용되지 않음). |
| 디바이스 상태 가져오기 |
작업 ID별로 개별 디바이스 상태 목록을 가져옵니다. |
| 디바이스 속성 가져오기 |
디바이스 ID별로 디바이스의 모든 속성 값을 가져옵니다. |
| 디바이스 속성 가져오기(사용되지 않음) |
디바이스 ID(사용되지 않음)로 디바이스의 모든 속성 값을 가져옵니다. |
| 디바이스 속성 업데이트 |
디바이스 ID별로 디바이스의 모든 속성 값을 업데이트합니다. |
| 디바이스 속성 업데이트(사용되지 않음) |
디바이스 ID(사용되지 않음)로 디바이스의 모든 속성 값을 업데이트합니다. |
| 디바이스 원격 분석 값 가져오기 |
디바이스에서 마지막 원격 분석 값을 가져옵니다. |
| 디바이스 원격 분석 값 가져오기(사용되지 않음) |
디바이스에서 마지막 원격 분석 값을 가져옵니다(사용되지 않음). |
| 디바이스 클라우드 속성 가져오기(사용되지 않음) |
디바이스 ID(사용되지 않음)로 디바이스의 모든 클라우드 속성 값을 가져옵니다. |
| 디바이스 클라우드 속성 업데이트(사용되지 않음) |
디바이스 ID(사용되지 않음)로 디바이스의 모든 클라우드 속성 값을 업데이트합니다. |
| 디바이스 템플릿 나열 |
애플리케이션에서 디바이스 템플릿 목록을 가져옵니다. |
| 디바이스 템플릿 삭제 |
ID별로 기존 디바이스 템플릿을 삭제합니다. |
| 모듈 구성 요소 명령 실행 |
모듈 구성 요소에서 명령을 실행합니다. |
| 모듈 구성 요소 명령 응답 가져오기 |
모듈 구성 요소 명령에 대한 마지막 응답을 가져옵니다. |
| 모듈 구성 요소 원격 분석 값 가져오기 |
모듈 구성 요소에서 마지막 원격 분석 값을 가져옵니다. |
| 모듈 명령 실행 |
모듈에서 명령을 실행합니다. |
| 모듈 명령 응답 가져오기 |
디바이스 모듈 명령에 대한 마지막 응답 가져오기 |
| 모듈 속성 가져오기 |
모듈의 모든 속성 값을 가져옵니다. |
| 모듈 속성 업데이트 |
모듈의 모든 속성 값을 업데이트합니다. |
| 모듈 원격 분석 값 가져오기 |
모듈에서 마지막 원격 분석 값을 가져옵니다. |
| 사용자 가져오기 |
ID로 사용자 가져오기 |
| 사용자 나열 |
애플리케이션에서 사용자 목록 가져오기 |
| 사용자 만들기 |
애플리케이션에서 사용자 만들기 |
| 사용자 삭제 |
사용자 삭제 |
| 사용자 업데이트 |
패치를 통해 애플리케이션에서 사용자 업데이트 |
| 실패한 디바이스에서 작업 다시 시작 |
실패한 모든 디바이스에서 기존 작업을 다시 실행합니다. |
| 실행 중인 작업 중지 |
현재 실행 중인 작업의 실행을 중지합니다. |
| 역할 가져오기 |
ID로 역할을 가져옵니다. |
| 역할 나열 |
애플리케이션의 역할 목록을 가져옵니다. |
| 예약된 작업 ID로 작업 가져오기 |
예약된 작업 정의에 대한 작업 목록을 가져옵니다. |
| 예약된 작업 가져오기 |
ID별로 예약된 기존 작업에 대한 세부 정보를 가져옵니다. |
| 예약된 작업 나열 |
애플리케이션에서 예약된 작업 목록을 가져옵니다. |
| 예약된 작업 만들기 |
작업 정의를 통해 예약된 새 작업을 만들고 실행합니다. |
| 예약된 작업 삭제 |
ID별로 예약된 기존 작업을 삭제합니다. |
| 예약된 작업 업데이트 |
ID로 예약된 기존 작업을 업데이트합니다. |
| 작업 가져오기 |
ID별로 기존 작업에 대한 세부 정보를 가져옵니다. |
| 작업 나열 |
애플리케이션의 작업 목록을 가져옵니다. |
| 작업 생성 |
작업 정의를 통해 새 작업을 만들고 실행합니다. |
| 조직 가져오기 |
ID별로 기존 조직에 대한 세부 정보를 가져옵니다. |
| 조직 나열 |
애플리케이션의 조직 목록을 가져옵니다. |
| 조직 만들기 |
새 조직을 만듭니다. |
| 조직 삭제 |
ID로 기존 조직 삭제 |
| 중지된 작업 다시 시작 |
기존 중지된 작업의 실행을 다시 시작합니다. |
ID로 디바이스 가져오기
디바이스 ID별로 기존 디바이스에 대한 세부 정보를 가져옵니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
애플리케이션의 고유 ID입니다. |
|
디바이스 ID
|
device_id | True | string |
디바이스의 고유 ID입니다. |
반환
- 몸
- DeviceV1
ID로 디바이스 가져오기(사용되지 않음)
디바이스 ID로 기존 디바이스에 대한 세부 정보를 가져옵니다(사용되지 않음).
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
애플리케이션의 고유 ID입니다. |
|
디바이스 ID
|
device_id | True | string |
디바이스의 고유 ID입니다. |
반환
- 몸
- Device
ID별 디바이스 템플릿 가져오기
ID별로 기존 디바이스 템플릿에 대한 세부 정보를 가져옵니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
애플리케이션의 고유 ID입니다. |
|
Template
|
template_id | True | string |
템플릿의 고유 ID입니다. |
반환
관계 목록
디바이스 ID에 따라 모든 관계를 나열합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
애플리케이션의 고유 ID입니다. |
|
디바이스 ID
|
device_id | True | string |
디바이스의 고유 ID입니다. |
반환
구성 요소 명령 실행
구성 요소에서 명령을 실행합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
애플리케이션의 고유 ID입니다. |
|
디바이스 ID
|
device_id | True | string |
디바이스의 고유 ID입니다. |
|
디바이스 구성 요소
|
component_name | True | string |
디바이스 구성 요소의 이름입니다. |
|
디바이스 명령
|
command_name | True | string |
이 디바이스 명령의 이름입니다. |
|
디바이스 템플릿
|
template | string |
디바이스에 대한 디바이스 템플릿 정의입니다. |
|
|
body
|
body | True | dynamic |
디바이스 명령 본문입니다. |
반환
구성 요소 명령 응답 가져오기
디바이스 구성 요소 명령에 대한 마지막 응답을 가져옵니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
애플리케이션의 고유 ID입니다. |
|
디바이스 ID
|
device_id | True | string |
디바이스의 고유 ID입니다. |
|
디바이스 구성 요소
|
component_name | True | string |
디바이스 구성 요소의 이름입니다. |
|
디바이스 명령
|
command_name | True | string |
이 디바이스 명령의 이름입니다. |
|
디바이스 템플릿
|
template | string |
디바이스에 대한 디바이스 템플릿 정의입니다. |
반환
구성 요소 원격 분석 값 가져오기
구성 요소에서 마지막 원격 분석 값을 가져옵니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
애플리케이션의 고유 ID입니다. |
|
디바이스 ID
|
device_id | True | string |
디바이스의 고유 ID입니다. |
|
디바이스 구성 요소
|
component_name | True | string |
디바이스 구성 요소의 이름입니다. |
|
디바이스 원격 분석
|
telemetry_name | True | string |
이 디바이스 원격 분석의 이름입니다. |
|
디바이스 템플릿
|
template | string |
디바이스에 대한 디바이스 템플릿 정의입니다. |
반환
디바이스 관계 가져오기
디바이스 ID 및 관계 ID별로 기존 디바이스 관계에 대한 세부 정보를 가져옵니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
애플리케이션의 고유 ID입니다. |
|
디바이스 ID
|
device_id | True | string |
디바이스의 고유 ID입니다. |
|
관계 ID
|
relationship_id | True | string |
디바이스 관계의 고유 ID입니다. |
반환
디바이스 관계 만들기
디바이스 ID와 관계 ID가 지정된 경우 지정된 디바이스와 새 디바이스 간에 새 디바이스 관계를 만듭니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
애플리케이션의 고유 ID입니다. |
|
관계 ID
|
relationship_id | True | string |
디바이스 관계의 고유 ID입니다. |
|
디바이스 ID
|
device_id | True | string |
디바이스의 고유 ID입니다. |
|
디바이스 관계 ID
|
id | string |
디바이스 관계의 고유 ID입니다. |
|
|
디바이스 관계 대상 ID
|
target | True | string |
원본(자식) 디바이스의 디바이스 ID입니다. |
반환
디바이스 관계 삭제
디바이스 ID 및 관계 ID별로 기존 디바이스 관계를 삭제합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
애플리케이션의 고유 ID입니다. |
|
디바이스 ID
|
device_id | True | string |
디바이스의 고유 ID입니다. |
|
관계 ID
|
relationship_id | True | string |
디바이스 관계의 고유 ID입니다. |
디바이스 관계 업데이트
디바이스 ID와 관계 ID가 지정된 경우 지정된 디바이스와 새 디바이스 간의 기존 디바이스 관계를 업데이트합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
애플리케이션의 고유 ID입니다. |
|
디바이스 ID
|
device_id | True | string |
디바이스의 고유 ID입니다. |
|
관계 ID
|
relationship_id | True | string |
디바이스 관계의 고유 ID입니다. |
|
디바이스 관계 ID
|
id | string |
디바이스 관계의 고유 ID입니다. |
|
|
디바이스 관계 대상 ID
|
target | True | string |
원본(자식) 디바이스의 디바이스 ID입니다. |
반환
디바이스 그룹 ID로 디바이스 가져오기
애플리케이션의 디바이스 그룹에 있는 디바이스 목록을 가져옵니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
애플리케이션의 고유 ID입니다. |
|
디바이스 그룹 ID
|
device_group_id | True | string |
디바이스 그룹의 고유 ID입니다. |
반환
디바이스 그룹에 속하는 디바이스의 페이징된 결과입니다.
디바이스 그룹 가져오기
ID별로 기존 디바이스 그룹에 대한 세부 정보를 가져옵니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
애플리케이션의 고유 ID입니다. |
|
디바이스 그룹 ID
|
device_group_id | True | string |
디바이스 그룹의 고유 ID입니다. |
반환
디바이스 그룹 정의입니다.
디바이스 그룹 나열
애플리케이션의 디바이스 그룹 목록을 가져옵니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
애플리케이션의 고유 ID입니다. |
반환
디바이스 그룹의 페이징된 결과입니다.
디바이스 그룹 만들기
디바이스 그룹을 만들거나 업데이트합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
애플리케이션의 고유 ID입니다. |
|
디바이스 그룹 ID
|
device_group_id | True | string |
디바이스 그룹의 고유 ID입니다. |
|
디바이스 그룹 ID
|
id | string |
디바이스 그룹의 고유 ID입니다. |
|
|
표시 이름
|
displayName | True | string |
디바이스 그룹의 표시 이름입니다. |
|
Filter
|
filter | True | string |
이 그룹에 있어야 하는 디바이스를 정의하는 쿼리입니다. |
|
Description
|
description | string |
디바이스 그룹의 간단한 요약입니다. |
|
|
ETag
|
etag | string |
ETag는 디바이스 그룹 업데이트에서 충돌을 방지하는 데 사용됩니다. |
|
|
Organizations
|
organizations | array of string |
디바이스 그룹의 조직 목록, 현재 하나의 조직만 지원되며, 여러 조직이 곧 지원될 예정입니다. |
반환
디바이스 그룹 정의입니다.
디바이스 그룹 삭제
ID로 기존 디바이스 그룹 삭제
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
애플리케이션의 고유 ID입니다. |
|
디바이스 그룹 ID
|
device_group_id | True | string |
디바이스 그룹의 고유 ID입니다. |
디바이스 나열
애플리케이션의 디바이스 목록을 가져옵니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
애플리케이션의 고유 ID입니다. |
반환
디바이스 만들기 또는 업데이트
새 디바이스를 만들거나 디바이스 ID별로 기존 디바이스를 업데이트합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
애플리케이션의 고유 ID입니다. |
|
디바이스 ID
|
device_id | True | string |
디바이스의 고유 ID입니다. |
|
디바이스 ID
|
id | string |
디바이스의 고유 ID입니다. |
|
|
디바이스 이름
|
displayName | string |
디바이스의 표시 이름입니다. |
|
|
디바이스 템플릿
|
template | string |
디바이스에 대한 디바이스 템플릿 정의입니다. |
|
|
모의
|
simulated | boolean |
디바이스가 시뮬레이션되는지 여부입니다. |
|
|
활성화됨
|
enabled | boolean |
IoT Central에 대한 디바이스 연결을 사용하도록 설정했는지 여부입니다. |
|
|
Organizations
|
organizations | array of string |
디바이스의 조직 목록, 현재 하나의 조직만 지원되며, 곧 여러 조직이 지원될 예정입니다. |
|
|
프로비전됨
|
provisioned | boolean |
리소스가 디바이스에 할당되었는지 여부입니다. |
반환
- 몸
- DeviceV2
디바이스 만들기 또는 업데이트(사용되지 않음)
새 디바이스를 만들거나 디바이스 ID별로 기존 디바이스를 업데이트합니다. (사용되지 않음)
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
애플리케이션의 고유 ID입니다. |
|
디바이스 ID
|
device_id | True | string |
디바이스의 고유 ID입니다. |
|
디바이스 ID
|
id | string |
디바이스의 고유 ID입니다. |
|
|
디바이스 이름
|
displayName | string |
디바이스의 표시 이름입니다. |
|
|
디바이스 템플릿
|
template | string |
디바이스에 대한 디바이스 템플릿 정의입니다. |
|
|
모의
|
simulated | boolean |
디바이스가 시뮬레이션되는지 여부입니다. |
|
|
활성화됨
|
enabled | boolean |
IoT Central에 대한 디바이스 연결을 사용하도록 설정했는지 여부입니다. |
|
|
프로비전됨
|
provisioned | boolean |
리소스가 디바이스에 할당되었는지 여부입니다. |
반환
- 몸
- DeviceV1
디바이스 만들기 또는 업데이트(사용되지 않음)
새 디바이스를 만들거나 디바이스 ID로 기존 디바이스를 업데이트합니다(사용되지 않음).
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
애플리케이션의 고유 ID입니다. |
|
디바이스 ID
|
device_id | True | string |
디바이스의 고유 ID입니다. |
|
디바이스 ID
|
id | string |
디바이스의 고유 ID입니다. |
|
|
디바이스 이름
|
displayName | string |
디바이스의 표시 이름입니다. |
|
|
디바이스 템플릿
|
instanceOf | string |
디바이스에 대한 디바이스 템플릿 정의입니다. |
|
|
모의
|
simulated | boolean |
디바이스가 시뮬레이션되는지 여부입니다. |
|
|
승인됨
|
approved | boolean |
디바이스가 IoT Central에 연결하도록 승인되었는지 여부입니다. |
|
|
프로비전됨
|
provisioned | boolean |
리소스가 디바이스에 할당되었는지 여부입니다. |
반환
- 몸
- Device
디바이스 명령 실행
디바이스에서 명령을 실행합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
애플리케이션의 고유 ID입니다. |
|
디바이스 ID
|
device_id | True | string |
디바이스의 고유 ID입니다. |
|
디바이스 명령
|
command_name | True | string |
이 디바이스 명령의 이름입니다. |
|
디바이스 템플릿
|
template | string |
디바이스에 대한 디바이스 템플릿 정의입니다. |
|
|
body
|
body | True | dynamic |
디바이스 명령 본문입니다. |
반환
디바이스 명령 실행(사용되지 않음)
디바이스에서 명령을 실행합니다(사용되지 않음).
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
애플리케이션의 고유 ID입니다. |
|
디바이스 ID
|
device_id | True | string |
디바이스의 고유 ID입니다. |
|
디바이스 구성 요소
|
component_name | True | string |
디바이스 구성 요소의 이름입니다. |
|
디바이스 명령
|
command_name | True | string |
이 디바이스 명령의 이름입니다. |
|
디바이스 템플릿 ID
|
instanceOf | string |
디바이스에 대한 디바이스 템플릿 정의입니다. |
|
|
body
|
body | True | dynamic |
디바이스 명령 본문입니다. |
반환
디바이스 명령 응답 가져오기
디바이스 명령에 대한 마지막 응답을 가져옵니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
애플리케이션의 고유 ID입니다. |
|
디바이스 ID
|
device_id | True | string |
디바이스의 고유 ID입니다. |
|
디바이스 명령
|
command_name | True | string |
이 디바이스 명령의 이름입니다. |
|
디바이스 템플릿
|
template | string |
디바이스에 대한 디바이스 템플릿 정의입니다. |
반환
디바이스 삭제
디바이스 ID로 기존 디바이스를 삭제합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
애플리케이션의 고유 ID입니다. |
|
디바이스 ID
|
device_id | True | string |
디바이스의 고유 ID입니다. |
디바이스 삭제(사용되지 않음)
디바이스 ID로 기존 디바이스를 삭제합니다(사용되지 않음).
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
애플리케이션의 고유 ID입니다. |
|
디바이스 ID
|
device_id | True | string |
디바이스의 고유 ID입니다. |
디바이스 상태 가져오기
작업 ID별로 개별 디바이스 상태 목록을 가져옵니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
애플리케이션의 고유 ID입니다. |
|
직무 ID
|
job_id | True | string |
작업의 고유 ID입니다. |
반환
작업 디바이스 상태의 페이징된 결과입니다.
디바이스 속성 가져오기
디바이스 ID별로 디바이스의 모든 속성 값을 가져옵니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
애플리케이션의 고유 ID입니다. |
|
디바이스 ID
|
device_id | True | string |
디바이스의 고유 ID입니다. |
|
디바이스 템플릿
|
template | string |
디바이스에 대한 디바이스 템플릿 정의입니다. |
반환
디바이스 속성 가져오기(사용되지 않음)
디바이스 ID(사용되지 않음)로 디바이스의 모든 속성 값을 가져옵니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
애플리케이션의 고유 ID입니다. |
|
디바이스 ID
|
device_id | True | string |
디바이스의 고유 ID입니다. |
|
디바이스 템플릿 ID
|
instanceOf | string |
디바이스에 대한 디바이스 템플릿 정의입니다. |
반환
디바이스 속성 업데이트
디바이스 ID별로 디바이스의 모든 속성 값을 업데이트합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
애플리케이션의 고유 ID입니다. |
|
디바이스 ID
|
device_id | True | string |
디바이스의 고유 ID입니다. |
|
디바이스 템플릿
|
template | string |
디바이스에 대한 디바이스 템플릿 정의입니다. |
|
|
body
|
body | True | dynamic |
디바이스 속성입니다. |
반환
디바이스 속성 업데이트(사용되지 않음)
디바이스 ID(사용되지 않음)로 디바이스의 모든 속성 값을 업데이트합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
애플리케이션의 고유 ID입니다. |
|
디바이스 ID
|
device_id | True | string |
디바이스의 고유 ID입니다. |
|
디바이스 템플릿 ID
|
instanceOf | string |
디바이스에 대한 디바이스 템플릿 정의입니다. |
|
|
body
|
body | True | dynamic |
디바이스 속성입니다. |
반환
디바이스 원격 분석 값 가져오기
디바이스에서 마지막 원격 분석 값을 가져옵니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
애플리케이션의 고유 ID입니다. |
|
디바이스 ID
|
device_id | True | string |
디바이스의 고유 ID입니다. |
|
디바이스 원격 분석
|
telemetry_name | True | string |
이 디바이스 원격 분석의 이름입니다. |
|
디바이스 템플릿
|
template | string |
디바이스에 대한 디바이스 템플릿 정의입니다. |
반환
디바이스 원격 분석 값 가져오기(사용되지 않음)
디바이스에서 마지막 원격 분석 값을 가져옵니다(사용되지 않음).
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
애플리케이션의 고유 ID입니다. |
|
디바이스 ID
|
device_id | True | string |
디바이스의 고유 ID입니다. |
|
디바이스 구성 요소
|
component_name | True | string |
디바이스 구성 요소의 이름입니다. |
|
디바이스 원격 분석
|
telemetry_name | True | string |
이 디바이스 원격 분석의 이름입니다. |
|
디바이스 템플릿 ID
|
instanceOf | string |
디바이스에 대한 디바이스 템플릿 정의입니다. |
반환
디바이스 클라우드 속성 가져오기(사용되지 않음)
디바이스 ID(사용되지 않음)로 디바이스의 모든 클라우드 속성 값을 가져옵니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
애플리케이션의 고유 ID입니다. |
|
디바이스 ID
|
device_id | True | string |
디바이스의 고유 ID입니다. |
|
디바이스 템플릿 ID
|
instanceOf | string |
디바이스에 대한 디바이스 템플릿 정의입니다. |
반환
디바이스 클라우드 속성 업데이트(사용되지 않음)
디바이스 ID(사용되지 않음)로 디바이스의 모든 클라우드 속성 값을 업데이트합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
애플리케이션의 고유 ID입니다. |
|
디바이스 ID
|
device_id | True | string |
디바이스의 고유 ID입니다. |
|
디바이스 템플릿 ID
|
instanceOf | string |
디바이스에 대한 디바이스 템플릿 정의입니다. |
|
|
body
|
body | True | dynamic |
디바이스 속성입니다. |
반환
디바이스 템플릿 나열
애플리케이션에서 디바이스 템플릿 목록을 가져옵니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
애플리케이션의 고유 ID입니다. |
반환
디바이스 템플릿 삭제
ID별로 기존 디바이스 템플릿을 삭제합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
애플리케이션의 고유 ID입니다. |
|
Template
|
template_id | True | string |
템플릿의 고유 ID입니다. |
모듈 구성 요소 명령 실행
모듈 구성 요소에서 명령을 실행합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
애플리케이션의 고유 ID입니다. |
|
디바이스 ID
|
device_id | True | string |
디바이스의 고유 ID입니다. |
|
디바이스 모듈
|
module | True | string |
디바이스 모듈의 이름입니다. |
|
디바이스 구성 요소
|
component_name | True | string |
디바이스 구성 요소의 이름입니다. |
|
디바이스 명령
|
command_name | True | string |
이 디바이스 명령의 이름입니다. |
|
디바이스 템플릿
|
template | string |
디바이스에 대한 디바이스 템플릿 정의입니다. |
|
|
body
|
body | True | dynamic |
디바이스 명령 본문입니다. |
반환
모듈 구성 요소 명령 응답 가져오기
모듈 구성 요소 명령에 대한 마지막 응답을 가져옵니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
애플리케이션의 고유 ID입니다. |
|
디바이스 ID
|
device_id | True | string |
디바이스의 고유 ID입니다. |
|
디바이스 모듈
|
module | True | string |
디바이스 모듈의 이름입니다. |
|
디바이스 구성 요소
|
component_name | True | string |
디바이스 구성 요소의 이름입니다. |
|
디바이스 명령
|
command_name | True | string |
이 디바이스 명령의 이름입니다. |
|
디바이스 템플릿
|
template | string |
디바이스에 대한 디바이스 템플릿 정의입니다. |
반환
모듈 구성 요소 원격 분석 값 가져오기
모듈 구성 요소에서 마지막 원격 분석 값을 가져옵니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
애플리케이션의 고유 ID입니다. |
|
디바이스 ID
|
device_id | True | string |
디바이스의 고유 ID입니다. |
|
디바이스 모듈
|
module | True | string |
디바이스 모듈의 이름입니다. |
|
디바이스 구성 요소
|
component_name | True | string |
디바이스 구성 요소의 이름입니다. |
|
디바이스 원격 분석
|
telemetry_name | True | string |
이 디바이스 원격 분석의 이름입니다. |
|
디바이스 템플릿
|
template | string |
디바이스에 대한 디바이스 템플릿 정의입니다. |
반환
모듈 명령 실행
모듈에서 명령을 실행합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
애플리케이션의 고유 ID입니다. |
|
디바이스 ID
|
device_id | True | string |
디바이스의 고유 ID입니다. |
|
디바이스 모듈
|
module | True | string |
디바이스 모듈의 이름입니다. |
|
디바이스 명령
|
command_name | True | string |
이 디바이스 명령의 이름입니다. |
|
디바이스 템플릿
|
template | string |
디바이스에 대한 디바이스 템플릿 정의입니다. |
|
|
body
|
body | True | dynamic |
디바이스 명령 본문입니다. |
반환
모듈 명령 응답 가져오기
디바이스 모듈 명령에 대한 마지막 응답 가져오기
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
애플리케이션의 고유 ID입니다. |
|
디바이스 ID
|
device_id | True | string |
디바이스의 고유 ID입니다. |
|
디바이스 모듈
|
module | True | string |
디바이스 모듈의 이름입니다. |
|
디바이스 명령
|
command_name | True | string |
이 디바이스 명령의 이름입니다. |
|
디바이스 템플릿
|
template | string |
디바이스에 대한 디바이스 템플릿 정의입니다. |
반환
모듈 속성 가져오기
모듈의 모든 속성 값을 가져옵니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
애플리케이션의 고유 ID입니다. |
|
디바이스 ID
|
device_id | True | string |
디바이스의 고유 ID입니다. |
|
디바이스 모듈
|
module | True | string |
디바이스 모듈의 이름입니다. |
|
디바이스 템플릿
|
template | string |
디바이스에 대한 디바이스 템플릿 정의입니다. |
반환
모듈 속성 업데이트
모듈의 모든 속성 값을 업데이트합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
애플리케이션의 고유 ID입니다. |
|
디바이스 ID
|
device_id | True | string |
디바이스의 고유 ID입니다. |
|
디바이스 모듈
|
module | True | string |
디바이스 모듈의 이름입니다. |
|
디바이스 템플릿
|
template | string |
디바이스에 대한 디바이스 템플릿 정의입니다. |
|
|
body
|
body | True | dynamic |
디바이스 속성입니다. |
반환
모듈 원격 분석 값 가져오기
모듈에서 마지막 원격 분석 값을 가져옵니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
애플리케이션의 고유 ID입니다. |
|
디바이스 ID
|
device_id | True | string |
디바이스의 고유 ID입니다. |
|
디바이스 모듈
|
module | True | string |
디바이스 모듈의 이름입니다. |
|
디바이스 원격 분석
|
telemetry_name | True | string |
이 디바이스 원격 분석의 이름입니다. |
|
디바이스 템플릿
|
template | string |
디바이스에 대한 디바이스 템플릿 정의입니다. |
반환
사용자 가져오기
ID로 사용자 가져오기
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
애플리케이션의 고유 ID입니다. |
|
사용자
|
user_id | True | string |
사용자의 고유 ID입니다. |
반환
사용자 나열
애플리케이션에서 사용자 목록 가져오기
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
애플리케이션의 고유 ID입니다. |
반환
사용자 만들기
애플리케이션에서 사용자 만들기
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
애플리케이션의 고유 ID입니다. |
|
사용자
|
user_id | True | string |
사용자의 고유 ID입니다. |
|
사용자 유형
|
user_type | string |
사용자의 유형입니다. |
|
|
몸
|
body | True | dynamic |
사용자가 본문을 만듭니다. |
반환
사용자 삭제
사용자 삭제
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
애플리케이션의 고유 ID입니다. |
|
사용자
|
user_id | True | string |
사용자의 고유 ID입니다. |
사용자 업데이트
패치를 통해 애플리케이션에서 사용자 업데이트
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
애플리케이션의 고유 ID입니다. |
|
사용자
|
user_id | True | string |
사용자의 고유 ID입니다. |
|
사용자 유형
|
user_type | string |
사용자의 유형입니다. |
|
|
몸
|
body | True | dynamic |
사용자 업데이트 본문입니다. |
반환
실패한 디바이스에서 작업 다시 시작
실패한 모든 디바이스에서 기존 작업을 다시 실행합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
애플리케이션의 고유 ID입니다. |
|
직무 ID
|
job_id | True | string |
작업의 고유 ID입니다. |
|
ID 다시 실행
|
rerun_id | True | string |
다시 실행의 고유 ID입니다. |
반환
작업 정의입니다.
실행 중인 작업 중지
현재 실행 중인 작업의 실행을 중지합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
애플리케이션의 고유 ID입니다. |
|
직무 ID
|
job_id | True | string |
작업의 고유 ID입니다. |
역할 가져오기
ID로 역할을 가져옵니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
애플리케이션의 고유 ID입니다. |
|
역할
|
role_id | True | string |
역할에 대한 고유 ID입니다. |
반환
- 몸
- RoleV1
역할 나열
애플리케이션의 역할 목록을 가져옵니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
애플리케이션의 고유 ID입니다. |
반환
예약된 작업 ID로 작업 가져오기
예약된 작업 정의에 대한 작업 목록을 가져옵니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
애플리케이션의 고유 ID입니다. |
|
예약된 작업 ID
|
scheduled_job_id | True | string |
예약된 작업의 고유 ID입니다. |
반환
예약된 작업에 속하는 작업 정의의 페이징된 결과입니다.
예약된 작업 가져오기
ID별로 예약된 기존 작업에 대한 세부 정보를 가져옵니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
애플리케이션의 고유 ID입니다. |
|
예약된 작업 ID
|
scheduled_job_id | True | string |
예약된 작업의 고유 ID입니다. |
반환
예약된 작업 나열
애플리케이션에서 예약된 작업 목록을 가져옵니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
애플리케이션의 고유 ID입니다. |
반환
예약된 작업 만들기
작업 정의를 통해 예약된 새 작업을 만들고 실행합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
애플리케이션의 고유 ID입니다. |
|
예약된 작업 ID
|
scheduled_job_id | True | string |
예약된 작업의 고유 ID입니다. |
|
작업 유형
|
job_type | string |
작업의 형식입니다. |
|
|
일정 종료 유형
|
scheduled_job_end_type | string |
예약된 작업이 종료되는 방식(디바이스 템플릿 마이그레이션에 적용되지 않음) |
|
|
몸
|
body | True | dynamic |
예약된 작업 만들기 본문입니다. |
반환
예약된 작업 삭제
ID별로 예약된 기존 작업을 삭제합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
애플리케이션의 고유 ID입니다. |
|
예약된 작업 ID
|
scheduled_job_id | True | string |
예약된 작업의 고유 ID입니다. |
예약된 작업 업데이트
ID로 예약된 기존 작업을 업데이트합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
애플리케이션의 고유 ID입니다. |
|
예약된 작업 ID
|
scheduled_job_id | True | string |
예약된 작업의 고유 ID입니다. |
|
일정 종료 유형
|
scheduled_job_end_type | string |
예약된 작업이 종료되는 방식(디바이스 템플릿 마이그레이션에 적용되지 않음) |
|
|
몸
|
body | True | dynamic |
예약된 작업 만들기 본문입니다. |
반환
예약된 작업 정의입니다.
작업 가져오기
ID별로 기존 작업에 대한 세부 정보를 가져옵니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
애플리케이션의 고유 ID입니다. |
|
직무 ID
|
job_id | True | string |
작업의 고유 ID입니다. |
반환
작업 정의입니다.
작업 나열
애플리케이션의 작업 목록을 가져옵니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
애플리케이션의 고유 ID입니다. |
반환
작업의 페이징된 결과입니다.
작업 생성
작업 정의를 통해 새 작업을 만들고 실행합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
애플리케이션의 고유 ID입니다. |
|
직무 ID
|
job_id | True | string |
작업의 고유 ID입니다. |
|
작업 유형
|
job_type | string |
작업의 형식입니다. |
|
|
몸
|
body | True | dynamic |
작업 만들기 본문입니다. |
반환
조직 가져오기
ID별로 기존 조직에 대한 세부 정보를 가져옵니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
애플리케이션의 고유 ID입니다. |
|
조직 ID
|
organization_id | True | string |
조직의 고유 ID입니다. |
반환
조직 나열
애플리케이션의 조직 목록을 가져옵니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
애플리케이션의 고유 ID입니다. |
반환
조직 만들기
새 조직을 만듭니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
애플리케이션의 고유 ID입니다. |
|
조직 ID
|
organization_id | True | string |
조직의 고유 ID입니다. |
|
조직 ID
|
id | string |
조직의 고유 ID입니다. |
|
|
조직 이름
|
displayName | string |
조직의 표시 이름입니다. |
|
|
Parent
|
parent | string |
부모 조직의 표시 이름입니다. |
반환
조직 삭제
ID로 기존 조직 삭제
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
애플리케이션의 고유 ID입니다. |
|
조직 ID
|
organization_id | True | string |
조직의 고유 ID입니다. |
중지된 작업 다시 시작
기존 중지된 작업의 실행을 다시 시작합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
애플리케이션의 고유 ID입니다. |
|
직무 ID
|
job_id | True | string |
작업의 고유 ID입니다. |
트리거
| 규칙이 실행되는 경우 |
IoT Central에서 규칙이 실행되면 트리거되는 작업을 만듭니다. |
규칙이 실행되는 경우
IoT Central에서 규칙이 실행되면 트리거되는 작업을 만듭니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Application
|
application | True | string |
애플리케이션의 고유 ID입니다. |
|
워크플로 트리거 ID
|
id | string |
워크플로 트리거의 고유 ID입니다. |
|
|
규칙
|
rule | True | string |
워크플로 트리거에 연결된 규칙의 고유 ID입니다. |
반환
정의
Device
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
디바이스 ID
|
id | string |
디바이스의 고유 ID입니다. |
|
디바이스 이름
|
displayName | string |
디바이스의 표시 이름입니다. |
|
디바이스 템플릿
|
instanceOf | string |
디바이스에 대한 디바이스 템플릿 정의입니다. |
|
모의
|
simulated | boolean |
디바이스가 시뮬레이션되는지 여부입니다. |
|
승인됨
|
approved | boolean |
디바이스가 IoT Central에 연결하도록 승인되었는지 여부입니다. |
|
프로비전됨
|
provisioned | boolean |
리소스가 디바이스에 할당되었는지 여부입니다. |
DeviceV1
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
디바이스 ID
|
id | string |
디바이스의 고유 ID입니다. |
|
디바이스 이름
|
displayName | string |
디바이스의 표시 이름입니다. |
|
디바이스 템플릿
|
template | string |
디바이스에 대한 디바이스 템플릿 정의입니다. |
|
모의
|
simulated | boolean |
디바이스가 시뮬레이션되는지 여부입니다. |
|
활성화됨
|
enabled | boolean |
IoT Central에 대한 디바이스 연결을 사용하도록 설정했는지 여부입니다. |
|
프로비전됨
|
provisioned | boolean |
리소스가 디바이스에 할당되었는지 여부입니다. |
DeviceV2
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
디바이스 ID
|
id | string |
디바이스의 고유 ID입니다. |
|
디바이스 이름
|
displayName | string |
디바이스의 표시 이름입니다. |
|
디바이스 템플릿
|
template | string |
디바이스에 대한 디바이스 템플릿 정의입니다. |
|
모의
|
simulated | boolean |
디바이스가 시뮬레이션되는지 여부입니다. |
|
활성화됨
|
enabled | boolean |
IoT Central에 대한 디바이스 연결을 사용하도록 설정했는지 여부입니다. |
|
Organizations
|
organizations | array of string |
디바이스의 조직 목록, 현재 하나의 조직만 지원되며, 곧 여러 조직이 지원될 예정입니다. |
|
프로비전됨
|
provisioned | boolean |
리소스가 디바이스에 할당되었는지 여부입니다. |
DeviceCollectionV1
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
value
|
value | array of DeviceV1 |
디바이스의 컬렉션입니다. |
|
넥스트링크
|
nextLink | string |
디바이스의 다음 페이지를 가져오는 URL입니다. |
DeviceGroup
디바이스 그룹 정의입니다.
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
디바이스 그룹 ID
|
id | string |
디바이스 그룹의 고유 ID입니다. |
|
표시 이름
|
displayName | string |
디바이스 그룹의 표시 이름입니다. |
|
Filter
|
filter | string |
이 그룹에 있어야 하는 디바이스를 정의하는 쿼리입니다. |
|
Description
|
description | string |
디바이스 그룹의 간단한 요약입니다. |
|
ETag
|
etag | string |
ETag는 디바이스 그룹 업데이트에서 충돌을 방지하는 데 사용됩니다. |
|
Organizations
|
organizations | array of string |
디바이스 그룹의 조직 목록, 현재 하나의 조직만 지원되며, 여러 조직이 곧 지원될 예정입니다. |
DeviceGroupCollection
디바이스 그룹의 페이징된 결과입니다.
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
디바이스 그룹 ID
|
value | array of DeviceGroup |
디바이스 그룹의 컬렉션입니다. |
|
넥스트링크
|
nextLink | string |
디바이스 그룹의 다음 페이지를 가져오는 URL입니다. |
DeviceGroupDeviceCollection
디바이스 그룹에 속하는 디바이스의 페이징된 결과입니다.
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
value
|
value | array of DeviceV1 |
디바이스 그룹에 속하는 디바이스의 컬렉션입니다. |
|
넥스트링크
|
nextLink | string |
그룹에 있는 디바이스의 다음 페이지를 가져오는 URL입니다. |
DeviceRelationshipStatic
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
디바이스 관계 ID
|
id | string |
디바이스 관계의 고유 ID입니다. |
|
디바이스 관계 원본 ID
|
source | string |
원본(부모) 디바이스의 디바이스 ID입니다. |
|
디바이스 관계 대상 ID
|
target | string |
원본(자식) 디바이스의 디바이스 ID입니다. |
DeviceRelationshipCollection
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
value
|
value | array of DeviceRelationshipStatic |
디바이스 관계의 컬렉션입니다. |
|
넥스트링크
|
nextLink | string |
디바이스 관계의 다음 페이지를 가져오는 URL입니다. |
DeviceTemplateV1
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
디바이스 템플릿 ID
|
@id | string |
디바이스 템플릿의 고유 ID입니다. |
|
디바이스 템플릿 유형
|
@type | array of string |
이 디바이스 템플릿의 JSON-LD 형식입니다. |
|
디바이스 템플릿 이름
|
displayName | string |
디바이스 템플릿의 표시 이름입니다. |
|
디바이스 템플릿 설명
|
description | string |
디바이스 템플릿에 대한 자세한 설명입니다. |
|
디바이스 템플릿 기능 모델
|
capabilityModel |
이 디바이스 템플릿에서 사용하는 기능 모델입니다. |
DeviceTemplateCollectionV1
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
value
|
value | array of DeviceTemplateV1 |
디바이스 템플릿의 컬렉션입니다. |
|
넥스트링크
|
nextLink | string |
디바이스 템플릿의 다음 페이지를 가져오는 URL입니다. |
JobDeviceStatus
작업 디바이스 상태 정의입니다.
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
디바이스 ID
|
id | string |
작업 상태가 제공되는 디바이스의 ID입니다. |
|
디바이스 상태
|
status | string |
지정된 디바이스에 대해 작업이 시작, 실행 중인지 여부를 나타냅니다. |
JobDeviceStatusCollection
작업 디바이스 상태의 페이징된 결과입니다.
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
value
|
value | array of JobDeviceStatus |
작업 디바이스 상태의 컬렉션입니다. |
|
넥스트링크
|
nextLink | string |
작업 디바이스 상태의 다음 페이지를 가져오는 URL입니다. |
JobBatch
작업 일괄 처리 정의입니다.
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
일괄 처리 유형
|
type | string |
지정된 수의 디바이스에서 일괄 처리가 수행되는지 또는 전체 디바이스의 백분율인지 여부입니다. |
|
Batch 값
|
value | number |
일괄 처리가 수행되는 디바이스의 수 또는 백분율입니다. |
JobCancellationThreshold
작업 취소 임계값 정의입니다.
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
취소 임계값 유형
|
type | string |
취소 임계값이 지정된 디바이스 수 또는 총 디바이스의 백분율에 해당하는지 여부입니다. |
|
취소 임계값
|
value | number |
취소 임계값이 적용되는 디바이스의 수 또는 백분율입니다. |
|
취소 임계값 일괄 처리
|
batch | boolean |
취소 임계값이 일괄 처리당 적용되는지 전체 작업에 적용되는지 여부입니다. |
JobStatic
작업 정의입니다.
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
직무 ID
|
id | string |
작업의 고유 ID입니다. |
|
표시 이름
|
displayName | string |
작업의 표시 이름입니다. |
|
Description
|
description | string |
작업에 대한 자세한 설명입니다. |
|
디바이스 그룹
|
group | string |
작업을 실행할 디바이스 그룹의 ID입니다. |
|
배치 / 일괄
|
batch | JobBatch |
작업 일괄 처리 정의입니다. |
|
cancellationThreshold
|
cancellationThreshold | JobCancellationThreshold |
작업 취소 임계값 정의입니다. |
|
데이터
|
data | array of object |
이 작업에서 수행하는 작업과 관련된 데이터입니다. 모든 항목은 동일한 형식이어야 합니다. |
|
items
|
data | object | |
|
Organizations
|
organizations | array of string |
작업 조직 목록, 현재 하나의 조직만 지원되며, 곧 여러 조직이 지원될 예정입니다. |
|
예약된 작업 ID
|
scheduledJobId | string |
이 작업을 만든 예약된 작업 정의의 ID입니다. |
JobCollection
작업의 페이징된 결과입니다.
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
value
|
value | array of JobStatic |
작업 컬렉션입니다. |
|
넥스트링크
|
nextLink | string |
작업의 다음 페이지를 가져오는 URL입니다. |
조직
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
조직 ID
|
id | string |
조직의 고유 ID입니다. |
|
조직 이름
|
displayName | string |
조직의 표시 이름입니다. |
|
Parent
|
parent | string |
부모 조직의 표시 이름입니다. |
OrganizationCollection
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
value
|
value | array of Organization |
조직의 컬렉션입니다. |
|
넥스트링크
|
nextLink | string |
조직의 다음 페이지를 가져오는 URL입니다. |
RoleV1
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | string |
역할의 고유 ID입니다. |
|
표시 이름
|
displayName | string |
역할의 표시 이름입니다. |
RoleCollectionV1
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
value
|
value | array of RoleV1 |
역할의 컬렉션입니다. |
ScheduledJobStatic
예약된 작업 정의입니다.
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
ETag
|
etag | string |
예약된 작업 업데이트에서 충돌을 방지하는 데 사용되는 ETag입니다. |
|
예약된 작업 ID
|
id | string |
예약된 작업의 고유 ID입니다. |
|
표시 이름
|
displayName | string |
예약된 작업의 표시 이름입니다. |
|
Description
|
description | string |
예약된 작업에 대한 자세한 설명입니다. |
|
디바이스 그룹
|
group | string |
작업을 실행할 디바이스 그룹의 ID입니다. |
|
배치 / 일괄
|
batch | JobBatch |
작업 일괄 처리 정의입니다. |
|
cancellationThreshold
|
cancellationThreshold | JobCancellationThreshold |
작업 취소 임계값 정의입니다. |
|
데이터
|
data | array of object |
이 작업에서 수행하는 작업과 관련된 데이터입니다. 모든 항목은 동일한 형식이어야 합니다. |
|
items
|
data | object | |
|
Organizations
|
organizations | array of string |
작업 조직 목록, 현재 하나의 조직만 지원되며, 곧 여러 조직이 지원될 예정입니다. |
|
일정
|
schedule | object |
작업을 실행할 일정입니다. |
|
활성화됨
|
enabled | boolean |
예약된 작업을 사용할 수 있는지 여부입니다. |
|
완료됨
|
completed | boolean |
예약된 작업이 완료되었는지 여부입니다. |
ScheduledJobJobCollection
예약된 작업에 속하는 작업 정의의 페이징된 결과입니다.
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
value
|
value | array of JobStatic |
작업 컬렉션입니다. |
|
넥스트링크
|
nextLink | string |
작업의 다음 페이지를 가져오는 URL입니다. |
UserStaticV1
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
사용자 ID
|
id | string |
사용자의 고유 ID입니다. |
|
사용자 유형
|
type | string |
사용자의 유형입니다. |
|
역할
|
roles | array of RoleAssignmentV1 |
애플리케이션에 액세스할 수 있는 권한을 지정하는 역할 할당 목록입니다. |
UserCollectionV1
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
Users
|
value | array of UserStaticV1 |
사용자의 컬렉션입니다. |
RoleAssignmentV1
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
역할
|
role | string |
이 역할 할당에 대한 역할의 ID입니다. |