az dt model

Note

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

Digital Twins インスタンスで DTDL モデルと定義を管理します。

コマンド

名前	説明	型	Status
az dt model create	1 つ以上のモデルをアップロードします。	拡張子	GA
az dt model delete	モデルを削除します。 モデルは、他のモデルが参照していない場合にのみ削除できます。	拡張子	GA
az dt model delete-all	Digital Twins インスタンス内のすべてのモデルを削除します。	拡張子	GA
az dt model list	モデルのメタデータ、定義、依存関係を一覧表示します。	拡張子	GA
az dt model show	ターゲット モデルまたはモデル定義を取得します。	拡張子	GA
az dt model update	モデルのメタデータを更新します。 現在、モデルはデコミットのみ可能です。	拡張子	GA

az dt model create

1 つ以上のモデルをアップロードします。

--models には、インライン json またはファイル パスを指定できます。 入力モデル セット (オントロジ) のサイズは、DT インスタンスが格納できるモデルの最大数によって制限されます (既定値は 1,0000 モデル)。

az dt model create --dt-name
                   [--failure-policy {None, Rollback}]
                   [--fd]
                   [--max-models-per-batch]
                   [--models]
                   [--resource-group]

例

ターゲット ディレクトリからすべての .json または .dtdl モデル ファイルを一括アップロードします。 モデル処理は再帰的です。

az dt model create -n {instance_or_hostname} --from-directory {directory_path}

モデル json をインラインまたはファイル パスからアップロードします。

az dt model create -n {instance_or_hostname} --models {file_path_or_inline_json}

必須のパラメーター

--dt-name --dtn -n

Digital Twins インスタンス名またはホスト名。 インスタンス名が指定されている場合、ユーザー サブスクリプションは、最初にターゲット インスタンスに対してクエリを実行してホスト名を取得します。 ホスト名が指定されている場合、サブスクリプション クエリはスキップされ、指定された値は後続の操作に使用されます。

省略可能のパラメーター

--failure-policy --fp

モデル バッチの処理中にエラーが発生した場合のエラー ポリシーを示します。 "ロールバック" モードでは、前のバッチで作成されたすべてのモデルが一度に 1 つずつ削除されます。 [なし] として選択した場合、前のバッチで作成されたモデルは DT インスタンスから削除されません。

承認された値: None, Rollback

既定値: Rollback

--fd --from-directory

ディレクトリ JSON モデル ファイルが解析されます。 注: モデルは、ディレクトリに 250 以下のモデルが含まれている場合にアトミックに作成されるため、エラーが発生した場合は、どのモデルも作成されません。ディレクトリに 250 を超えるモデル (API 制限) がある場合、入力モデル セットはチャンクされ、バッチで作成されます。 バッチの処理中にエラーが発生した場合、動作は --failure-policy パラメーターによって決定されます。

--max-models-per-batch --mmpb

実験用

250 を超えるモデルを作成するときのバッチあたりの最大モデル サイズ。DTDLParser エラーを防ぐために、この数を減らします。

既定値: 30

--models

インライン モデル JSON またはモデル JSON へのファイル パス。 注: モデル JSON に 250 以下のモデルが含まれている場合、モデルはアトミックに作成されるため、エラーが発生した場合は、どのモデルも作成されません。モデル JSON に 250 を超えるモデル (API 制限) がある場合、入力モデル セットはチャンクされ、バッチで作成されます。 バッチの処理中にエラーが発生した場合、動作は --failure-policy パラメーターによって決定されます。

--resource-group -g

Digital Twins インスタンス リソース グループ。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az dt model delete

モデルを削除します。 モデルは、他のモデルが参照していない場合にのみ削除できます。

az dt model delete --dt-name
                   --dtmi
                   [--resource-group]

例

ターゲット モデルを削除します。

az dt model delete -n {instance_or_hostname} --dtmi "dtmi:com:example:Floor;1"

必須のパラメーター

--dt-name --dtn -n

Digital Twins インスタンス名またはホスト名。 インスタンス名が指定されている場合、ユーザー サブスクリプションは、最初にターゲット インスタンスに対してクエリを実行してホスト名を取得します。 ホスト名が指定されている場合、サブスクリプション クエリはスキップされ、指定された値は後続の操作に使用されます。

--dtmi --model-id -m

Digital Twins モデル ID。例: dtmi:com:example:Room;2。

省略可能のパラメーター

--resource-group -g

Digital Twins インスタンス リソース グループ。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az dt model delete-all

Digital Twins インスタンス内のすべてのモデルを削除します。

ツインの構成は影響を受けませんが、モデル定義がないと破損する可能性があります。

az dt model delete-all --dt-name
                       [--resource-group]
                       [--yes]

例

すべてのモデルを削除します。

az dt model delete-all -n {instance_or_hostname}

必須のパラメーター

--dt-name --dtn -n

Digital Twins インスタンス名またはホスト名。 インスタンス名が指定されている場合、ユーザー サブスクリプションは、最初にターゲット インスタンスに対してクエリを実行してホスト名を取得します。 ホスト名が指定されている場合、サブスクリプション クエリはスキップされ、指定された値は後続の操作に使用されます。

省略可能のパラメーター

--resource-group -g

Digital Twins インスタンス リソース グループ。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--yes -y

確認のダイアログを表示しません。

既定値: False

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az dt model list

モデルのメタデータ、定義、依存関係を一覧表示します。

az dt model list --dt-name
                 [--def {false, true}]
                 [--dependencies-for]
                 [--resource-group]

例

モデルのメタデータを一覧表示する

az dt model list -n {instance_or_hostname}

モデル定義を一覧表示する

az dt model list -n {instance_or_hostname} --definition

既存の特定のモデルの依存関係を一覧表示します。 スペース区切りの dtmi 値。

az dt model list -n {instance_or_hostname} --dependencies-for {model_id0} {model_id1}

必須のパラメーター

--dt-name --dtn -n

Digital Twins インスタンス名またはホスト名。 インスタンス名が指定されている場合、ユーザー サブスクリプションは、最初にターゲット インスタンスに対してクエリを実行してホスト名を取得します。 ホスト名が指定されている場合、サブスクリプション クエリはスキップされ、指定された値は後続の操作に使用されます。

省略可能のパラメーター

--def --definition

操作によってモデル定義が取得されます。

承認された値: false, true

既定値: False

--dependencies-for

依存関係を取得するモデルのセット。 省略した場合、すべてのモデルが取得されます。 書式は空白で区切られたリストです。

--resource-group -g

Digital Twins インスタンス リソース グループ。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az dt model show

ターゲット モデルまたはモデル定義を取得します。

az dt model show --dt-name
                 --dtmi
                 [--def {false, true}]
                 [--resource-group]

例

モデルメタデータを表示する

az dt model show -n {instance_or_hostname} --dtmi "dtmi:com:example:Floor;1"

モデルメタデータと定義を表示する

az dt model show -n {instance_or_hostname} --dtmi "dtmi:com:example:Floor;1" --definition

必須のパラメーター

--dt-name --dtn -n

Digital Twins インスタンス名またはホスト名。 インスタンス名が指定されている場合、ユーザー サブスクリプションは、最初にターゲット インスタンスに対してクエリを実行してホスト名を取得します。 ホスト名が指定されている場合、サブスクリプション クエリはスキップされ、指定された値は後続の操作に使用されます。

--dtmi --model-id -m

Digital Twins モデル ID。例: dtmi:com:example:Room;2。

省略可能のパラメーター

--def --definition

操作によってモデル定義が取得されます。

承認された値: false, true

既定値: False

--resource-group -g

Digital Twins インスタンス リソース グループ。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az dt model update

モデルのメタデータを更新します。 現在、モデルはデコミットのみ可能です。

az dt model update --dt-name
                   --dtmi
                   [--decommission {false, true}]
                   [--resource-group]

例

ターゲット モデルのコミット解除

az dt model update -n {instance_or_hostname} --dtmi "dtmi:com:example:Floor;1" --decommission

必須のパラメーター

--dt-name --dtn -n

Digital Twins インスタンス名またはホスト名。 インスタンス名が指定されている場合、ユーザー サブスクリプションは、最初にターゲット インスタンスに対してクエリを実行してホスト名を取得します。 ホスト名が指定されている場合、サブスクリプション クエリはスキップされ、指定された値は後続の操作に使用されます。

--dtmi --model-id -m

Digital Twins モデル ID。例: dtmi:com:example:Room;2。

省略可能のパラメーター

--decommission

ターゲット モデルの使用を停止する意図を示します。

承認された値: false, true

--resource-group -g

Digital Twins インスタンス リソース グループ。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。