az iot ops schema

プレビュー

Note

このリファレンスは、Azure CLI (バージョン 2.62.0 以降) の azure-iot-ops 拡張機能の一部です。拡張機能は、az iot ops schema コマンドを初めて実行するときに自動的にインストールされます。拡張機能の詳細については、を参照してください。

このコマンドグループはプレビュー段階であり、開発中です。参照レベルとサポートレベル: https://aka.ms/CLI_refstatus

スキーマとレジストリの管理。

スキーマは、処理とコンテキスト化を可能にするデータを記述するドキュメントです。メッセージスキーマは、メッセージの形式とその内容を記述します。スキーマを作成および管理するには、スキーマレジストリが必要です。

コマンド

名前	説明	型	状態
az iot ops schema create	スキーマレジストリ内にスキーマを作成します。	Extension	Preview
az iot ops schema delete	スキーマレジストリ内のターゲットスキーマを削除します。	Extension	Preview
az iot ops schema list	スキーマレジストリ内のスキーマを一覧表示します。	Extension	Preview
az iot ops schema registry	スキーマレジストリの管理。	Extension	Preview
az iot ops schema registry create	スキーマレジストリを作成する。	Extension	Preview
az iot ops schema registry delete	ターゲットスキーマレジストリを削除します。	Extension	Preview
az iot ops schema registry list	リソースグループまたはサブスクリプション内のスキーマレジストリを一覧表示します。	Extension	Preview
az iot ops schema registry show	スキーマレジストリの詳細を表示します。	Extension	Preview
az iot ops schema show	スキーマレジストリ内のスキーマの詳細を表示します。	Extension	Preview
az iot ops schema show-dataflow-refs	データフローに使用されるスキーマ参照を表示します。	Extension	Experimental
az iot ops schema version	スキーマバージョン管理。	Extension	Preview
az iot ops schema version add	スキーマにスキーマバージョンを追加します。	Extension	Preview
az iot ops schema version list	特定のスキーマのスキーマバージョンを一覧表示します。	Extension	Preview
az iot ops schema version remove	ターゲットスキーマバージョンを削除します。	Extension	Preview
az iot ops schema version show	スキーマバージョンの詳細を表示します。	Extension	Preview

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 --version-content
                         [--desc]
                         [--display-name]
                         [--vd --version-desc]
                         [--ver --version]

例

レジストリ 'myregistry' に "myschema" という名前のスキーマを、最小入力で作成します。スキーマバージョン 1 は、ファイルの内容を含むこのスキーマに対して作成されます。

az iot ops schema create -n myschema -g myresourcegroup --registry myregistry --format json --type message --version-content myschema.json

追加のカスタマイズを使用して、"myschema" という名前のスキーマを作成します。このスキーマのスキーマバージョン 14 が作成されます。インラインコンテンツは bash 構文の例です。その他の例については、https://aka.ms/inline-json-examples を参照してください。

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"

必須のパラメーター

--format

スキーマ形式。

プロパティ	値
指定可能な値:	delta, json

--name -n

スキーマ名。

--registry

スキーマレジストリ名。

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

--type

スキーマの種類。

プロパティ	値
指定可能な値:	message

--vc --version-content

バージョンのコンテンツを含むファイルパスまたはインラインコンテンツ。

プロパティ	値
Parameter group:	Version Arguments

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--desc

スキーマの説明。

--display-name

スキーマの表示名。

--vd --version-desc

バージョンの説明。

プロパティ	値
Parameter group:	Version Arguments

--ver --version

スキーマバージョン名。

プロパティ	値
Parameter group:	Version Arguments
規定値:	1

グローバルパラメーター

--debug

ログの詳細度を上げて、すべてのデバッグログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。完全なデバッグログには --debug を使用します。

プロパティ	値
規定値:	False

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

必須のパラメーター

--name -n

スキーマ名。

--registry

スキーマレジストリ名。

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--yes -y

プロンプトなしで [y] es を確認します。 CI と自動化のシナリオに役立ちます。

プロパティ	値
指定可能な値:	false, true

グローバルパラメーター

--debug

ログの詳細度を上げて、すべてのデバッグログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。完全なデバッグログには --debug を使用します。

プロパティ	値
規定値:	False

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

必須のパラメーター

--registry

スキーマレジストリ名。

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

グローバルパラメーター

--debug

ログの詳細度を上げて、すべてのデバッグログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。完全なデバッグログには --debug を使用します。

プロパティ	値
規定値:	False

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

必須のパラメーター

--name -n

スキーマ名。

--registry

スキーマレジストリ名。

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

グローバルパラメーター

--debug

ログの詳細度を上げて、すべてのデバッグログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。完全なデバッグログには --debug を使用します。

プロパティ	値
規定値:	False

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 --version]

例

スキーマ "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

必須のパラメーター

--registry

スキーマレジストリ名。

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--latest

最新バージョンのみを表示するフラグ。

プロパティ	値
指定可能な値:	false, true

--schema

スキーマ名。 --version を使用する場合は必須。

--ver --version

スキーマバージョン名。使用した場合、--latest は無視されます。

グローバルパラメーター

--debug

ログの詳細度を上げて、すべてのデバッグログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。完全なデバッグログには --debug を使用します。

プロパティ	値
規定値:	False

次の方法で共有

az iot ops schema

コマンド

az iot ops schema create

例

必須のパラメーター

省略可能のパラメーター

az iot ops schema delete

例

必須のパラメーター

省略可能のパラメーター

az iot ops schema list

例

必須のパラメーター

az iot ops schema show

例

必須のパラメーター

az iot ops schema show-dataflow-refs

例

必須のパラメーター

省略可能のパラメーター

フィードバック