az datafactory data-flow

  • リファレンス

Note

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

Azure Data Factory でのデータ フローの管理と構成。

コマンド

名前 説明 型 Status
az datafactory data-flow create

ファクトリ内にデータ フローを作成します。

 拡張 GA
az datafactory data-flow delete

特定のファクトリ内の特定のデータ フローを削除します。

 拡張 GA
az datafactory data-flow list

指定されたファクトリ内のデータ フローを一覧表示します。

 拡張 GA
az datafactory data-flow show

指定したデータ フローに関する情報を表示します。

 拡張 GA
az datafactory data-flow update

ファクトリ内で指定されたデータ フローを更新します。

 拡張 GA

az datafactory data-flow create

ファクトリ内にデータ フローを作成します。

az datafactory data-flow create --data-flow-name
                                --factory-name
                                --flow-type
                                --properties
                                --resource-group
                                [--if-match]

例

Factories_DataFlowCreate

az datafactory data-flow create -g example-resource-group -f example-data-factory -n example-data-flow -t "Flowlet" --properties example-properties.json

必須のパラメーター

--data-flow-name --name -n

データ フロー名。

--factory-name -f

ファクトリ名。

--flow-type -t

データ フローの種類。 有効な選択肢: MappingDataFlow、Flowlet。

--properties

データフローの指定されたプロパティ。 予期される値: json-string/json-file/@json-file。

使用法: (インライン JSON の場合) --properties "{"name": "hello", "description": "Example description", "folder": "sub-folder", "annotations": " , typeProperties:{...} }"

  • name: データ フローの名前。 (ハイフンは使用しないでください。)
  • description: (省略可能) データ フローの説明。
  • folder: (省略可能) データ フローが編成されるフォルダー。
  • annotations: (省略可能) データ フローの注釈。
  • typeProperties: (省略可能) 指定されていない場合は、ジェネリック定義と空の定義が作成されます。 定義を含めるのが最善の方法は、Azure Portal の Data Factory Studio 内から JSON をコピーすることです。
--resource-group -g

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

省略可能のパラメーター

--if-match

データ フロー エンティティの ETag。 更新に対してのみ指定する必要があります。更新対象は既存のエンティティと一致する必要があり、無条件更新の場合は * にすることができます。

グローバル パラメーター
--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 datafactory data-flow delete

特定のファクトリ内の特定のデータ フローを削除します。

az datafactory data-flow delete [--data-flow-name]
                                [--factory-name]
                                [--ids]
                                [--resource-group]
                                [--subscription]

例

Factories_DataFlowDelete

az datafactory data-flow delete -g example-resource-group -f example-data-factory -n example-data-flow

省略可能のパラメーター

--data-flow-name --name -n

データ フロー名。

--factory-name -f

ファクトリ名。

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--resource-group -g

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

--subscription

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

グローバル パラメーター
--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 datafactory data-flow list

指定されたファクトリ内のデータ フローを一覧表示します。

az datafactory data-flow list --factory-name
                              --resource-group

例

Factories_DataFlowList

az datafactory data-flow list -g example-resource-group -f example-data-factory

必須のパラメーター

--factory-name -f

ファクトリ名。

--resource-group -g

リソース グループの名前。 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 datafactory data-flow show

指定したデータ フローに関する情報を表示します。

az datafactory data-flow show [--data-flow-name]
                              [--factory-name]
                              [--ids]
                              [--if-none-match]
                              [--resource-group]
                              [--subscription]

例

Factories_DataFlowShow

az datafactory data-flow show -g example-resource-group -f example-data-factory -n example-data-flow

省略可能のパラメーター

--data-flow-name --name -n

データ フロー名。

--factory-name -f

ファクトリ名。

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--if-none-match

パイプライン エンティティの ETag。 get にのみ指定する必要があります。 ETag が既存のエンティティ タグと一致する場合、または * が指定された場合、コンテンツは返されません。

--resource-group -g

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

--subscription

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

グローバル パラメーター
--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 datafactory data-flow update

ファクトリ内で指定されたデータ フローを更新します。

az datafactory data-flow update --properties
                                [--data-flow-name]
                                [--factory-name]
                                [--ids]
                                [--resource-group]
                                [--subscription]

例

Factories_DataFlowUpdate

az datafactory data-flow update -g example-resource-group -f example-data-factory -n example-data-flow --properties example-properties.json

必須のパラメーター

--properties

データフローの指定されたプロパティ。 予期される値: json-string/json-file/@json-file。

使用法: (インライン JSON の場合) --properties "{ "description": "Example description", "folder": "sub-folder", "annotations": " , typeProperties:{...} }"

  • description: (省略可能) データ フローの説明。
  • folder: (省略可能) データ フローが編成されるフォルダー。
  • annotations: (省略可能) データ フローの注釈。
  • typeProperties: (省略可能) 指定されていない場合は、ジェネリック定義と空の定義が作成されます。 定義を含めるのが最善の方法は、Azure Portal の Data Factory Studio 内から JSON をコピーすることです。

省略可能のパラメーター

--data-flow-name --name -n

データ フロー名。

--factory-name -f

ファクトリ名。

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--resource-group -g

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

--subscription

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

グローバル パラメーター
--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 を使います。