az dt job import

Note

This reference is part of the azure-iot extension for the Azure CLI (version 2.59.0 or higher). 拡張機能は、az dt job import コマンドを初めて実行するときに自動的にインストールされます。 Learn more about extensions.

モデル、ツイン、リレーションシップのデータをデジタル ツイン インスタンスにインポートするためのジョブを管理および構成します。

コマンド

名前	説明	型	状態
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 job import cancel

デジタル ツイン インスタンスで実行されたデータ インポート ジョブを取り消します。

az dt job import cancel --dt-name --dtn
                        --job-id
                        [--resource-group]
                        [--yes]

例

ジョブ ID でデータ インポート ジョブを取り消します。

az dt job import cancel -n {instance_or_hostname} -j {job_id}

必須のパラメーター

--dt-name --dtn -n

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

--job-id -j

ジョブの ID。 ジョブの作成時にこのパラメーターが割り当てられると、システム生成 ID が割り当てられます。

省略可能のパラメーター

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}を使用して既定のグループを構成できます。

--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 job import create

デジタル ツイン インスタンスでデータ インポート ジョブを作成して実行します。

このコマンドを実行するには、入力インポート データ ファイル (.ndjson 形式) が入力 BLOB コンテナーに存在する必要があります。 さらに、使用する DT インスタンスには、入力ストレージ アカウントに "ストレージ BLOB データ共同作成者" ロールが設定されている必要があります。 ジョブが完了すると、ジョブのログとエラーを含む出力ファイルが作成されます。

az dt job import create --data-file --df
                        --dt-name --dtn
                        --ibc --input-blob-container
                        --input-storage-account --isa
                        [--job-id]
                        [--obc --output-blob-container]
                        [--of --output-file]
                        [--osa --output-storage-account]
                        [--resource-group]

例

Azure Storage コンテナーに格納されているデータ ファイルをインポートするためのジョブを作成します。 インポート ジョブの出力ファイルは、入力ファイルの BLOB コンテナーに作成されます。

az dt job import create -n {instance_or_hostname} --data-file {data_file_name} --input-blob-container {input_blob_container_name} --input-storage-account {input_storage_account_name} --output-file {output_file_name}

Azure ストレージ コンテナーに格納されているデータ ファイルをインポートするためのジョブを作成します。 インポート ジョブの出力ファイルは、ユーザー定義のストレージ アカウントと BLOB コンテナーに作成されます。

az dt job import create -n {instance_or_hostname} --data-file {data_file_name} --input-blob-container {input_blob_container_name} --input-storage-account {input_storage_account_name} --output-file {output_file_name} --output-blob-container {output_blob_container_name} --output-storage-account {output_storage_account_name}

必須のパラメーター

--data-file --df

一括インポート ジョブへのデータ ファイル入力の名前。 ファイルは 'ndjson' 形式である必要があります。 サンプル入力データ ファイル: https://github.com/Azure/azure-iot-cli-extension/tree/dev/docs/samples/adt-bulk-import-data-sample.ndjson。

プロパティ	値
Parameter group:	Bulk Import Job Arguments

--dt-name --dtn -n

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

--ibc --input-blob-container

一括インポート データ ファイルを含む Azure Storage BLOB コンテナーの名前。

プロパティ	値
Parameter group:	Bulk Import Job Arguments

--input-storage-account --isa

一括インポート データ ファイルを格納する BLOB コンテナーを含む Azure Storage アカウントの名前。

プロパティ	値
Parameter group:	Bulk Import Job Arguments

省略可能のパラメーター

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

--job-id -j

ジョブの ID。 ジョブの作成時にこのパラメーターが割り当てられると、システム生成 ID が割り当てられます。

--obc --output-blob-container

一括インポート ジョブの出力ファイルが作成される Azure Storage BLOB コンテナーの名前。 指定しない場合は、入力 BLOB コンテナーを使用します。

プロパティ	値
Parameter group:	Bulk Import Job Arguments

--of --output-file

一括インポート ジョブの出力ファイルの名前。 このファイルには、ログとエラー情報が含まれます。 ジョブが完了すると、ファイルが自動的に作成されます。 ファイルが既に存在する場合は上書きされます。 指定されていない場合、出力ファイルは {job_id}_output.txtという名前で作成されます。

プロパティ	値
Parameter group:	Bulk Import Job Arguments

--osa --output-storage-account

一括インポート ジョブの出力ファイルが作成される BLOB コンテナーを含む Azure Storage アカウントの名前。 指定しない場合は、入力ストレージ アカウントを使用します。

プロパティ	値
Parameter group:	Bulk Import Job Arguments

--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 job import delete

デジタル ツイン インスタンスで実行されるデータ インポート ジョブを削除します。

az dt job import delete --dt-name --dtn
                        --job-id
                        [--resource-group]
                        [--yes]

例

ジョブ ID でデータ インポート ジョブを削除します。

az dt job import delete -n {instance_or_hostname} -j {job_id}

必須のパラメーター

--dt-name --dtn -n

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

--job-id -j

ジョブの ID。 ジョブの作成時にこのパラメーターが割り当てられると、システム生成 ID が割り当てられます。

省略可能のパラメーター

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}を使用して既定のグループを構成できます。

--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 job import list

デジタル ツイン インスタンスで実行されたすべてのデータ インポート ジョブを一覧表示します。

az dt job import list --dt-name --dtn
                      [--resource-group]

例

ターゲット デジタル ツイン インスタンス上のすべてのデータ インポート ジョブを一覧表示します。

az dt job import list -n {instance_or_hostname}

必須のパラメーター

--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 job import show

デジタル ツイン インスタンスで実行されたデータ インポート ジョブの詳細を表示します。

az dt job import show --dt-name --dtn
                      --job-id
                      [--resource-group]

例

データ インポート ジョブの詳細をジョブ ID で表示します。

az dt job import show -n {instance_or_hostname} -j {job_id}

必須のパラメーター

--dt-name --dtn -n

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

--job-id -j

ジョブの ID。 ジョブの作成時にこのパラメーターが割り当てられると、システム生成 ID が割り当てられます。

省略可能のパラメーター

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