Share via

az datafactory data-flow

  • Reference

Note

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

Managing and configuring Data Flows in Azure Data Factory.

Commands

Name Description Type Status
az datafactory data-flow create

Creates a data flow within a factory.

 Extension GA
az datafactory data-flow delete

Delete a specific data flow in a given factory.

 Extension GA
az datafactory data-flow list

List data flows within a provided factory.

 Extension GA
az datafactory data-flow show

Show information about the specified data flow.

 Extension GA
az datafactory data-flow update

Updates a specified data flow within a factory.

 Extension GA

az datafactory data-flow create

Creates a data flow within a factory.

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

Examples

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

Required Parameters

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

The data flow name.

--factory-name -f

The factory name.

--flow-type -t

The data flow type. Valid choices: MappingDataFlow, Flowlet.

--properties

Specified properties for the dataflow. Expected value: json-string/json-file/@json-file.

Usage: (if inline JSON) --properties "{"name": "hello", "description": "Example description", "folder": "sub-folder", "annotations": " , typeProperties:{...} }"

  • name: Name of the data flow. (Avoid hyphens.)
  • description: (optional) Description for the data flow.
  • folder: (optional) Folder the data flow will be organized under.
  • annotations: (optional) Annotations for the data flow.
  • typeProperties: (optional) If none provided, a generic and empty definition is created. Including the definitions is best done by copying the JSON from within the Data Factory Studio in the Azure Portal.
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--if-match

ETag of the data flow entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az datafactory data-flow delete

Delete a specific data flow in a given factory.

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

Examples

Factories_DataFlowDelete

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

Optional Parameters

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

The data flow name.

--factory-name -f

The factory name.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az datafactory data-flow list

List data flows within a provided factory.

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

Examples

Factories_DataFlowList

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

Required Parameters

--factory-name -f

The factory name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az datafactory data-flow show

Show information about the specified data flow.

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

Examples

Factories_DataFlowShow

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

Optional Parameters

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

The data flow name.

--factory-name -f

The factory name.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--if-none-match

ETag of the pipeline entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az datafactory data-flow update

Updates a specified data flow within a factory.

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

Examples

Factories_DataFlowUpdate

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

Required Parameters

--properties

Specified properties for the dataflow. Expected value: json-string/json-file/@json-file.

Usage: (if inline JSON) --properties "{ "description": "Example description", "folder": "sub-folder", "annotations": " , typeProperties:{...} }"

  • description: (optional) Description for the data flow.
  • folder: (optional) Folder the data flow will be organized under.
  • annotations: (optional) Annotations for the data flow.
  • typeProperties: (optional) If none provided, a generic and empty definition is created. Including the definitions is best done by copying the JSON from within the Data Factory Studio in the Azure Portal.

Optional Parameters

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

The data flow name.

--factory-name -f

The factory name.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.