az dt data-history connection create
Note
This reference is part of the azure-iot extension for the Azure CLI (version 2.59.0 or higher). 拡張機能は、az dt data-history connection create コマンド 初めて実行するときに自動的にインストールされます。 Learn more about extensions.
Digital Twins インスタンスとサポートされているリソースの間にデータ履歴接続を作成します。
コマンド
名前 | 説明 | 型 | 状態 |
---|---|---|---|
az dt data-history connection create adx |
Digital Twins インスタンスと Azure Data Explorer データベースの間にデータ履歴接続を作成します。 事前に作成された Azure Data Explorer と Event Hub リソースが必要です。 |
Extension | GA |
az dt data-history connection create adx
Digital Twins インスタンスと Azure Data Explorer データベースの間にデータ履歴接続を作成します。 事前に作成された Azure Data Explorer と Event Hub リソースが必要です。
接続を正常に作成するために必要な Digital Twins インスタンスまたはユーザー割り当て ID に対して、次のロールとアクセス許可を追加するようユーザーに求めます。
- Azure Data Explorer データベース スコープの "共同作成者" ロール
- Azure Data Explorer データベース スコープの 'データベース管理者' アクセス許可
- イベント ハブ スコープの "Azure Event Hubs データ所有者" ロール。
az dt data-history connection create adx --adx-cluster-name --adxc
--adx-database-name --adxd
--cn --conn-name
--dt-name --dtn
--eh --eventhub
--ehn --eventhub-namespace
[--adx-property-events-table --adxpet]
[--adx-record-removals --adxrr {false, true}]
[--adx-relationship-events-table --adxret]
[--adx-resource-group --adxg]
[--adx-subscription --adxs]
[--adx-table-name --adxt]
[--adx-twin-events-table --adxtet]
[--ehc --eventhub-consumer-group]
[--ehg --eventhub-resource-group]
[--ehs --eventhub-subscription]
[--mi-user-assigned --user]
[--no-wait]
[--resource-group]
[--yes]
例
$Default Event Hub コンシューマー グループを使用して、ターゲット Digital Twins インスタンスにデータ履歴接続を追加します。
az dt data-history connection create adx -n {instance_name} --cn {time_series_database_connection_name} --adx-cluster-name {adx_cluster_name} --adx-database-name {adx_database_name} --eventhub {event_hub} --eventhub-namespace {event_hub_namespace}
デジタル ツインに関連付けられたユーザー割り当て ID と $Default Event Hub コンシューマー グループを使用して、ターゲット Digital Twins インスタンスにデータ履歴接続を追加します。
az dt data-history connection create adx -n {instance_name} --cn {time_series_database_connection_name} --adx-cluster-name {adx_cluster_name} --adx-database-name {adx_database_name} --eventhub {event_hub} --eventhub-namespace {event_hub_namespace} --mi-user-assigned {resource_id}
カスタムの Azure Data Explorer テーブル名と Event Hub コンシューマー グループを使用して、ターゲット Digital Twins インスタンスにデータ履歴接続を追加します。
az dt data-history connection create adx -n {instance_name} --cn {time_series_database_connection_name} --adx-cluster-name {adx_cluster_name} --adx-database-name {adx_database_name} --adx-property-events-table {adx_property_events_table_name} --eventhub {event_hub} --eventhub-namespace {event_hub_namespace} --eventhub-consumer-group {event_hub_consumer_group}
ターゲット インスタンスとは異なるリソース グループとサブスクリプション内の Event Hub および Azure Data Explorer インスタンスと統合されたターゲット Digital Twins インスタンスにデータ履歴接続を追加します。
az dt data-history connection create adx -n {instance_name} --cn {time_series_database_connection_name} --adx-cluster-name {adx_cluster_name} --adx-database-name {adx_database_name} --adx-resource-group {adx_resource_group} --adx-subscription {adx_subscription} --eventhub {event_hub} --eventhub-namespace {event_hub_namespace} --eventhub-resource-group {event_hub_resource_group} --eventhub-subscription {event_subscription}
$Default Event Hub コンシューマー グループを使用してターゲット Digital Twins インスタンスにデータ履歴接続を追加し、ロールの割り当てプロンプトをスキップします。
az dt data-history connection create adx -n {instance_name} -y --cn {time_series_database_connection_name} --adx-cluster-name {adx_cluster_name} --adx-database-name {adx_database_name} --eventhub {event_hub} --eventhub-namespace {event_hub_namespace}
$Default Event Hub コンシューマー グループを使用してターゲット Digital Twins インスタンスにデータ履歴接続を追加し、レコード プロパティと項目の削除を有効にします。 ツインとリレーションシップのプロパティの更新を格納するために使用されるテーブルに列が追加されます (既定では AdtPropertyEvents)。
az dt data-history connection create adx -n {instance_name} --cn {time_series_database_connection_name} --adx-cluster-name {adx_cluster_name} --adx-database-name {adx_database_name} --eventhub {event_hub} --eventhub-namespace {event_hub_namespace} --adx-record-removals true
$Default Event Hub コンシューマー グループを使用してターゲット Digital Twins インスタンスにデータ履歴接続を追加し、Azure Data Explorer データベースに 2 つの追加テーブルを作成します。 1 つのテーブルはツイン ライフサイクル イベントを記録するためのテーブルで、もう 1 つはリレーションシップ ライフサイクル イベント用です。
az dt data-history connection create adx -n {instance_name} --cn {time_series_database_connection_name} --adx-cluster-name {adx_cluster_name} --adx-database-name {adx_database_name} --eventhub {event_hub} --eventhub-namespace {event_hub_namespace} --adx-twin-events-table {adx_twin_events_table_name} --adx-relationship-events-table {adx_relationship_events_table_name}
$Default Event Hub コンシューマー グループを使用してターゲット Digital Twins インスタンスにデータ履歴接続を追加し、カスタム ツイン プロパティのイベント テーブル名を使用して、Azure Data Explorer データベースに 2 つの追加テーブルを作成します。
az dt data-history connection create adx -n {instance_name} --cn {time_series_database_connection_name} --adx-cluster-name {adx_cluster_name} --adx-database-name {adx_database_name} --eventhub {event_hub} --eventhub-namespace {event_hub_namespace} --adx-property-events-table {adx_property_events_table_name} --adx-twin-events-table {adx_twin_events_table_name} --adx-relationship-events-table {adx_relationship_events_table_name}
必須のパラメーター
統合する Azure Data Explorer クラスターの名前。
プロパティ | 値 |
---|---|
Parameter group: | Azure Data Explorer Arguments |
統合する Azure Data Explorer データベースの名前。
プロパティ | 値 |
---|---|
Parameter group: | Azure Data Explorer Arguments |
データ履歴接続の名前。
Digital Twins インスタンス名。
統合する EventHub の名前。
プロパティ | 値 |
---|---|
Parameter group: | Event Hub Arguments |
EventHub 名前空間識別子。
プロパティ | 値 |
---|---|
Parameter group: | Event Hub Arguments |
省略可能のパラメーター
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
ツインとリレーションシップのプロパティの更新を格納するために使用される Azure Data Explorer テーブルの名前。
プロパティ | 値 |
---|---|
Parameter group: | Azure Data Explorer Arguments |
規定値: | AdtPropertyEvents |
インデックス付き値またはキー付き値 (マップ エントリ、配列要素など) の削除を含む、ツイン/リレーションシップ プロパティと項目の削除を記録するかどうかを指定します。 このプロパティを 'true' に設定すると、ADX のプロパティ イベント テーブルに追加の列が生成されます。
プロパティ | 値 |
---|---|
Parameter group: | Azure Data Explorer Arguments |
規定値: | False |
指定可能な値: | false, true |
リレーションシップ ライフサイクル イベントの記録に使用される Azure Data Explorer テーブルの名前。 このプロパティが指定されていない場合、テーブルは作成されません。
プロパティ | 値 |
---|---|
Parameter group: | Azure Data Explorer Arguments |
Azure Data Explorer リソース グループの名前。 指定しない場合は、Digital Twin のリソース グループを使用します。
プロパティ | 値 |
---|---|
Parameter group: | Azure Data Explorer Arguments |
Azure Data Explorer が存在するサブスクリプションの名前または ID。 指定しない場合は、Digital Twin Instance を含むサブスクリプションを使用します。
プロパティ | 値 |
---|---|
Parameter group: | Azure Data Explorer Arguments |
オプション '--adx-table-name' は非推奨となり、今後のリリースで削除される予定です。 代わりに '--adx-property-events-table' を使用してください。
ツインとリレーションシップのプロパティの更新を格納するために使用される Azure Data Explorer テーブルの名前。
プロパティ | 値 |
---|---|
Parameter group: | Azure Data Explorer Arguments |
規定値: | AdtPropertyEvents |
ツイン ライフサイクル イベントの記録に使用される Azure Data Explorer テーブルの名前。 このプロパティが指定されていない場合、テーブルは作成されません。
プロパティ | 値 |
---|---|
Parameter group: | Azure Data Explorer Arguments |
ADX が EventHub から読み取るときに使用する EventHub コンシューマー グループ。
プロパティ | 値 |
---|---|
Parameter group: | Event Hub Arguments |
規定値: | $Default |
EventHub リソース グループの名前。 指定しない場合は、Digital Twin のリソース グループを使用します。
プロパティ | 値 |
---|---|
Parameter group: | Event Hub Arguments |
EventHub が存在するサブスクリプションの名前または ID。 指定しない場合は、Digital Twin Instance を含むサブスクリプションを使用します。
プロパティ | 値 |
---|---|
Parameter group: | Event Hub Arguments |
データ履歴接続認証には、ユーザー割り当てマネージド ID を使用します。 ID リソース ID を受け入れます。指定しない場合は、代わりにシステム ID を使用します。
実行時間の長い操作が完了するまで待つ必要はありません。
プロパティ | 値 |
---|---|
規定値: | False |
Digital Twins インスタンス リソース グループ。
az configure --defaults group={name}
を使用して既定のグループを構成できます。
必要なロールを割り当てるときに確認を求めないでください。
プロパティ | 値 |
---|---|
規定値: | False |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
Output format.
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |