az iot ops schema
Note
このリファレンスは、Azure CLI (バージョン 2.53.0 以降) の azure-iot-ops 拡張機能の一部です。 拡張機能は、 az iot ops schema コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細を参照してください。
このコマンド グループはプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus
スキーマとレジストリの管理。
スキーマは、処理とコンテキスト化を可能にするデータを記述するドキュメントです。 メッセージ スキーマは、メッセージの形式とその内容を記述します。 スキーマを作成および管理するには、スキーマ レジストリが必要です。
コマンド
名前 | 説明 | 型 | 状態 |
---|---|---|---|
az iot ops schema create |
スキーマ レジストリ内にスキーマを作成します。 |
拡張子 | プレビュー |
az iot ops schema delete |
スキーマ レジストリ内のターゲット スキーマを削除します。 |
拡張子 | プレビュー |
az iot ops schema list |
スキーマ レジストリ内のスキーマを一覧表示します。 |
拡張子 | プレビュー |
az iot ops schema registry |
スキーマ レジストリの管理。 |
拡張子 | プレビュー |
az iot ops schema registry create |
スキーマ レジストリを作成します。 |
拡張子 | プレビュー |
az iot ops schema registry delete |
ターゲット スキーマ レジストリを削除します。 |
拡張子 | プレビュー |
az iot ops schema registry list |
リソース グループまたはサブスクリプション内のスキーマ レジストリを一覧表示します。 |
拡張子 | プレビュー |
az iot ops schema registry show |
スキーマ レジストリの詳細を表示します。 |
拡張子 | プレビュー |
az iot ops schema show |
スキーマ レジストリ内のスキーマの詳細を表示します。 |
拡張子 | プレビュー |
az iot ops schema show-dataflow-refs |
データフローに使用されるスキーマ参照を表示します。 |
拡張子 | 実験的 |
az iot ops schema version |
スキーマ バージョン管理。 |
拡張子 | プレビュー |
az iot ops schema version add |
スキーマにスキーマ バージョンを追加します。 |
拡張子 | プレビュー |
az iot ops schema version list |
特定のスキーマのスキーマ バージョンを一覧表示します。 |
拡張子 | プレビュー |
az iot ops schema version remove |
ターゲット スキーマ バージョンを削除します。 |
拡張子 | プレビュー |
az iot ops schema version show |
スキーマ バージョンの詳細を表示します。 |
拡張子 | プレビュー |
az iot ops schema create
コマンド グループ 'iot ops スキーマ' はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus
スキーマ レジストリ内にスキーマを作成します。
この操作には、事前に作成されたスキーマ レジストリが必要であり、スキーマ バージョンが追加されます。 スキーマを作成してバージョンを追加するには、関連付けられているストレージ アカウントでパブリック ネットワーク アクセスを有効にする必要があります。 デルタ ファイル形式の詳細については、aka.ms/lakehouse-delta-sample を参照してください。
az iot ops schema create --format {delta, json}
--name
--registry
--resource-group
--type {message}
--vc
[--desc]
[--display-name]
[--vd]
[--ver]
例
レジストリ 'myregistry' に "myschema" という名前のスキーマを、最小入力で作成します。 スキーマ バージョン 1 は、ファイルの内容を含むこのスキーマに対して作成されます。
az iot ops schema create -n myschema -g myresourcegroup --registry myregistry --format json --type message --version-content myschema.json
追加のカスタマイズを使用して、"myschema" という名前のスキーマを作成します。 このスキーマのスキーマ バージョン 14 が作成されます。 インライン コンテンツは PowerShell 構文の例です。
az iot ops schema create -n myschema -g myresourcegroup --registry myregistry --format delta --type message --desc "Schema for Assets" --display-name myassetschema --version-content '{\"hello\": \"world\"}' --ver 14 --vd "14th version"
"myschema" という名前のスキーマを作成します。 このスキーマのスキーマ バージョン 1 が作成されます。 インライン コンテンツは cmd 構文の例です。
az iot ops schema create -n myschema -g myresourcegroup --registry myregistry --format json --type message --version-content "{\"hello\": \"world\"}"
"myschema" という名前のスキーマを作成します。 このスキーマのスキーマ バージョン 1 が作成されます。 インライン コンテンツは bash 構文の例です。
az iot ops schema create -n myschema -g myresourcegroup --registry myregistry --format json --type message --version-content '{"hello": "world"}'
必須のパラメーター
スキーマ形式。
スキーマ名。
スキーマ レジストリ名。
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
スキーマの種類。
バージョンのコンテンツを含むファイル パスまたはインライン コンテンツ。
省略可能のパラメーター
スキーマの説明。
スキーマの表示名。
バージョンの説明。
スキーマ バージョン名。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az iot ops schema delete
コマンド グループ 'iot ops スキーマ' はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus
スキーマ レジストリ内のターゲット スキーマを削除します。
az iot ops schema delete --name
--registry
--resource-group
[--yes {false, true}]
例
スキーマ レジストリ 'myregistry' 内のターゲット スキーマ 'myschema' を削除します。
az iot ops schema delete --name myschema --registry myregistry -g myresourcegroup
必須のパラメーター
スキーマ名。
スキーマ レジストリ名。
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
省略可能のパラメーター
プロンプトなしで [y] es を確認します。 CI と自動化のシナリオに役立ちます。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az iot ops schema list
コマンド グループ 'iot ops スキーマ' はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus
スキーマ レジストリ内のスキーマを一覧表示します。
az iot ops schema list --registry
--resource-group
例
スキーマ レジストリ 'myregistry' のスキーマ レジスタを一覧表示します。
az iot ops schema list -g myresourcegroup --registry myregistry
必須のパラメーター
スキーマ レジストリ名。
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az iot ops schema show
コマンド グループ 'iot ops スキーマ' はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus
スキーマ レジストリ内のスキーマの詳細を表示します。
az iot ops schema show --name
--registry
--resource-group
例
スキーマ レジストリ 'myregistry' 内のターゲット スキーマ 'myschema' の詳細を表示します。
az iot ops schema show --name myschema --registry myregistry -g myresourcegroup
必須のパラメーター
スキーマ名。
スキーマ レジストリ名。
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az iot ops schema show-dataflow-refs
このコマンドは試験段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus
データフローに使用されるスキーマ参照を表示します。
az iot ops schema show-dataflow-refs --registry
--resource-group
[--latest {false, true}]
[--schema]
[--ver]
例
スキーマ "myschema" とバージョン 1 のスキーマ参照を表示します。
az iot ops schema show-dataflow-refs --version 1 --schema myschema --registry myregistry -g myresourcegroup
スキーマ "myschema" のすべてのバージョンのスキーマ参照を表示します。
az iot ops schema show-dataflow-refs --schema myschema --registry myregistry -g myresourcegroup
スキーマ レジストリ "myregistry" のすべてのバージョンとスキーマのスキーマ参照を表示します。
az iot ops schema show-dataflow-refs --registry myregistry -g myresourcegroup
すべてのスキーマのスキーマ参照を表示しますが、スキーマ レジストリ "myregistry" の最新バージョンのみを表示します。
az iot ops schema show-dataflow-refs --registry myregistry -g myresourcegroup --latest
必須のパラメーター
スキーマ レジストリ名。
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
省略可能のパラメーター
最新バージョンのみを表示するフラグ。
スキーマ名。 --version を使用する場合は必須。
スキーマ バージョン名。 使用した場合、--latest は無視されます。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
Azure CLI