az dt

Note

This reference is part of the azure-iot extension for the Azure CLI (version 2.59.0 or higher). The extension will automatically install the first time you run an az dt command. Learn more about extensions.

Azure Digital Twins のソリューションとインフラストラクチャを管理します。

コマンド

名前	説明	型	状態
az dt create	Digital Twins インスタンスを作成または更新します。	Extension	GA
az dt data-history	データ履歴を管理および構成します。	Extension	GA
az dt data-history connection	データ履歴接続を管理および構成します。	Extension	GA
az dt data-history connection create	Digital Twins インスタンスとサポートされているリソースの間にデータ履歴接続を作成します。	Extension	GA
az dt data-history connection create adx	Digital Twins インスタンスと Azure Data Explorer データベースの間にデータ履歴接続を作成します。 事前に作成された Azure Data Explorer と Event Hub リソースが必要です。	Extension	GA
az dt data-history connection delete	Digital Twins インスタンスで構成されたデータ履歴接続を削除します。	Extension	GA
az dt data-history connection list	Digital Twins インスタンスで構成されているすべてのデータ履歴接続を一覧表示します。	Extension	GA
az dt data-history connection show	Digital Twins インスタンスで構成されたデータ履歴接続の詳細を表示します。	Extension	GA
az dt data-history connection wait	データ履歴接続に対する操作が完了するまで待ちます。	Extension	GA
az dt delete	既存の Digital Twins インスタンスを削除します。	Extension	GA
az dt endpoint	Digital Twins インスタンス エンドポイントを管理および構成します。	Extension	GA
az dt endpoint create	Digital Twins インスタンスにエグレス エンドポイントを追加します。	Extension	GA
az dt endpoint create eventgrid	EventGrid トピック エンドポイントを Digital Twins インスタンスに追加します。 事前に作成されたリソースが必要です。	Extension	GA
az dt endpoint create eventhub	Digital Twins インスタンスに EventHub エンドポイントを追加します。	Extension	GA
az dt endpoint create servicebus	ServiceBus トピック エンドポイントを Digital Twins インスタンスに追加します。	Extension	GA
az dt endpoint delete	Digital Twins インスタンスからエンドポイントを削除します。	Extension	GA
az dt endpoint list	Digital Twins インスタンスで構成されているすべてのエグレス エンドポイントを一覧表示します。	Extension	GA
az dt endpoint show	Digital Twins インスタンスで構成されたエンドポイントの詳細を表示します。	Extension	GA
az dt endpoint wait	エンドポイント操作が完了するまで待ちます。	Extension	GA
az dt identity	Digital Twins インスタンスの ID を管理します。	Extension	GA
az dt identity assign	マネージド ID を Digital Twins インスタンスに割り当てます。	Extension	GA
az dt identity remove	Digital Twins インスタンスからマネージド ID を削除します。	Extension	GA
az dt identity show	Digital Twins インスタンスの ID プロパティを表示します。	Extension	GA
az dt job	デジタル ツイン インスタンスのジョブを管理および構成します。	Extension	GA
az dt job deletion	デジタル ツイン インスタンス内のモデル、ツイン、リレーションシップのデータを削除するためのジョブを管理および構成します。	Extension	GA
az dt job deletion create	デジタル ツイン インスタンスで削除ジョブを作成して実行します。	Extension	GA
az dt job deletion list	デジタル ツイン インスタンスで実行されたすべての削除ジョブを一覧表示します。	Extension	GA
az dt job deletion show	デジタル ツイン インスタンスで実行された削除ジョブの詳細を表示します。	Extension	GA
az dt job import	モデル、ツイン、リレーションシップのデータをデジタル ツイン インスタンスにインポートするためのジョブを管理および構成します。	Extension	GA
az dt job import cancel	デジタル ツイン インスタンスで実行されたデータ インポート ジョブを取り消します。	Extension	GA
az dt job import create	デジタル ツイン インスタンスでデータ インポート ジョブを作成して実行します。	Extension	GA
az dt job import delete	デジタル ツイン インスタンスで実行されるデータ インポート ジョブを削除します。	Extension	GA
az dt job import list	デジタル ツイン インスタンスで実行されたすべてのデータ インポート ジョブを一覧表示します。	Extension	GA
az dt job import show	デジタル ツイン インスタンスで実行されたデータ インポート ジョブの詳細を表示します。	Extension	GA
az dt list	サブスクリプションまたはリソース グループ別に Digital Twins インスタンスのコレクションを一覧表示します。	Extension	GA
az dt model	Digital Twins インスタンスで DTDL モデルと定義を管理します。	Extension	GA
az dt model create	1 つ以上のモデルをアップロードします。	Extension	GA
az dt model delete	モデルを削除します。 モデルは、他のモデルが参照していない場合にのみ削除できます。	Extension	GA
az dt model delete-all	Digital Twins インスタンス内のすべてのモデルを削除します。	Extension	GA
az dt model list	モデルのメタデータ、定義、依存関係を一覧表示します。	Extension	GA
az dt model show	ターゲット モデルまたはモデル定義を取得します。	Extension	GA
az dt model update	モデルのメタデータを更新します。 現在、モデルはデコミットのみ可能です。	Extension	GA
az dt network	プライベート リンクやエンドポイント接続を含む Digital Twins ネットワーク構成を管理します。	Extension	GA
az dt network private-endpoint	Digital Twins インスタンスのプライベート エンドポイントを管理します。	Extension	GA
az dt network private-endpoint connection	Digital Twins インスタンスのプライベート エンドポイント接続を管理します。	Extension	GA
az dt network private-endpoint connection delete	Digital Twins インスタンスに関連付けられているプライベート エンドポイント接続を削除します。	Extension	GA
az dt network private-endpoint connection list	Digital Twins インスタンスに関連付けられているプライベート エンドポイント接続を一覧表示します。	Extension	GA
az dt network private-endpoint connection set	Digital Twins インスタンスに関連付けられているプライベート エンドポイント接続の状態を設定します。	Extension	GA
az dt network private-endpoint connection show	Digital Twins インスタンスに関連付けられているプライベート エンドポイント接続を表示します。	Extension	GA
az dt network private-endpoint connection wait	プライベート エンドポイント接続の操作が完了するまで待ちます。	Extension	GA
az dt network private-link	Digital Twins インスタンスのプライベート リンク操作を管理します。	Extension	GA
az dt network private-link list	Digital Twins インスタンスに関連付けられているプライベート リンクを一覧表示します。	Extension	GA
az dt network private-link show	インスタンスに関連付けられているプライベート リンクを表示します。	Extension	GA
az dt role-assignment	Digital Twins インスタンスの RBAC ロールの割り当てを管理します。	Extension	GA
az dt role-assignment create	Digital Twins インスタンスに対してロールにユーザー、グループ、またはサービス プリンシパルを割り当てます。	Extension	GA
az dt role-assignment delete	Digital Twins インスタンスからユーザー、グループ、またはサービス プリンシパルロールの割り当てを削除します。	Extension	GA
az dt role-assignment list	Digital Twins インスタンスの既存のロールの割り当てを一覧表示します。	Extension	GA
az dt route	イベント ルートを管理および構成します。	Extension	GA
az dt route create	Digital Twins インスタンスにイベント ルートを追加します。	Extension	GA
az dt route delete	Digital Twins インスタンスからイベント ルートを削除します。	Extension	GA
az dt route list	Digital Twins インスタンスの構成済みイベント ルートを一覧表示します。	Extension	GA
az dt route show	Digital Twins インスタンスで構成されたイベント ルートの詳細を表示します。	Extension	GA
az dt show	既存の Digital Twins インスタンスを表示します。	Extension	GA
az dt twin	Digital Twins インスタンスのデジタル ツインを管理および構成します。	Extension	GA
az dt twin component	Digital Twins インスタンスのデジタル ツイン コンポーネントを表示および更新します。	Extension	GA
az dt twin component show	デジタル ツイン コンポーネントの詳細を表示します。	Extension	GA
az dt twin component update	JSON パッチ仕様を使用してデジタル ツイン コンポーネントを更新します。	Extension	GA
az dt twin create	インスタンスにデジタル ツインを作成します。	Extension	GA
az dt twin delete	デジタル ツインを削除します。 このツインを参照するすべてのリレーションシップは既に削除されている必要があります。	Extension	GA
az dt twin delete-all	Digital Twins インスタンス内のすべてのデジタル ツイン (それらのツインのすべてのリレーションシップを含む) を削除します。	Extension	GA
az dt twin query	インスタンスのデジタル ツインに対してクエリを実行します。 リレーションシップの走査とプロパティ値によるフィルター処理を許可します。	Extension	GA
az dt twin relationship	Digital Twins インスタンスのデジタル ツインリレーションシップを管理および構成します。	Extension	GA
az dt twin relationship create	ソースとターゲットのデジタル ツインの間にリレーションシップを作成します。	Extension	GA
az dt twin relationship delete	Digital Twins インスタンスのデジタル ツインリレーションシップを削除します。	Extension	GA
az dt twin relationship delete-all	受信リレーションシップを含め、Digital Twins インスタンス内のすべてのデジタル ツイン リレーションシップを削除します。	Extension	GA
az dt twin relationship list	デジタル ツインのリレーションシップを一覧表示します。	Extension	GA
az dt twin relationship show	デジタル ツインリレーションシップの詳細を表示します。	Extension	GA
az dt twin relationship update	JSON パッチ仕様を使用して、2 つのデジタル ツイン間のリレーションシップのプロパティを更新します。	Extension	GA
az dt twin show	デジタル ツインの詳細を表示します。	Extension	GA
az dt twin telemetry	Digital Twins インスタンスのイベント ルートとエンドポイントをテストして検証します。	Extension	GA
az dt twin telemetry send	デジタル ツインに代わってテレメトリを送信します。 コンポーネント パスが指定されている場合、出力されるテレメトリはコンポーネントの代わりに使用されます。	Extension	GA
az dt twin update	JSON パッチ仕様を使用してインスタンス デジタル ツインを更新します。	Extension	GA
az dt wait	Digital Twins インスタンスの操作が完了するまで待ちます。	Extension	GA

az dt create

Digital Twins インスタンスを作成または更新します。

az dt create --dt-name --dtn
             --resource-group
             [--assign-identity {false, true}]
             [--location]
             [--mi-system-assigned {false, true}]
             [--mi-user-assigned]
             [--no-wait]
             [--pna --public-network-access {Disabled, Enabled}]
             [--role]
             [--scopes]
             [--tags]

例

リソース グループの場所を使用して、ターゲット リソース グループにインスタンスを作成します。

az dt create -n {instance_name} -g {resouce_group}

指定した場所とタグを使用して、ターゲット リソース グループにインスタンスを作成します。

az dt create -n {instance_name} -g {resouce_group} -l westus --tags a=b c=d

システム マネージド ID を使用して、ターゲット リソース グループ内にインスタンスを作成します。

az dt create -n {instance_name} -g {resouce_group} --mi-system-assigned

ユーザー マネージド ID を使用して、ターゲット リソース グループ内にインスタンスを作成します。

az dt create -n {instance_name} -g {resouce_group} --mi-user-assigned {resource_id}

システム マネージド ID と複数のユーザー マネージド ID を使用して、ターゲット リソース グループ内にインスタンスを作成します。

az dt create -n {instance_name} -g {resouce_group} --mi-system-assigned --mi-user-assigned {resource_id} {resource_id}

システム マネージド ID を持つターゲット リソース グループにインスタンスを作成し、共同作成者のロールを持つ 1 つ以上のスコープ (スペース区切り) に ID を割り当てます。

az dt create -n {instance_name} -g {resouce_group} --mi-system-assigned --scopes "/subscriptions/a12345ea-bb21-994d-2263-c716348e32a1/resourceGroups/ProResourceGroup/providers/Microsoft.EventHub/namespaces/myEventHubNamespace/eventhubs/myEventHub" "/subscriptions/a12345ea-bb21-994d-2263-c716348e32a1/resourceGroups/ProResourceGroup/providers/Microsoft.ServiceBus/namespaces/myServiceBusNamespace/topics/myTopic"

システム マネージド ID を持つターゲット リソース グループにインスタンスを作成し、カスタム指定ロールを持つ 1 つ以上のスコープに ID を割り当てます。

az dt create -n {instance_name} -g {resouce_group} --mi-system-assigned --scopes "/subscriptions/a12345ea-bb21-994d-2263-c716348e32a1/resourceGroups/ProResourceGroup/providers/Microsoft.EventHub/namespaces/myEventHubNamespace/eventhubs/myEventHub" "/subscriptions/a12345ea-bb21-994d-2263-c716348e32a1/resourceGroups/ProResourceGroup/providers/Microsoft.ServiceBus/namespaces/myServiceBusNamespace/topics/myTopic" --role MyCustomRole

ターゲット リソース グループ内のインスタンスを新しいタグ値で更新し、パブリック ネットワーク アクセスを無効にします。

az dt create -n {instance_name} -g {resouce_group} --tags env=prod --public-network-access Disabled

必須のパラメーター

--dt-name --dtn -n

Digital Twins インスタンス名。

--resource-group -g

Digital Twins インスタンス リソース グループ。 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.

--assign-identity

非推奨

引数 'assign_identity' は非推奨となり、今後のリリースで削除される予定です。 代わりに '--mi-system-assigned' を使用してください。

システムによって生成された ID を Digital Twins インスタンスに割り当てます。

プロパティ	値
Parameter group:	Managed Service Identity Arguments
指定可能な値:	false, true

--location -l

Digital Twins インスタンスの場所。 場所が指定されていない場合は、リソース グループの場所が使用されます。az configure --defaults location={name}を使用して、既定の場所を構成できます。

--mi-system-assigned

システムによって生成された ID をこの Digital Twins インスタンスに割り当てます。

プロパティ	値
Parameter group:	Managed Service Identity Arguments
指定可能な値:	false, true

--mi-user-assigned

Digital Twins インスタンスに追加するスペース区切りのユーザー ID リソース ID。

プロパティ	値
Parameter group:	Managed Service Identity Arguments

--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

プロパティ	値
規定値:	False

--pna --public-network-access

Digital Twins インスタンスにパブリック ネットワークからアクセスできるかどうかを判断します。

プロパティ	値
Parameter group:	Network Arguments
規定値:	Enabled
指定可能な値:	Disabled, Enabled

--role

システム割り当て ID が持つロール名または ID。

プロパティ	値
Parameter group:	Managed Service Identity Arguments
規定値:	Contributor

--scopes

システム割り当て ID がアクセスできるスペース区切りのスコープ。 --no-wait では使用できません。

プロパティ	値
Parameter group:	Managed Service Identity Arguments

--tags

Digital Twins インスタンス タグ。 次の形式のキーと値のペアのプロパティ バッグ: a=b c=d。

グローバル パラメーター

--debug

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

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	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 dt delete

既存の Digital Twins インスタンスを削除します。

az dt delete --dt-name --dtn
             [--no-wait]
             [--resource-group]
             [--yes]

例

確認プロンプトを使用して、ブロックする方法で任意のインスタンスを削除します。

az dt delete -n {instance_name}

ブロックまたはプロンプトなしで任意のインスタンスを削除します。

az dt delete -n {instance_name} -y --no-wait

必須のパラメーター

--dt-name --dtn -n

Digital Twins インスタンス名。

省略可能のパラメーター

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

--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

プロパティ	値
規定値:	False

--resource-group -g

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

--yes -y

確認を求めないでください。

プロパティ	値
規定値:	False

グローバル パラメーター

--debug

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

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	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 dt list

サブスクリプションまたはリソース グループ別に Digital Twins インスタンスのコレクションを一覧表示します。

az dt list [--resource-group]

例

現在のサブスクリプション内のすべてのインスタンスを一覧表示します。

az dt list

ターゲット リソース グループ内のすべてのインスタンスを一覧表示し、テーブル形式で出力します。

az dt list -g {resource_group} --output table

条件を満たすサブスクリプション内のすべてのインスタンスを一覧表示します。

az dt list --query "[?contains(name, 'Production')]"

条件を満たすインスタンスをカウントします。

az dt list --query "length([?contains(name, 'Production')])"

省略可能のパラメーター

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

--resource-group -g

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

グローバル パラメーター

--debug

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

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	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 dt show

既存の Digital Twins インスタンスを表示します。

az dt show --dt-name --dtn
           [--resource-group]

例

インスタンスを表示します。

az dt show -n {instance_name}

インスタンスとプロジェクトの特定のプロパティを表示します。

az dt show -n {instance_name} --query "{Endpoint:hostName, Location:location}"

必須のパラメーター

--dt-name --dtn -n

Digital Twins インスタンス名。

省略可能のパラメーター

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

--resource-group -g

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

グローバル パラメーター

--debug

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

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	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 dt wait

Digital Twins インスタンスの操作が完了するまで待ちます。

az dt wait --dt-name --dtn
           [--created]
           [--custom]
           [--deleted]
           [--exists]
           [--interval]
           [--resource-group]
           [--timeout]

例

任意のインスタンスが作成されるまで待ちます。

az dt wait -n {instance_name} --created

既存のインスタンスが削除されるまで待ちます。

az dt wait -n {instance_name} --deleted

既存のインスタンスの publicNetworkAccess プロパティが Enabled に設定されるまで待ちます

az dt wait -n {instance_name} --custom "publicNetworkAccess=='Enabled'"

必須のパラメーター

--dt-name --dtn -n

Digital Twins インスタンス名。

省略可能のパラメーター

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

--created

'provisioningState' が 'Succeeded' で作成されるまで待ちます。

プロパティ	値
Parameter group:	Wait Condition Arguments
規定値:	False

--custom

条件がカスタム JMESPath クエリを満たすまで待ちます。 例: provisioningState!='InProgress'、instanceView.statuses[?code=='PowerState/running']。

プロパティ	値
Parameter group:	Wait Condition Arguments

--deleted

削除されるまで待ちます。

プロパティ	値
Parameter group:	Wait Condition Arguments
規定値:	False

--exists

リソースが存在するまで待ちます。

プロパティ	値
Parameter group:	Wait Condition Arguments
規定値:	False

--interval

ポーリング間隔 (秒単位)。

プロパティ	値
Parameter group:	Wait Condition Arguments
規定値:	30

--resource-group -g

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

--timeout

最大待機時間 (秒単位)。

プロパティ	値
Parameter group:	Wait Condition Arguments
規定値:	3600

グローバル パラメーター

--debug

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

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	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