API versi REST API Azure IoT Central Data Plane

  • Artikel

Artikel ini mencantumkan versi REST API saat ini dan sebelumnya untuk Azure IoT Central.

Versi stabil

Versi ini adalah rilis stabil yang dapat digunakan untuk mengembangkan solusi produksi dengan Azure IoT Central.

versi API Spesifikasi Pembaruan API
2022-07-31 (Terbaru) Spesifikasi Swagger Catatan rilis
2022-05-31 (Tidak digunakan lagi) Spesifikasi Swagger Catatan rilis
1.0 (Tidak digunakan lagi) Spesifikasi Swagger Catatan rilis

Versi pratinjau

Versi pratinjau dirilis untuk menguji fungsionalitas baru, mengumpulkan umpan balik, dan menemukan serta memperbaiki masalah. API Pratinjau tersedia di bawah Ketentuan Penggunaan Tambahan, dan tidak disarankan untuk beban kerja produksi.

versi API Spesifikasi Pembaruan API
2022-10-31-preview (Terbaru) Spesifikasi Swagger Catatan rilis
2022-06-30-preview (Tidak digunakan lagi) Spesifikasi Swagger Catatan rilis
1.2-Preview (Tidak digunakan lagi) Spesifikasi Swagger Catatan rilis
1.1-Preview (Tidak digunakan lagi) Spesifikasi Swagger Catatan rilis

Catatan rilis

2022-10-31-preview

Rilis pratinjau Azure IoT Central REST Data Plane API pada 31 Oktober 2022 memberikan serangkaian peningkatan pada titik akhir yang ada dan menambahkan beberapa titik akhir baru untuk mengaktifkan kemampuan utama berikut.

  • Fitur kueri properti dari API Kueri saat ini tidak lagi didukung dan telah membatasi tarif hingga satu permintaan per menit.

    Catatan

    Fitur ini akan dihapus pada 30 Juni 2023.

  • Dukungan untuk membuat dan mengelola siklus hidup untuk 'Manifes Penyebaran Microsoft Edge'.

    Catatan

    Manifes ini sekarang telah diputus dari templat perangkat dan dapat dikelola secara independen.

  • Penghapusan 'deploymentManifest' dari definisi 'DeviceTemplate'. Sesuai perubahan di atas, manifes penyebaran sekarang independen.

    Catatan

    Pembaruan ini adalah perilaku perubahan yang melanggar dari rilis pratinjau 2022-06-30 sebelumnya.

  • Dukungan untuk jenis 'iotEdge' baru telah ditambahkan ke entitas 'Perangkat' sebagai 'type: string[]'. Bidang ini memungkinkan pengguna mengidentifikasi perangkat sebagai perangkat IoT Edge diaktifkan. Bidang ini adalah jenis opsional dan Anda dapat terus membuat dan mengelola instans perangkat tanpanya.

    
{

    "type": ["iotEdge"]

}

  • Dukungan untuk rute baru applyDeploymentManifest ke Device. Operasi ini memungkinkan Anda mengaitkan Manifes Penyebaran IoT Edge ke instans perangkat.

  • Dukungan untuk bidang readAccess opsional baru ke FileUpload konfigurasi.

  • Dukungan untuk idScope dalam EnrollmentGroup entitas untuk akses yang nyaman.

  • Dukungan yang diperbarui untuk halaman dengan parameter baru termasuk maxpagesize, , orderbyfilter. Dan parameter yang sebelumnya didukung termasuk $filter, $top, $orderby sekarang telah dihentikan.

  • Dukungan untuk jenis pekerjaan baru deviceManifestMigration . Jenis pekerjaan baru ini memungkinkan Anda mengelola armada perangkat Edge dan mengonfigurasi deploymentManifest untuk perangkat tersebut.

2022-07-31

Rilis GA terbaru kami pada 31 Juli 2022 meningkatkan rilis yang ada 2022-05-31 sebelumnya dan kompatibel sepenuhnya mundur. Mulai hari ini, 2022-05-31 rilis sekarang ditandai untuk deprecation dan kita akan mencari untuk mengakhiri dukungan untuk itu pada Juli 2025. Berikut adalah serangkaian pembaruan yang diambil dalam rilis ini:

  • Pekerjaan dengan dukungan status kemajuan
  • Dukungan Pekerjaan Terjadwal
  • Dukungan Grup Pendaftaran Perangkat
  • Dukungan Hubungan Perangkat
  • Dukungan Perangkat Daftar Grup Perangkat

2022-06-30-preview

Rilis pratinjau Azure IoT Central REST Data Plane API pada 30 Juni 2022 memberikan serangkaian peningkatan pada titik akhir yang ada dan menambahkan dukungan untuk kemampuan utama berikut:

  • Dukungan untuk membuat dan mengelola Enrollment Groups untuk onboarding perangkat
  • Kemampuan untuk membuat dan mengonfigurasi Scheduled Jobs
  • Dukungan untuk pembuatan Application Dashboard secara terprogram melalui REST API
  • Dukungan untuk properti dan perintah yang tidak dimodelkan untuk Device
  • Kemampuan untuk mencantumkan perangkat dalam Device Group
  • Ringkasan kemajuan dukungan dari pekerjaan
  • Bidang nama yang dihapus dari Device Relationship

2022-05-31

Rilis GA terbaru kami pada 31 Mei 2022 meningkatkan rilis yang ada 1.0 sebelumnya dan kompatibel sepenuhnya mundur. Mulai hari ini, 1.0 rilis sekarang ditandai untuk deprecation dan kita akan mencari untuk mengakhiri dukungan untuk itu pada Mei 2025. Berikut adalah serangkaian pembaruan yang diambil dalam rilis ini:

  • Dukungan Konfigurasi Penyimpanan Unggahan File
  • Dukungan CRUD Grup Perangkat
  • Dukungan CRUD Organisasi
  • Dukungan Organisasi pada Perangkat, Peran, Pengguna, dan Token API

1.2-Preview (Deprecated)

Rilis terus 1.2-preview meningkatkan titik akhir API kami dari rilis pratinjau sebelumnya dan menambahkan dukungan untuk fitur-fitur berikut:

  • Dukungan CRUD Grup Perangkat
  • Jenis pekerjaan baru untuk mendukung migrasi templat perangkat

1.0

Rilis GA REST API pertama untuk Azure IoT Central yang menangkap dukungan untuk titik akhir berikut: Perangkat, Daftar Peran, Pengguna, Templat Perangkat, dan Token API. Anda dapat mempelajari selengkapnya tentang masing-masing titik akhir di sini.

  • Pengguna tanpa dukungan organisasi.
  • Daftar peran tanpa dukungan organisasi.
  • Perangkat CRUD, properti, perintah, kredensial, dukungan pengesahan.
  • Token API tanpa dukungan organisasi.
  • Templat Perangkat tanpa dukungan PATCH.

1.1-Preview (Deprecated)

Rilis ini memungkinkan dukungan untuk DTDL v2 dalam permukaan REST API untuk Azure IoT Central. Ini termasuk melanggar perubahan dari versi warisan preview (sekarang tidak digunakan lagi).

  • DTDLv2 perataan, baca detail selengkapnya.
  • Dukungan Hubungan Perangkat.
  • Dukungan konfigurasi FileUpload.
  • Dukungan organisasi.
  • Dukungan Kueri Telemetri Perangkat.
  • Dukungan pekerjaan.
  • Menghapus Dukungan Ekspor Data Berkelanjutan warisan.
  • Tambahkan dukungan Ekspor Data V2 Ekspor/Tujuan.
  • Menghapus api/devices/{deviceId}/cloudProperties, menggunakan api/devices/{deviceId}/properties.
  • Properti perangkat dan telemetri di bawah antarmuka yang diwariskan tidak akan diperlakukan sebagai properti akar dan telemetri akar.
  • Dukungan patching Templat Perangkat.
  • Dukungan manifes Edge dari templat perangkat.

Preview (Deprecated & Removed)

Versi pertama API publik Azure IoT Central, dengan dukungan hanya untuk DTDL v1 , sekarang telah ditolak dan dihapus dari titik akhir REST API kami.

Lihat juga