Azure IoT Central Data Plane REST API의 API 버전

이 문서에서는 Azure IoT Central용 REST API의 현재 및 이전 버전을 나열합니다.

안정적인 버전

이러한 버전은 Azure IoT Central을 사용하여 프로덕션 솔루션을 개발하는 데 사용할 수 있는 안정적인 릴리스입니다.

미리 보기 버전

미리 보기 버전은 새 기능을 테스트하고, 피드백을 수집하고, 문제를 검색하고 해결하기 위해 릴리스됩니다. 미리 보기 API는 추가 사용 약관에 따라 사용할 수 있으며 프로덕션 워크로드에는 권장되지 않습니다.

릴리스 정보

2022-10-31-preview

2022년 10월 31일에 Azure IoT Central REST Data Plane API의 미리 보기 릴리스는 기존 엔드포인트에 대한 일련의 개선 사항을 제공하고 다음과 같은 주요 기능을 사용하도록 몇 가지 새로운 엔드포인트를 추가합니다.

• 현재 쿼리 API의 속성 쿼리 기능은 더 이상 지원되지 않으며 분당 하나의 요청으로 속도를 제한했습니다.

  참고

  이 기능은 2023년 6월 30일까지 제거됩니다.

• 'Microsoft Edge 배포 매니페스트'의 수명 주기 만들기 및 관리를 지원합니다.

  참고

  이러한 매니페스트는 이제 디바이스 템플릿에서 분리되었으며 독립적으로 관리할 수 있습니다.

• 'DeviceTemplate' 정의에서 'deploymentManifest'를 제거합니다. 위의 변경 내용에 따라 배포 매니페스트는 이제 독립적입니다.

  참고

  이 업데이트는 이전 2022-06-30-preview 릴리스의 호환성이 손상되는 변경 동작입니다.

• 새 'iotEdge' 형식에 대한 지원이 'Device' 엔터티에 'type: string[]'으로 추가되었습니다. 이 필드를 사용하면 사용자가 디바이스를 IoT Edge 사용하도록 설정된 디바이스로 식별할 수 있습니다. 이 필드는 선택적 형식이며 디바이스 인스턴스 없이도 계속 만들고 관리할 수 있습니다.

  
  {
  
      "type": ["iotEdge"]
  
  }
  
  

• 에 대한 새 applyDeploymentManifest 경로를 지원합니다 Device. 이 작업을 사용하면 IoT Edge 배포 매니페스트를 디바이스 인스턴스에 연결할 수 있습니다.

• 구성할 FileUpload 새 선택적 필드에 readAccess 대한 지원.

• 편리한 액세스를 위해 idScope 엔터티 내에서 EnrollmentGroup 를 지원합니다.

• , , filterorderby을 비롯한 maxpagesize새 매개 변수를 사용하여 페이징에 대한 지원이 업데이트되었습니다. 그리고 를 $top$orderby 포함하여 $filter이전에 지원되었던 매개 변수는 이제 사용 중지되었습니다.

• 새 deviceManifestMigration 작업 유형에 대한 지원. 이 새로운 작업 유형을 사용하면 Edge 디바이스의 플릿을 관리하고 해당 디바이스에 대해 을 deploymentManifest 구성할 수 있습니다.

2022-07-31

2022년 7월 31일에 출시된 최신 GA 릴리스는 기존 2022-05-31 릴리스를 개선하고 완전히 이전 버전과 호환됩니다. 현재 릴리스가 2022-05-31 표시 deprecation 되어 있으며 2025년 7월까지 지원을 종료할 예정입니다. 이 릴리스에서 캡처된 업데이트 집합은 다음과 같습니다.

• 진행 상태 지원이 있는 작업
• 예약된 작업 지원
• 디바이스 등록 그룹 지원
• 디바이스 관계 지원
• 디바이스 그룹 디바이스 목록 지원

2022-06-30-preview

2022년 6월 30일 Azure IoT Central REST Data Plane API의 미리 보기 릴리스는 기존 엔드포인트에 대한 일련의 개선 사항을 제공하고 다음과 같은 주요 기능에 대한 지원을 추가합니다.

• 디바이스 온보딩을 만들고 관리하기 Enrollment Groups 위한 지원
• 만들고 구성하는 기능 Scheduled Jobs
• REST API를 통해 프로그래밍 방식으로 만들기 Application Dashboard 지원
• 에 대한 비모델링되지 않은 속성 및 명령에 대한 지원 Device
• 내의 디바이스를 나열하는 기능 Device Group
• 작업에서 진행률 요약 지원
• 에서 이름 필드를 제거했습니다. Device Relationship

2022-05-31

2022년 5월 31일에 출시된 최신 GA 릴리스는 기존 릴리스를 1.0 개선하고 완전히 이전 버전과 호환됩니다. 오늘 현재 릴리스가 1.0 표시 deprecation 되어 있으며 2025년 5월까지 지원을 종료할 예정입니다. 이 릴리스에서 캡처된 업데이트 집합은 다음과 같습니다.

• 파일 업로드 스토리지 구성 지원
• 디바이스 그룹 CRUD 지원
• 조직 CRUD 지원
• 디바이스, 역할, 사용자 및 API 토큰에 대한 조직 지원

1.2-Preview (Deprecated)

이 릴리스는 1.2-preview 이전 미리 보기 릴리스의 API 엔드포인트를 지속적으로 개선하고 다음 기능에 대한 지원을 추가합니다.

• 디바이스 그룹 CRUD 지원
• 디바이스 템플릿 마이그레이션을 지원하는 새 작업 유형

1.0

디바이스, 역할 목록, 사용자, 디바이스 템플릿 및 API 토큰과 같은 엔드포인트에 대한 지원을 캡처하는 Azure IoT Central에 대한 첫 번째 GA REST API 릴리스입니다. 여기에서 각 엔드포인트에 대해 자세히 알아볼 수 있습니다.

• 조직 지원이 없는 사용자.
• 조직 지원이 없는 역할 목록입니다.
• 디바이스 CRUD, 속성, 명령, 자격 증명, 증명 지원.
• 조직 지원이 없는 API 토큰.
• PATCH 지원이 없는 디바이스 템플릿.

1.1-Preview (Deprecated)

이 릴리스에서는 Azure IoT Central에 대한 REST API 표면 내에서 DTDL v2를 지원할 수 있습니다. 여기에는 레거시 preview 버전(현재는 사용되지 않음)의 호환성이 손상되는 변경 내용이 포함됩니다.

• DTDLv2 맞춤, 자세한 내용을 읽어 보세요.
• 디바이스 관계 지원.
• FileUpload 구성 지원.
• 조직 지원.
• 디바이스 원격 분석 쿼리 지원.
• 작업 지원.
• 레거시 연속 데이터 내보내기 지원이 제거되었습니다.
• 데이터 내보내기 V2 내보내기/대상 지원을 추가합니다.
• api/devices/{deviceId}/properties를 사용하여 api/devices/{deviceId}/cloudProperties를 제거했습니다.
• 상속된 인터페이스의 디바이스 속성 및 원격 분석은 루트 속성 및 루트 원격 분석으로 처리되지 않습니다.
• 디바이스 템플릿 패치 지원.
• 디바이스 템플릿의 Edge 매니페스트 지원.

Preview (Deprecated & Removed)

첫 번째 버전의 Azure IoT Central 퍼블릭 API DTDL v1 는 이제 REST API 엔드포인트에서 더 이상 사용되지 않으며 제거되었습니다.

추가 정보

• 일반적인 오류 코드
• 인증
• 제한