Azure IoT Central データ プレーン REST API の API バージョン

  • [アーティクル]

この記事では、Azure IoT Central 用の REST API の現在と過去のバージョンの一覧を示します。

安定したバージョン

これらのバージョンは、Azure IoT Central を使用して運用ソリューションを開発するために使用できる安定したリリースです。

API バージョン 仕様 API の更新
2022-07-31 (最新) Swagger の仕様 リリース ノート
2022-05-31 (非推奨) Swagger の仕様 リリース ノート
1.0 (非推奨) Swagger の仕様 リリース ノート

プレビュー バージョン

プレビュー バージョンは、新機能のテスト、フィードバックの収集、問題の検出と修正を行うためにリリースされています。 プレビュー API は 、補足使用条件で使用でき、運用環境のワークロードには推奨されません。

API バージョン 仕様 API の更新
2022-10-31-preview (最新) Swagger の仕様 リリース ノート
2022-06-30-preview (非推奨) Swagger の仕様 リリース ノート
1.2-Preview (非推奨) Swagger の仕様 リリース ノート
1.1-Preview (非推奨) Swagger の仕様 リリース ノート

リリース ノート

2022-10-31-preview

2022 年 10 月 31 日の Azure IoT Central REST データ プレーン API のプレビュー リリースでは、既存のエンドポイントに一連の機能強化が行われ、次の主要な機能を有効にするためにいくつかの新しいエンドポイントが追加されます。

  • 現在の Query API のプロパティ クエリ機能はサポートされなくなり、1 分あたり 1 要求にレートが制限されています。

    注意

    この機能は、2023 年 6 月 30 日までに削除されます。

  • "Microsoft Edge 配置マニフェスト" のライフサイクルの作成と管理のサポート。

    注意

    これらのマニフェストは、デバイス テンプレートから切り離され、個別に管理できるようになりました。

  • 'DeviceTemplate' 定義からの 'deploymentManifest' の削除。 上記の変更に従って、配置マニフェストは独立しています。

    注意

    この更新プログラムは、以前の 2022-06-30-preview リリースからの破壊的変更動作です。

  • 新しい 'iotEdge' 型のサポートが 'type: string[]' として 'Device' エンティティに追加されました。 このフィールドを使用すると、ユーザーはデバイスをIoT Edge有効なデバイスとして識別できます。 このフィールドは省略可能な型であり、デバイス インスタンスの作成と管理を続行できます。

    
{

    "type": ["iotEdge"]

}

  • への新 applyDeploymentManifest しいルートの Deviceサポート。 この操作により、IoT Edge配置マニフェストをデバイス インスタンスに関連付けることができます。

  • 構成に対する新しい省略可能なフィールド readAccess の FileUpload サポート。

  • 便利なアクセスのためのidScopeEnrollmentGroupエンティティ内での のサポート。

  • 、filterorderby、 を含むmaxpagesize新しいパラメーターを使用したページングのサポートが更新されました。 以前にサポートされていた パラメーター (、 $top$orderby を含む$filter) は廃止されました。

  • 新しい deviceManifestMigration ジョブの種類のサポート。 この新しいジョブの種類を使用すると、Edge デバイスのフリートを管理し、 を構成 deploymentManifest できます。

2022-07-31

2022 年 7 月 31 日の最新の GA リリースでは、以前の既存 2022-05-31 のリリースが改善され、完全に下位互換性があります。 現在、このリリースは 対象deprecationとしてマークされており、2022-05-312025 年 7 月までにサポートを終了する予定です。 このリリースでキャプチャされた更新プログラムのセットを次に示します。

  • 進行状況がサポートされているジョブ
  • スケジュールされたジョブのサポート
  • デバイス登録グループのサポート
  • デバイスリレーションシップのサポート
  • デバイス グループの一覧 デバイスのサポート

2022-06-30-preview

2022 年 6 月 30 日の Azure IoT Central REST データ プレーン API のプレビュー リリースでは、既存のエンドポイントに一連の機能強化が行われ、次の主要な機能がサポートされます。

  • デバイスオンボードの作成と管理 Enrollment Groups のサポート
  • 作成および構成する機能 Scheduled Jobs
  • REST API を使用したプログラムによる作成の Application Dashboard サポート
  • のモデル化されていないプロパティとコマンドのサポート Device
  • 内のデバイスを一覧表示する機能 Device Group
  • ジョブからの進行状況の概要をサポートする
  • から名前フィールドを削除しました Device Relationship

2022-05-31

2022 年 5 月 31 日の最新の GA リリースでは、以前の既存 1.0 のリリースが改善され、完全に下位互換性があります。 現在、このリリースは 対象deprecationとしてマークされており、1.02025 年 5 月までにサポートを終了する予定です。 このリリースでキャプチャされた更新プログラムのセットを次に示します。

  • ファイル アップロード ストレージ構成のサポート
  • デバイス グループ CRUD のサポート
  • 組織の CRUD サポート
  • デバイス、ロール、ユーザー、API トークンに関する組織のサポート

1.2-Preview (Deprecated)

このリリースでは 1.2-preview 、以前のプレビュー リリースの API エンドポイントが継続的に改善され、次の機能のサポートが追加されています。

  • デバイス グループ CRUD のサポート
  • デバイス テンプレートの移行をサポートする新しいジョブの種類

1.0

次のエンドポイントのサポートをキャプチャする Azure IoT Central の最初の GA REST API リリース:デバイス、ロール リスト、ユーザー、デバイス テンプレート、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 を削除しました。
  • 継承されたインターフェイスのデバイス プロパティとテレメトリは、ルート プロパティとルート テレメトリとして扱われません。
  • デバイス テンプレートの修正プログラムのサポート。
  • デバイス テンプレートからのエッジ マニフェストのサポート。

Preview (Deprecated & Removed)

サポートされている Azure IoT Central パブリック API DTDL v1 の最初のバージョンは非推奨になり、REST API エンドポイントから削除されました。

関連項目