次の方法で共有


Azure IoT Central V3 (プレビュー)

Azure IoT Central は、簡単に IoT デバイスに大規模に接続し、監視および管理できるようにします。 IoT Central V3 コネクタを使用すると、ルールが実行されたときにワークフローをトリガーし、コマンドの実行、プロパティの更新、デバイスからのテレメトリの取得などによってアクションを実行できます。 このコネクタは、Azure IoT Central V3 アプリケーションで使用します。

このコネクタは、次の製品および地域で利用可能です。

Service クラス 地域
Logic Apps 標準 以下を除くすべての Logic Apps 地域 :
     -   Azure 政府の地域
     -   Azure 中国の地域
     -   国防総省 (DoD)
Power Automate プレミアム 以下を除くすべての Power Automate 地域 :
     -   US Government (GCC)
     -   US Government (GCC High)
     -   21 Vianet が運用する中国のクラウド
     -   米国国防総省 (DoD)
Power Apps プレミアム 以下を除くすべての Power Apps 地域 :
     -   US Government (GCC)
     -   US Government (GCC High)
     -   21 Vianet が運用する中国のクラウド
     -   米国国防総省 (DoD)
連絡先
件名 Azure IoT Central テクニカル サポート
URL https://aka.ms/iotcentral-create-technical-support-ticket-trial
コネクタ メタデータ
公開元 Microsoft Corporation
Web サイト https://azure.microsoft.com/services/iot-central/
プライバシー ポリシー https://privacy.microsoft.com
カテゴリ IoT

Azure IoT Central V 3 コネクタを使用すると、Azure IoT Central V3 アプリケーションをワークフローに接続できます。 コネクタを使用して、ルールが実行されたときにワークフローを実行できます。 これを使用して、テレメトリ データやプロパティなどの IoT デバイスから最新の情報を取得できます。 また、コマンドを送信したり、プロパティを更新したりして、IoT デバイスを更新するためにも使用できます。

前提条件

  • このコネクタを使用するには、Azure IoT Central V3 従量課金制アプリケーションのユーザーである必要があります。
  • Microsoft Entra ID の職場または学校用のアカウントを使用する必要があります。

資格情報の入手方法

このコネクタをワークフローに追加するには、最初に、接続したい Azure IoT Central アプリケーションのユーザーである Microsoft Entra ID の職場または学校用アカウントにログインする必要があります。

リリース ノート

2021 年 9 月

  • Azure IoT Central V3 コネクタが、一般に入手可能な表面領域 1.0 REST API に合わせて更新されました。 すべてのコネクタ アクションがサポートされるようになりました DTDLv2 形式 DTDLv1 ベースのモデルのサポートは廃止されています。
  • Run a device commandGet/Update device propertiesGet device telemetry value のアクションが更新され、Azure IoT Central の 最新のデバイス テンプレート機能 へのサポートを追加されました。 これらのアクションは、ルートとコンポーネント機能の両方をサポートするようになりました。
  • デバイス モジュール アクションの新しいセットが追加されました。 これらのアクションにより、デバイス モジュールとモジュール コンポーネント両方の、コマンド、プロパティ、テレメトリと相互作用するワークフローを作成できます。
  • 最新の Azure IoT Central REST API に合わせて Get/Create/Update/Delete a device のアクションは更新されました。
  • Get device cloud propertiesUpdate device cloud properties のアクションは、Get device propertiesUpdate device properties の一部になりました。 新しいアクションにより、ワークフローはデバイス プロパティとクラウド プロパティの両方を同時に操作できるようになります。

非推奨の通知: CY21 の終わりまでに、以下の一覧で非推奨としてマークされたアクションは、新しいワークフローを構築するときに使用できなくなります。 これらのアクションを参照している既存のワークフローは、2022 年 3 月まで引き続き機能します。 Azure IoT Central 内でサポートされるようになった、新たに発表されたアクションを利用するためにワークフローを更新することをお勧めします。

2021 年 11 月

  • Azure IoT Central アプリケーションのデバイスとデバイス テンプレートを一覧表示するための新しいアクションが追加されました。 これらのアクションには ページ付けのサポート が含まれます。
  • 新しいユーザー管理アクションのセットがコネクタに追加され、ワークフローでアプリケーションのユーザーを作成、更新、一覧表示、削除できるようになりました。
  • ワークフローは、新しい Get device command response を使用してデバイス コマンドの最新の実行を取得できるようになりました。 この一連のアクションは、ルート、コンポーネント、モジュール コマンドをサポートします。

既知の問題と制限事項

  • Microsoft Power Automate でこのコネクタをで使用するには、少なくとも 1 回は IoT Central アプリケーションにログインしている必要があります。 さもなければ、アプリケーションはアプリケーション ドロップダウンに表示されません
  • Microsoft 個人用アカウント (@hotmail.com、@live.com、@outlook.com ドメインなど) は、IoT Central コネクタへのサインインをサポートしていません。 Microsoft Entra ID の職場または学校用のアカウントを使用する必要があります。

接続を作成する

このコネクタは、次の認証タイプをサポートしています:

資格情報 Credentials すべての地域 共有不可
既定 [非推奨] このオプションは、明示的な認証の種類を持たない古い接続専用に対してのみ使用され、下位互換性を保つためにのみ提供されます。 すべての地域 共有不可

Credentials

認証 ID: 1stparty

適用可能: すべての領域

Credentials

これは共有可能な接続ではありません。 Power App が別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。

既定 [非推奨]

適用できるもの: すべての領域

このオプションは、明示的な認証の種類を持たない古い接続専用に対してのみ使用され、下位互換性を保つためにのみ提供されます。

これは共有可能な接続ではありません。 Power App が別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。

調整制限

名前 呼び出し 更新期間
接続ごとの 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 で取得します。

パラメーター

名前 キー 必須 説明
アプリケーション
application True string

アプリケーションの一意の ID。

Template
template_id True string

テンプレートを示す一意の ID です。

戻り値

ID でデバイスを取得する

デバイス ID で既存のデバイスに関する詳細を取得します。

パラメーター

名前 キー 必須 説明
アプリケーション
application True string

アプリケーションの一意の ID。

Device ID
device_id True string

デバイスの一意の ID。

戻り値

Body
DeviceV1

ID でデバイスを取得する (非推奨)

デバイス ID で既存のデバイスに関する詳細を取得します (非推奨)。

パラメーター

名前 キー 必須 説明
アプリケーション
application True string

アプリケーションの一意の ID。

Device ID
device_id True string

デバイスの一意の ID。

戻り値

Body
Device

エラーを起こしたデバイスでジョブを再開する

エラーを起こしたすべてのデバイスで既存のジョブを再実行します。

パラメーター

名前 キー 必須 説明
アプリケーション
application True string

アプリケーションの一意の ID。

ジョブ ID
job_id True string

ジョブを表す一意の ID。

ID を再実行する
rerun_id True string

再実行を表す一意の ID です。

戻り値

ジョブ定義。

Body
JobStatic

コンポーネント コマンドを実行する

コンポーネントでコマンドを実行します。

パラメーター

名前 キー 必須 説明
アプリケーション
application True string

アプリケーションの一意の ID。

Device ID
device_id True string

デバイスの一意の ID。

デバイス コンポーネント
component_name True string

デバイス コンポーネントの名前。

デバイス コマンド
command_name True string

このデバイス コマンドの名前。

デバイス テンプレート
template string

デバイスのデバイス テンプレート定義。

body
body True dynamic

デバイス コマンドの本文。

戻り値

この操作の出力は状況に応じて変わります。

コンポーネント テレメトリ値を取得する

コンポーネントから最後のテレメトリ値を取得します。

パラメーター

名前 キー 必須 説明
アプリケーション
application True string

アプリケーションの一意の ID。

Device ID
device_id True string

デバイスの一意の ID。

デバイス コンポーネント
component_name True string

デバイス コンポーネントの名前。

デバイス テレメトリ
telemetry_name True string

このデバイス テレメトリの名前。

デバイス テンプレート
template string

デバイスのデバイス テンプレート定義。

戻り値

この操作の出力は状況に応じて変わります。

コンポーネントのコマンド応答を取得

デバイス コンポーネント コマンドの最後の応答を取得します。

パラメーター

名前 キー 必須 説明
アプリケーション
application True string

アプリケーションの一意の ID。

Device ID
device_id True string

デバイスの一意の ID。

デバイス コンポーネント
component_name True string

デバイス コンポーネントの名前。

デバイス コマンド
command_name True string

このデバイス コマンドの名前。

デバイス テンプレート
template string

デバイスのデバイス テンプレート定義。

戻り値

この操作の出力は状況に応じて変わります。

ジョブの取得

ID を指定して既存のジョブの詳細を取得します。

パラメーター

名前 キー 必須 説明
アプリケーション
application True string

アプリケーションの一意の ID。

ジョブ ID
job_id True string

ジョブを表す一意の ID。

戻り値

ジョブ定義。

Body
JobStatic

ジョブを作成する

ジョブ定義を使用して新しいジョブを作成し、実行します。

パラメーター

名前 キー 必須 説明
アプリケーション
application True string

アプリケーションの一意の ID。

ジョブ ID
job_id True string

ジョブを表す一意の ID。

ジョブの種類
job_type string

ジョブの種類。

Body
body True dynamic

ジョブ作成本文です。

戻り値

この操作の出力は状況に応じて変わります。

ジョブ一覧を取得

アプリケーションのジョブの一覧を取得します。

パラメーター

名前 キー 必須 説明
アプリケーション
application True string

アプリケーションの一意の ID。

戻り値

ジョブのページごとの結果です。

スケジュールされたジョブの ID を指定してジョブを取得する

スケジュールされたジョブ定義に対するジョブの一覧を取得します。

パラメーター

名前 キー 必須 説明
アプリケーション
application True string

アプリケーションの一意の ID。

スケジュール済みジョブ ID
scheduled_job_id True string

スケジュール済みジョブを表す一意の ID。

戻り値

スケジュールされたジョブに属するジョブ定義のページごとの結果です。

スケジュールされたジョブを作成する

ジョブ定義を使用して新しいスケジュールされたジョブを作成し、実行します。

パラメーター

名前 キー 必須 説明
アプリケーション
application True string

アプリケーションの一意の ID。

スケジュール済みジョブ ID
scheduled_job_id True string

スケジュール済みジョブを表す一意の ID。

ジョブの種類
job_type string

ジョブの種類。

スケジュールの終了タイプ
scheduled_job_end_type string

スケジュールされたジョブの終了方法です (デバイス テンプレートの移行には適用されません)。

Body
body True dynamic

スケジュールしたジョブの本文作成。

戻り値

この操作の出力は状況に応じて変わります。

スケジュールされたジョブを削除する

ID を指定してスケジュールされた既存のジョブを削除します。

パラメーター

名前 キー 必須 説明
アプリケーション
application True string

アプリケーションの一意の ID。

スケジュール済みジョブ ID
scheduled_job_id True string

スケジュール済みジョブを表す一意の ID。

スケジュールされたジョブを取得する

ID を指定して既存のスケジュールされたジョブの詳細を取得する。

パラメーター

名前 キー 必須 説明
アプリケーション
application True string

アプリケーションの一意の ID。

スケジュール済みジョブ ID
scheduled_job_id True string

スケジュール済みジョブを表す一意の ID。

戻り値

この操作の出力は状況に応じて変わります。

スケジュールされたジョブを更新する

ID を指定してスケジュールされた既存のジョブを更新します。

パラメーター

名前 キー 必須 説明
アプリケーション
application True string

アプリケーションの一意の ID。

スケジュール済みジョブ ID
scheduled_job_id True string

スケジュール済みジョブを表す一意の ID。

スケジュールの終了タイプ
scheduled_job_end_type string

スケジュールされたジョブの終了方法です (デバイス テンプレートの移行には適用されません)。

Body
body True dynamic

スケジュールしたジョブの本文作成。

戻り値

スケジュールしたジョブの定義。

スケジュール済みジョブの一覧を取得

アプリケーションのスケジュール済みジョブの一覧を取得します。

パラメーター

名前 キー 必須 説明
アプリケーション
application True string

アプリケーションの一意の ID。

戻り値

この操作の出力は状況に応じて変わります。

デバイス クラウド プロパティの取得 (非推奨)

デバイス ID でデバイスのすべてのクラウド プロパティ値を取得します (非推奨)。

パラメーター

名前 キー 必須 説明
アプリケーション
application True string

アプリケーションの一意の ID。

Device ID
device_id True string

デバイスの一意の ID。

デバイス テンプレート ID
instanceOf string

デバイスのデバイス テンプレート定義。

戻り値

この操作の出力は状況に応じて変わります。

デバイス クラウド プロパティの更新 (非推奨)

デバイス ID でデバイスのすべてのクラウド プロパティ値を更新します (非推奨)。

パラメーター

名前 キー 必須 説明
アプリケーション
application True string

アプリケーションの一意の ID。

Device ID
device_id True string

デバイスの一意の ID。

デバイス テンプレート ID
instanceOf string

デバイスのデバイス テンプレート定義。

body
body True dynamic

デバイスのプロパティ。

戻り値

この操作の出力は状況に応じて変わります。

デバイス グループ ID を指定してデバイスを取得する

アプリケーションのデバイス グループに含まれるデバイスの一覧を取得します。

パラメーター

名前 キー 必須 説明
アプリケーション
application True string

アプリケーションの一意の ID。

デバイス グループ ID
device_group_id True string

デバイス グループを表す一意の ID。

戻り値

デバイス グループに属するデバイスのページごとの結果です。

デバイス グループの一覧を取得

アプリケーションのデバイス グループの一覧を取得します。

パラメーター

名前 キー 必須 説明
アプリケーション
application True string

アプリケーションの一意の ID。

戻り値

デバイス グループのページごとの結果です。

デバイス グループを作成する

デバイス グループを作成または更新します。

パラメーター

名前 キー 必須 説明
アプリケーション
application True string

アプリケーションの一意の ID。

デバイス グループ ID
device_group_id True string

デバイス グループを表す一意の ID。

デバイス グループ ID
id string

デバイス グループを表す一意の ID。

Display Name
displayName True string

デバイス グループの表示名です。

フィルター
filter True string

このグループに含めるデバイスを定義するクエリです。

Description
description string

デバイス グループの短い概要です。

ETag
etag string

デバイス グループの更新での競合を防ぐために使用される ETag です。

組織
organizations array of string

デバイス グループの組織のリスト。現在対応しているのは 1 つの組織のみです。間もなく複数の組織に対応する予定です。

戻り値

デバイス グループ定義です。

デバイス グループを削除する

ID を指定して既存のデバイス グループを削除する

パラメーター

名前 キー 必須 説明
アプリケーション
application True string

アプリケーションの一意の ID。

デバイス グループ ID
device_group_id True string

デバイス グループを表す一意の ID。

デバイス グループを取得する

ID を指定して既存のデバイス グループの詳細を取得します。

パラメーター

名前 キー 必須 説明
アプリケーション
application True string

アプリケーションの一意の ID。

デバイス グループ ID
device_group_id True string

デバイス グループを表す一意の ID。

戻り値

デバイス グループ定義です。

デバイス コマンドの実行 (非推奨)

デバイスでコマンドを実行します (非推奨)。

パラメーター

名前 キー 必須 説明
アプリケーション
application True string

アプリケーションの一意の ID。

Device ID
device_id True string

デバイスの一意の ID。

デバイス コンポーネント
component_name True string

デバイス コンポーネントの名前。

デバイス コマンド
command_name True string

このデバイス コマンドの名前。

デバイス テンプレート ID
instanceOf string

デバイスのデバイス テンプレート定義。

body
body True dynamic

デバイス コマンドの本文。

戻り値

この操作の出力は状況に応じて変わります。

デバイス テレメトリ値を取得する (非推奨)

デバイスから最後のテレメトリ値を取得します (非推奨)。

パラメーター

名前 キー 必須 説明
アプリケーション
application True string

アプリケーションの一意の ID。

Device ID
device_id True string

デバイスの一意の ID。

デバイス コンポーネント
component_name True string

デバイス コンポーネントの名前。

デバイス テレメトリ
telemetry_name True string

このデバイス テレメトリの名前。

デバイス テンプレート ID
instanceOf string

デバイスのデバイス テンプレート定義。

戻り値

この操作の出力は状況に応じて変わります。

デバイス テンプレートの一覧を表示

アプリケーション内のデバイス テンプレートの一覧を取得します。

パラメーター

名前 キー 必須 説明
アプリケーション
application True string

アプリケーションの一意の ID。

戻り値

デバイス テンプレートを削除

ID で既存のデバイス テンプレートを削除します。

パラメーター

名前 キー 必須 説明
アプリケーション
application True string

アプリケーションの一意の ID。

Template
template_id True string

テンプレートを示す一意の ID です。

デバイス プロパティの取得 (非推奨)

デバイス ID でデバイスのすべてのプロパティ値を取得します (非推奨)。

パラメーター

名前 キー 必須 説明
アプリケーション
application True string

アプリケーションの一意の ID。

Device ID
device_id True string

デバイスの一意の ID。

デバイス テンプレート ID
instanceOf string

デバイスのデバイス テンプレート定義。

戻り値

この操作の出力は状況に応じて変わります。

デバイス プロパティの更新

デバイス ID でデバイスのすべてのプロパティ値を更新します。

パラメーター

名前 キー 必須 説明
アプリケーション
application True string

アプリケーションの一意の ID。

Device ID
device_id True string

デバイスの一意の ID。

デバイス テンプレート
template string

デバイスのデバイス テンプレート定義。

body
body True dynamic

デバイスのプロパティ。

戻り値

この操作の出力は状況に応じて変わります。

デバイス プロパティの更新 (非推奨)

デバイス ID でデバイスのすべてのプロパティ値を更新します (非推奨)。

パラメーター

名前 キー 必須 説明
アプリケーション
application True string

アプリケーションの一意の ID。

Device ID
device_id True string

デバイスの一意の ID。

デバイス テンプレート ID
instanceOf string

デバイスのデバイス テンプレート定義。

body
body True dynamic

デバイスのプロパティ。

戻り値

この操作の出力は状況に応じて変わります。

デバイス プロパティを取得する

デバイス ID で、デバイスのすべてのプロパティ値を取得します。

パラメーター

名前 キー 必須 説明
アプリケーション
application True string

アプリケーションの一意の ID。

Device ID
device_id True string

デバイスの一意の ID。

デバイス テンプレート
template string

デバイスのデバイス テンプレート定義。

戻り値

この操作の出力は状況に応じて変わります。

デバイスでコマンドを実行する

デバイスでコマンドを実行します。

パラメーター

名前 キー 必須 説明
アプリケーション
application True string

アプリケーションの一意の ID。

Device ID
device_id True string

デバイスの一意の ID。

デバイス コマンド
command_name True string

このデバイス コマンドの名前。

デバイス テンプレート
template string

デバイスのデバイス テンプレート定義。

body
body True dynamic

デバイス コマンドの本文。

戻り値

この操作の出力は状況に応じて変わります。

デバイスのコマンド応答を取得

デバイス コマンドの最後の応答を取得します。

パラメーター

名前 キー 必須 説明
アプリケーション
application True string

アプリケーションの一意の ID。

Device ID
device_id True string

デバイスの一意の ID。

デバイス コマンド
command_name True string

このデバイス コマンドの名前。

デバイス テンプレート
template string

デバイスのデバイス テンプレート定義。

戻り値

この操作の出力は状況に応じて変わります。

デバイスのテレメトリ値を取得する

デバイスから最後のテレメトリ値を取得します。

パラメーター

名前 キー 必須 説明
アプリケーション
application True string

アプリケーションの一意の ID。

Device ID
device_id True string

デバイスの一意の ID。

デバイス テレメトリ
telemetry_name True string

このデバイス テレメトリの名前。

デバイス テンプレート
template string

デバイスのデバイス テンプレート定義。

戻り値

この操作の出力は状況に応じて変わります。

デバイスのリレーションシップを作成

デバイス ID とリレーションシップ ID を指定して、指定されたデバイスと新しいデバイスの間に、新しいデバイスのリレーションシップを作成します。

パラメーター

名前 キー 必須 説明
アプリケーション
application True string

アプリケーションの一意の ID。

Relationship ID
relationship_id True string

デバイスの関連付けを表す一意の ID。

Device ID
device_id True string

デバイスの一意の ID。

デバイス関連付け ID
id string

デバイスの関連付けを表す一意の ID。

デバイス関連付けターゲット ID
target True string

ソース (子) デバイスのデバイス ID。

戻り値

デバイスのリレーションシップを削除

デバイス ID とリレーションシップ ID を指定して既存のデバイスのリレーションシップを削除します。

パラメーター

名前 キー 必須 説明
アプリケーション
application True string

アプリケーションの一意の ID。

Device ID
device_id True string

デバイスの一意の ID。

Relationship ID
relationship_id True string

デバイスの関連付けを表す一意の ID。

デバイスのリレーションシップを取得する

デバイス ID とリレーションシップ ID を指定して既存のデバイスのリレーションシップに関する情報を入手します。

パラメーター

名前 キー 必須 説明
アプリケーション
application True string

アプリケーションの一意の ID。

Device ID
device_id True string

デバイスの一意の ID。

Relationship ID
relationship_id True string

デバイスの関連付けを表す一意の ID。

戻り値

デバイスのリレーションシップを更新

デバイス ID とリレーションシップ ID を指定して、指定されたデバイスと新しいデバイスの間の、既存のデバイスのリレーションシップを更新します。

パラメーター

名前 キー 必須 説明
アプリケーション
application True string

アプリケーションの一意の ID。

Device ID
device_id True string

デバイスの一意の ID。

Relationship ID
relationship_id True string

デバイスの関連付けを表す一意の ID。

デバイス関連付け ID
id string

デバイスの関連付けを表す一意の ID。

デバイス関連付けターゲット ID
target True string

ソース (子) デバイスのデバイス ID。

戻り値

デバイスの作成または更新 (非推奨)

新しいデバイスを作成するか、デバイス ID で既存のデバイスを更新します。 (非推奨)

パラメーター

名前 キー 必須 説明
アプリケーション
application True string

アプリケーションの一意の ID。

Device ID
device_id True string

デバイスの一意の ID。

Device ID
id string

デバイスの一意の ID。

デバイス名
displayName string

デバイスの表示名。

デバイス テンプレート
template string

デバイスのデバイス テンプレート定義。

シミュレート済み
simulated boolean

デバイスがシミュレートされているかどうか。

Enabled
enabled boolean

IoT Central とのデバイス接続が有効になっているかどうか。

プロビジョニング済み
provisioned boolean

デバイスにリソースが割り当てられているかどうか。

戻り値

Body
DeviceV1

デバイスの作成または更新 (非推奨)

新しいデバイスを作成するか、デバイス ID で既存のデバイスを更新します (非推奨)。

パラメーター

名前 キー 必須 説明
アプリケーション
application True string

アプリケーションの一意の ID。

Device ID
device_id True string

デバイスの一意の ID。

Device ID
id string

デバイスの一意の ID。

デバイス名
displayName string

デバイスの表示名。

デバイス テンプレート
instanceOf string

デバイスのデバイス テンプレート定義。

シミュレート
simulated boolean

デバイスがシミュレートされているかどうかを示します。

承認済
approved boolean

デバイスが IoT Central への接続を承認されているかどうかを示します。

プロビジョニング済み
provisioned boolean

デバイスにリソースが割り当てられているかどうか。

戻り値

本文​​
Device

デバイスの削除 (非推奨)

デバイス ID で既存のデバイスを削除します (非推奨)。

パラメーター

名前 キー 必須 説明
アプリケーション
application True string

アプリケーションの一意の ID。

Device ID
device_id True string

デバイスの一意の ID。

デバイスの状態を取得

ジョブ ID を指定して個々のデバイスの状態の一覧を取得します。

パラメーター

名前 キー 必須 説明
アプリケーション
application True string

アプリケーションの一意の ID。

ジョブ ID
job_id True string

ジョブを表す一意の ID。

戻り値

ジョブ デバイスの状態のページごとの結果です。

デバイスを一覧表示

アプリケーションのデバイスの一覧を取得します。

パラメーター

名前 キー 必須 説明
アプリケーション
application True string

アプリケーションの一意の ID。

戻り値

デバイスを作成または更新する

新しいデバイスを作成するか、デバイス ID で既存のデバイスを更新します。

パラメーター

名前 キー 必須 説明
アプリケーション
application True string

アプリケーションの一意の ID。

Device ID
device_id True string

デバイスの一意の ID。

Device ID
id string

デバイスの一意の ID。

デバイス名
displayName string

デバイスの表示名。

デバイス テンプレート
template string

デバイスのデバイス テンプレート定義。

シミュレート済み
simulated boolean

デバイスがシミュレートされているかどうか。

有効化
enabled boolean

IoT Central とのデバイス接続が有効になっているかどうか。

組織
organizations array of string

デバイスの組織のリスト。現在対応しているのは 1 つの組織のみです。間もなく複数の組織に対応する予定です。

プロビジョニング済み
provisioned boolean

デバイスにリソースが割り当てられているかどうか。

戻り値

Body
DeviceV2

デバイスを削除する

デバイス ID で既存のデバイスを削除します。

パラメーター

名前 キー 必須 説明
アプリケーション
application True string

アプリケーションの一意の ID。

Device ID
device_id True string

デバイスの一意の ID。

モジュール コマンドを実行する

モジュールでコマンドを実行します。

パラメーター

名前 キー 必須 説明
アプリケーション
application True string

アプリケーションの一意の ID。

Device ID
device_id True string

デバイスの一意の ID。

デバイス モジュール
module True string

デバイス モジュールの名前。

デバイス コマンド
command_name True string

このデバイス コマンドの名前。

デバイス テンプレート
template string

デバイスのデバイス テンプレート定義。

body
body True dynamic

デバイス コマンドの本文。

戻り値

この操作の出力は状況に応じて変わります。

モジュール コンポーネント コマンドを実行する

モジュール コンポーネントでコマンドを実行します。

パラメーター

名前 キー 必須 説明
アプリケーション
application True string

アプリケーションの一意の ID。

Device ID
device_id True string

デバイスの一意の ID。

デバイス モジュール
module True string

デバイス モジュールの名前。

デバイス コンポーネント
component_name True string

デバイス コンポーネントの名前。

デバイス コマンド
command_name True string

このデバイス コマンドの名前。

デバイス テンプレート
template string

デバイスのデバイス テンプレート定義。

body
body True dynamic

デバイス コマンドの本文。

戻り値

この操作の出力は状況に応じて変わります。

モジュール コンポーネントのコマンド応答を取得

モジュール コンポーネント コマンドの最後の応答を取得します。

パラメーター

名前 キー 必須 説明
アプリケーション
application True string

アプリケーションの一意の ID。

Device ID
device_id True string

デバイスの一意の ID。

デバイス モジュール
module True string

デバイス モジュールの名前。

デバイス コンポーネント
component_name True string

デバイス コンポーネントの名前。

デバイス コマンド
command_name True string

このデバイス コマンドの名前。

デバイス テンプレート
template string

デバイスのデバイス テンプレート定義。

戻り値

この操作の出力は状況に応じて変わります。

モジュール コンポーネントのテレメトリ値を取得する

モジュール コンポーネントから最後のテレメトリ値を取得します。

パラメーター

名前 キー 必須 説明
アプリケーション
application True string

アプリケーションの一意の ID。

Device ID
device_id True string

デバイスの一意の ID。

デバイス モジュール
module True string

デバイス モジュールの名前。

デバイス コンポーネント
component_name True string

デバイス コンポーネントの名前。

デバイス テレメトリ
telemetry_name True string

このデバイス テレメトリの名前。

デバイス テンプレート
template string

デバイスのデバイス テンプレート定義。

戻り値

この操作の出力は状況に応じて変わります。

モジュールのコマンド応答を取得

デバイス モジュール コマンドの最後の応答を取得

パラメーター

名前 キー 必須 説明
アプリケーション
application True string

アプリケーションの一意の ID。

Device ID
device_id True string

デバイスの一意の ID。

デバイス モジュール
module True string

デバイス モジュールの名前。

デバイス コマンド
command_name True string

このデバイス コマンドの名前。

デバイス テンプレート
template string

デバイスのデバイス テンプレート定義。

戻り値

この操作の出力は状況に応じて変わります。

モジュールのテレメトリ値を取得する

モジュールから最後のテレメトリ値を取得します。

パラメーター

名前 キー 必須 説明
アプリケーション
application True string

アプリケーションの一意の ID。

Device ID
device_id True string

デバイスの一意の ID。

デバイス モジュール
module True string

デバイス モジュールの名前。

デバイス テレメトリ
telemetry_name True string

このデバイス テレメトリの名前。

デバイス テンプレート
template string

デバイスのデバイス テンプレート定義。

戻り値

この操作の出力は状況に応じて変わります。

モジュールのプロパティを取得する

モジュールのプロパティ値をすべて取得します。

パラメーター

名前 キー 必須 説明
アプリケーション
application True string

アプリケーションの一意の ID。

Device ID
device_id True string

デバイスの一意の ID。

デバイス モジュール
module True string

デバイス モジュールの名前。

デバイス テンプレート
template string

デバイスのデバイス テンプレート定義。

戻り値

この操作の出力は状況に応じて変わります。

モジュールのプロパティを更新する

モジュールのプロパティ値をすべて更新します。

パラメーター

名前 キー 必須 説明
アプリケーション
application True string

アプリケーションの一意の ID。

Device ID
device_id True string

デバイスの一意の ID。

デバイス モジュール
module True string

デバイス モジュールの名前。

デバイス テンプレート
template string

デバイスのデバイス テンプレート定義。

body
body True dynamic

デバイスのプロパティ。

戻り値

この操作の出力は状況に応じて変わります。

ユーザーを一覧表示する

アプリケーションのユーザーの一覧を取得

パラメーター

名前 キー 必須 説明
アプリケーション
application True string

アプリケーションの一意の ID。

戻り値

ユーザーを作成

アプリケーションでユーザーを作成する

パラメーター

名前 キー 必須 説明
アプリケーション
application True string

アプリケーションの一意の ID。

User
user_id True string

ユーザーを表す一意の ID。

ユーザーの種類
user_type string

ユーザーの種類。

Body
body True dynamic

ユーザーが作成した本文です。

戻り値

この操作の出力は状況に応じて変わります。

ユーザーを削除

ユーザーの削除

パラメーター

名前 キー 必須 説明
アプリケーション
application True string

アプリケーションの一意の ID。

User
user_id True string

ユーザーを表す一意の ID。

ユーザーを取得する

ID でユーザーを取得

パラメーター

名前 キー 必須 説明
アプリケーション
application True string

アプリケーションの一意の ID。

User
user_id True string

ユーザーを表す一意の ID。

戻り値

ユーザーを更新する

アプリケーションのユーザーを修正プログラムで更新する

パラメーター

名前 キー 必須 説明
アプリケーション
application True string

アプリケーションの一意の ID。

User
user_id True string

ユーザーを表す一意の ID。

ユーザーの種類
user_type string

ユーザーの種類。

Body
body True dynamic

ユーザーが更新した本文です。

戻り値

この操作の出力は状況に応じて変わります。

リレーションシップ一覧を取得

デバイス ID を指定してリレーションシップの一覧を取得します。

パラメーター

名前 キー 必須 説明
アプリケーション
application True string

アプリケーションの一意の ID。

Device ID
device_id True string

デバイスの一意の ID。

戻り値

ロールを一覧表示

アプリケーションのロールの一覧を取得します。

パラメーター

名前 キー 必須 説明
アプリケーション
application True string

アプリケーションの一意の ID。

戻り値

ロールを取得

ID でロールを取得します。

パラメーター

名前 キー 必須 説明
アプリケーション
application True string

アプリケーションの一意の ID。

役割
role_id True string

ロールを示す一意の ID です。

戻り値

Body
RoleV1

停止したジョブを再開する

既存の停止中のジョブの実行を再開します。

パラメーター

名前 キー 必須 説明
アプリケーション
application True string

アプリケーションの一意の ID。

ジョブ ID
job_id True string

ジョブを表す一意の ID。

実行中のジョブを停止します

現在実行中のジョブの実行を停止します。

パラメーター

名前 キー 必須 説明
アプリケーション
application True string

アプリケーションの一意の ID。

ジョブ ID
job_id True string

ジョブを表す一意の ID。

組織を一覧表示する

アプリケーション内の組織の一覧を取得します。

パラメーター

名前 キー 必須 説明
アプリケーション
application True string

アプリケーションの一意の ID。

戻り値

組織を作成する

新しい組織を作成します。

パラメーター

名前 キー 必須 説明
アプリケーション
application True string

アプリケーションの一意の ID。

組織 ID
organization_id True string

組織を表す一意の ID。

組織 ID
id string

組織を表す一意の ID。

組織名
displayName string

組織の表示名です。

上位
parent string

親組織の表示名です。

戻り値

組織を削除する

ID を指定して既存の組織を削除する

パラメーター

名前 キー 必須 説明
アプリケーション
application True string

アプリケーションの一意の ID。

組織 ID
organization_id True string

組織を表す一意の ID。

組織を取得する

ID を指定して既存の組織の詳細を取得します。

パラメーター

名前 キー 必須 説明
アプリケーション
application True string

アプリケーションの一意の ID。

組織 ID
organization_id True string

組織を表す一意の ID。

戻り値

トリガー

ルールの実行時

IoT Central でルールが実行されたときにトリガーするアクションを作成します。

ルールの実行時

IoT Central でルールが実行されたときにトリガーするアクションを作成します。

パラメーター

名前 キー 必須 説明
アプリケーション
application True string

アプリケーションの一意の ID。

ワークフロー トリガー ID
id string

ワークフロー トリガーの一意の ID。

規則
rule True string

ワークフロー トリガーに関連付けられているルールの一意の ID。

戻り値

この操作の出力は状況に応じて変わります。

定義

デバイス

名前 パス 説明
デバイス ID
id string

デバイスを表す一意の ID。

デバイス名
displayName string

デバイスの表示名。

デバイス テンプレート
instanceOf string

デバイスのデバイス テンプレート定義。

シミュレート
simulated boolean

デバイスがシミュレートされているかどうかを示します。

承認済
approved boolean

デバイスが IoT Central への接続を承認されているかどうかを示します。

プロビジョニング済み
provisioned boolean

デバイスにリソースが割り当てられているかどうか。

DeviceV1

名前 パス 説明
デバイス ID
id string

デバイスの一意の ID。

デバイス名
displayName string

デバイスの表示名。

デバイス テンプレート
template string

デバイスのデバイス テンプレート定義。

シミュレート済み
simulated boolean

デバイスがシミュレートされているかどうか。

Enabled
enabled boolean

IoT Central とのデバイス接続が有効になっているかどうか。

プロビジョニング済み
provisioned boolean

デバイスにリソースが割り当てられているかどうか。

DeviceV2

名前 パス 説明
Device ID
id string

デバイスの一意の ID。

デバイス名
displayName string

デバイスの表示名。

デバイス テンプレート
template string

デバイスのデバイス テンプレート定義。

シミュレート済み
simulated boolean

デバイスがシミュレートされているかどうか。

有効化
enabled boolean

IoT Central とのデバイス接続が有効になっているかどうか。

組織
organizations array of string

デバイスの組織のリスト。現在対応しているのは 1 つの組織のみです。間もなく複数の組織に対応する予定です。

プロビジョニング済み
provisioned boolean

デバイスにリソースが割り当てられているかどうか。

DeviceCollectionV1

名前 パス 説明
価値
value array of DeviceV1

デバイスのコレクションです。

nextLink
nextLink string

デバイスの次のページを取得する URL です。

DeviceGroup

デバイス グループ定義です。

名前 パス 説明
デバイス グループ ID
id string

デバイス グループを表す一意の ID。

Display Name
displayName string

デバイス グループの表示名です。

フィルター
filter string

このグループに含めるデバイスを定義するクエリです。

Description
description string

デバイス グループの短い概要です。

ETag
etag string

デバイス グループの更新での競合を防ぐために使用される ETag です。

組織
organizations array of string

デバイス グループの組織のリスト。現在対応しているのは 1 つの組織のみです。間もなく複数の組織に対応する予定です。

DeviceGroupCollection

デバイス グループのページごとの結果です。

名前 パス 説明
デバイス グループ ID
value array of DeviceGroup

デバイス グループのコレクションです。

nextLink
nextLink string

デバイス グループの次のページを取得する URL です。

DeviceGroupDeviceCollection

デバイス グループに属するデバイスのページごとの結果です。

名前 パス 説明
価値
value array of DeviceV1

デバイス グループに属するデバイスのコレクションです。

nextLink
nextLink string

グループに含まれるデバイスの次のページを取得する URL です。

DeviceRelationshipStatic

名前 パス 説明
デバイス関連付け ID
id string

デバイスの関連付けを表す一意の ID。

デバイス リレーションシップ ソース ID
source string

ソース (親) デバイスのデバイス ID です。

デバイス関連付けターゲット ID
target string

ソース (子) デバイスのデバイス ID。

DeviceRelationshipCollection

名前 パス 説明
価値
value array of DeviceRelationshipStatic

デバイス リレーションシップのコレクションです。

nextLink
nextLink string

デバイス リレーションシップの次のページを取得する URL です。

DeviceTemplateV1

名前 パス 説明
デバイス テンプレート ID
@id string

デバイス テンプレートを表す一意の ID です。

デバイス テンプレートの種類
@type array of string

このデバイス テンプレートの JSON-LD の種類です。

デバイス テンプレート名
displayName string

デバイス テンプレートの表示名です。

デバイス テンプレートの説明
description string

デバイス テンプレートの詳細な説明です。

デバイス テンプレート機能モデル
capabilityModel

このデバイス テンプレートで使用される機能モデルです。

DeviceTemplateCollectionV1

名前 パス 説明
価値
value array of DeviceTemplateV1

デバイス テンプレートのコレクションです。

nextLink
nextLink string

デバイス テンプレートの次のページを取得する URL です。

JobDeviceStatus

ジョブ デバイスの状態の定義です。

名前 パス 説明
Device ID
id string

ジョブの状態が入力されるデバイスの ID です。

デバイスの状態
status string

指定されたデバイスでジョブが開始中か、実行中かなどを示します。

JobDeviceStatusCollection

ジョブ デバイスの状態のページごとの結果です。

名前 パス 説明
価値
value array of JobDeviceStatus

ジョブ デバイスの状態のコレクションです。

nextLink
nextLink string

ジョブのデバイス状態の次のページを取得する URL です。

JobBatch

ジョブのバッチ定義です。

名前 パス 説明
バッチの種類
type string

バッチ処理を実行するのが、指定した数のデバイスでか、またはデバイス全体の割合でか。

バッチの値
value number

バッチ処理を実行するデバイスの数または割合。

JobCancellationThreshold

ジョブ キャンセルのしきい値の定義です。

名前 パス 説明
キャンセルのしきい値の種類
type string

キャンセルのしきい値を、指定された数のデバイスごとに適用するか、デバイス合計数に対して指定された割合で適用するかを示します。

キャンセルのしきい値
value number

キャンセルのしきい値が適用されるデバイスの数または割合です。

キャンセルのしきい値バッチ
batch boolean

キャンセルのしきい値をバッチごとに適用するか、ジョブ全体に適用するかを示します。

JobStatic

ジョブ定義。

名前 パス 説明
ジョブ ID
id string

ジョブを表す一意の ID。

Display Name
displayName string

ジョブの表示名。

Description
description string

ジョブの詳細な説明。

デバイス グループ
group string

ジョブを実行するデバイス グループの ID。

バッチ
batch JobBatch

ジョブのバッチ定義です。

cancellationThreshold
cancellationThreshold JobCancellationThreshold

ジョブ キャンセルのしきい値の定義です。

日付
data array of object

このジョブによって実行されている操作に関連するデータ。 すべてのエンティティは同じ種類にする必要があります。

アイテム
data object
組織
organizations array of string

ジョブの組織のリスト。現在対応しているのは 1 つの組織のみです。間もなく複数の組織に対応する予定です。

スケジュール済みジョブ ID
scheduledJobId string

このジョブを作成したスケジュール済みジョブ定義の ID。

JobCollection

ジョブのページごとの結果です。

名前 パス 説明
価値
value array of JobStatic

ジョブのコレクション。

nextLink
nextLink string

ジョブの次のページを取得する URL。

Organization

名前 パス 説明
組織 ID
id string

組織を表す一意の ID。

組織名
displayName string

組織の表示名です。

上位
parent string

親組織の表示名です。

OrganizationCollection

名前 パス 説明
価値
value array of Organization

組織のコレクションです。

nextLink
nextLink string

組織の次のページを取得する URL です。

RoleV1

名前 パス 説明
id
id string

ロールを表す一意の ID です。

displayName
displayName string

ロールの表示名です。

RoleCollectionV1

名前 パス 説明
価値
value array of RoleV1

ロールのコレクションです。

ScheduledJobStatic

スケジュールしたジョブの定義。

名前 パス 説明
ETag
etag string

スケジュールしたジョブの更新で競合を防ぐために使用する ETag。

スケジュール済みジョブ ID
id string

スケジュール済みジョブを表す一意の ID。

Display Name
displayName string

スケジュールしたジョブの表示名。

Description
description string

スケジュールしたジョブの詳細な説明。

デバイス グループ
group string

ジョブを実行するデバイス グループの ID。

バッチ
batch JobBatch

ジョブのバッチ定義です。

cancellationThreshold
cancellationThreshold JobCancellationThreshold

ジョブ キャンセルのしきい値の定義です。

日付
data array of object

このジョブによって実行されている操作に関連するデータ。 すべてのエンティティは同じ種類にする必要があります。

アイテム
data object
組織
organizations array of string

ジョブの組織のリスト。現在対応しているのは 1 つの組織のみです。間もなく複数の組織に対応する予定です。

スケジュール
schedule object

ジョブを実行するスケジュール。

有効化
enabled boolean

スケジュール済みジョブが有効かどうか。

Completed
completed boolean

スケジュール済みジョブが完了したかどうか。

ScheduledJobJobCollection

スケジュールされたジョブに属するジョブ定義のページごとの結果です。

名前 パス 説明
価値
value array of JobStatic

ジョブのコレクション。

nextLink
nextLink string

ジョブの次のページを取得する URL。

UserStaticV1

名前 パス 説明
User ID
id string

ユーザーを表す一意の ID。

ユーザーの種類
type string

ユーザーの種類。

役割
roles array of RoleAssignmentV1

アプリケーションへのアクセス許可を指定するロール割り当ての一覧です。

UserCollectionV1

名前 パス 説明
ユーザー
value array of UserStaticV1

ユーザーのコレクションです。

RoleAssignmentV1

名前 パス 説明
役割
role string

このロール割り当てのロールの ID です。