az iot central export
Note
このリファレンスは、Azure CLI (バージョン 2.46.0 以降) の azure-iot 拡張機能の一部です。 拡張機能は、az iot central export コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細をご覧ください。
このコマンド グループはプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus
IoT Central のデータ エクスポートを管理および構成します。
コマンド
名前 | 説明 | 型 | 状態 |
---|---|---|---|
az iot central export create |
IoT Central アプリケーションのエクスポートを作成します。 |
拡張子 | プレビュー |
az iot central export delete |
IoT Central アプリケーションのエクスポートを削除します。 |
拡張子 | プレビュー |
az iot central export destination |
IoT Central エクスポート先を管理および構成します。 |
拡張子 | プレビュー |
az iot central export destination create |
IoT Central アプリケーションのエクスポート先を作成します。 |
拡張子 | プレビュー |
az iot central export destination delete |
IoT Central アプリケーションのエクスポート先を削除します。 |
拡張子 | プレビュー |
az iot central export destination list |
IoT Central アプリケーションのエクスポート先の完全な一覧を取得します。 |
拡張子 | プレビュー |
az iot central export destination show |
エクスポート先の詳細を取得します。 |
拡張子 | プレビュー |
az iot central export destination update |
IoT Central アプリケーションのエクスポート先を更新します。 |
拡張子 | プレビュー |
az iot central export list |
IoT Central アプリケーションのエクスポートの完全な一覧を取得します。 |
拡張子 | プレビュー |
az iot central export show |
エクスポートの詳細を取得します。 |
拡張子 | プレビュー |
az iot central export update |
IoT Central アプリケーションのエクスポートを更新します。 |
拡張子 | プレビュー |
az iot central export create
コマンド グループ "iot central export" はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus
IoT Central アプリケーションのエクスポートを作成します。
az iot central export create --app-id
--destinations
--display-name
--export-id
--source {deviceConnectivity, deviceLifecycle, deviceTemplateLifecycle, properties, telemetry}
[--api-version {2022-06-30-preview}]
[--central-api-uri]
[--en]
[--enabled {false, true}]
[--filter]
[--token]
例
フィルター、エンリッチメント、宛先を使用してエクスポートを作成する
az iot central export create --app-id {appid} --export-id {exportid} --enabled {enabled} --display-name {displayname} --source {source} --filter "SELECT * FROM devices WHERE $displayName != "abc" AND $id = "a"" --enrichments '{
"simulated": {
"path": "$simulated"
}
}' --destinations '[
{
"id": "{destinationid}",
"transform": "{ ApplicationId: .applicationId, Component: .component, DeviceName: .device.name }"
}
]'
必須のパラメーター
管理する IoT Central アプリのアプリ ID。 アプリ ID は、アプリケーションの [バージョン情報] ページのヘルプ メニューにあります。
変換を含む変換先の一覧。
データ エクスポートの表示名。
エクスポートの一意識別子。
データ エクスポート ソース。
省略可能のパラメーター
引数 'api_version' は非推奨となり、今後のリリースで削除される予定です。
要求された操作の API バージョン。
アプリケーションに関連付けられている IoT Central DNS サフィックス。
データ エクスポート エンリッチメント。
データ エクスポートの有効な状態。True または False。
IoT Central クエリ言語ベースのフィルター。詳細情報: aka.ms/iotcquery。
Azure CLI に対して認証せずに要求を送信する場合は、要求を認証するための有効なユーザー トークンを指定できます。 要求の一部としてキーの種類を指定する必要があります。 詳細については、https://aka.ms/iotcentraldocsapi をご覧ください。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az iot central export delete
コマンド グループ "iot central export" はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus
IoT Central アプリケーションのエクスポートを削除します。
az iot central export delete --app-id
--export-id
[--api-version {2022-06-30-preview}]
[--central-api-uri]
[--token]
例
エクスポートを削除する
az iot central export delete --app-id {appid} --export-id {exportid}
必須のパラメーター
管理する IoT Central アプリのアプリ ID。 アプリ ID は、アプリケーションの [バージョン情報] ページのヘルプ メニューにあります。
エクスポートの一意識別子。
省略可能のパラメーター
引数 'api_version' は非推奨となり、今後のリリースで削除される予定です。
要求された操作の API バージョン。
アプリケーションに関連付けられている IoT Central DNS サフィックス。
Azure CLI に対して認証せずに要求を送信する場合は、要求を認証するための有効なユーザー トークンを指定できます。 要求の一部としてキーの種類を指定する必要があります。 詳細については、https://aka.ms/iotcentraldocsapi をご覧ください。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az iot central export list
コマンド グループ "iot central export" はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus
IoT Central アプリケーションのエクスポートの完全な一覧を取得します。
az iot central export list --app-id
[--api-version {2022-06-30-preview}]
[--central-api-uri]
[--token]
例
アプリケーション内のすべてのエクスポートを一覧表示する
az iot central export list --app-id {appid}
必須のパラメーター
管理する IoT Central アプリのアプリ ID。 アプリ ID は、アプリケーションの [バージョン情報] ページのヘルプ メニューにあります。
省略可能のパラメーター
引数 'api_version' は非推奨となり、今後のリリースで削除される予定です。
要求された操作の API バージョン。
アプリケーションに関連付けられている IoT Central DNS サフィックス。
Azure CLI に対して認証せずに要求を送信する場合は、要求を認証するための有効なユーザー トークンを指定できます。 要求の一部としてキーの種類を指定する必要があります。 詳細については、https://aka.ms/iotcentraldocsapi をご覧ください。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az iot central export show
コマンド グループ "iot central export" はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus
エクスポートの詳細を取得します。
az iot central export show --app-id
--export-id
[--api-version {2022-06-30-preview}]
[--central-api-uri]
[--token]
例
エクスポートの詳細を取得する
az iot central export show --app-id {appid} --export-id {exportid}
必須のパラメーター
管理する IoT Central アプリのアプリ ID。 アプリ ID は、アプリケーションの [バージョン情報] ページのヘルプ メニューにあります。
エクスポートの一意識別子。
省略可能のパラメーター
引数 'api_version' は非推奨となり、今後のリリースで削除される予定です。
要求された操作の API バージョン。
アプリケーションに関連付けられている IoT Central DNS サフィックス。
Azure CLI に対して認証せずに要求を送信する場合は、要求を認証するための有効なユーザー トークンを指定できます。 要求の一部としてキーの種類を指定する必要があります。 詳細については、https://aka.ms/iotcentraldocsapi をご覧ください。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az iot central export update
コマンド グループ "iot central export" はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus
IoT Central アプリケーションのエクスポートを更新します。
エクスポートが作成されると、ソースは変更できません。
az iot central export update --app-id
--content
--export-id
[--api-version {2022-06-30-preview}]
[--central-api-uri]
[--token]
例
ファイルからのエクスポートを更新する
az iot central export update --app-id {appid} --export-id {exportid} --content './filepath/payload.json'
エクスポートの表示名を更新し、json ペイロードからのエクスポートを有効にする
az iot central export update --app-id {appid} --export-id {exportid} --content "{'displayName': 'Updated Export Name', 'enabled': true}"
必須のパラメーター
管理する IoT Central アプリのアプリ ID。 アプリ ID は、アプリケーションの [バージョン情報] ページのヘルプ メニューにあります。
部分エクスポート定義。 JSON ファイルまたは未加工の文字列化された JSON へのパスを指定します。 [ファイル パスの例:./path/to/file.json][文字列化された JSON の例:{}]。 要求本文には、Export の部分的なコンテンツが含まれている必要があります。
エクスポートの一意識別子。
省略可能のパラメーター
引数 'api_version' は非推奨となり、今後のリリースで削除される予定です。
要求された操作の API バージョン。
アプリケーションに関連付けられている IoT Central DNS サフィックス。
Azure CLI に対して認証せずに要求を送信する場合は、要求を認証するための有効なユーザー トークンを指定できます。 要求の一部としてキーの種類を指定する必要があります。 詳細については、https://aka.ms/iotcentraldocsapi をご覧ください。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
Azure CLI