Data Flows - Get

Service:

Data Factory

API Version:

2018-06-01

Gets a data flow.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/dataflows/{dataFlowName}?api-version=2018-06-01

URI Parameters

Name	In	Required	Type	Description
dataFlowName	path	True	string	The data flow name. Regex pattern: ^[A-Za-z0-9_][^<>*#.%&:\\+?/]*$
factoryName	path	True	string	The factory name. Regex pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$
resourceGroupName	path	True	string	The resource group name. Regex pattern: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	The subscription identifier.
api-version	query	True	string	The API version.

Request Header

Name	Required	Type	Description
If-None-Match		string	ETag of the data flow 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.

Responses

Name	Type	Description
200 OK	DataFlowResource	OK.
Other Status Codes	CloudError	An error response received from the Azure Data Factory service.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

DataFlows_Get

Sample Request

HTTP

GET https://management.azure.com/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/dataflows/exampleDataFlow?api-version=2018-06-01

Java

/**
 * Samples for DataFlows Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/DataFlows_Get.json
     */
    /**
     * Sample code: DataFlows_Get.
     * 
     * @param manager Entry point to DataFactoryManager.
     */
    public static void dataFlowsGet(com.azure.resourcemanager.datafactory.DataFactoryManager manager) {
        manager.dataFlows().getWithResponse("exampleResourceGroup", "exampleFactoryName", "exampleDataFlow", null,
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.datafactory import DataFactoryManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-datafactory
# USAGE
    python data_flows_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = DataFactoryManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="12345678-1234-1234-1234-12345678abc",
    )

    response = client.data_flows.get(
        resource_group_name="exampleResourceGroup",
        factory_name="exampleFactoryName",
        data_flow_name="exampleDataFlow",
    )
    print(response)


# x-ms-original-file: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/DataFlows_Get.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armdatafactory_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datafactory/armdatafactory/v7"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/92de53a5f1e0e03c94b40475d2135d97148ed014/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/DataFlows_Get.json
func ExampleDataFlowsClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatafactory.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewDataFlowsClient().Get(ctx, "exampleResourceGroup", "exampleFactoryName", "exampleDataFlow", &armdatafactory.DataFlowsClientGetOptions{IfNoneMatch: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.DataFlowResource = armdatafactory.DataFlowResource{
	// 	Name: to.Ptr("exampleDataFlow"),
	// 	Type: to.Ptr("Microsoft.DataFactory/factories/dataflows"),
	// 	Etag: to.Ptr("15004c4f-0000-0200-0000-5cbe090e0000"),
	// 	ID: to.Ptr("/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/dataflows/exampleDataFlow"),
	// 	Properties: &armdatafactory.MappingDataFlow{
	// 		Type: to.Ptr("MappingDataFlow"),
	// 		Description: to.Ptr("Sample demo data flow to convert currencies showing usage of union, derive and conditional split transformation."),
	// 		TypeProperties: &armdatafactory.MappingDataFlowTypeProperties{
	// 			Script: to.Ptr("source(output(PreviousConversionRate as double,Country as string,DateTime1 as string,CurrentConversionRate as double),allowSchemaDrift: false,validateSchema: false) ~> USDCurrency\nsource(output(PreviousConversionRate as double,Country as string,DateTime1 as string,CurrentConversionRate as double),allowSchemaDrift: true,validateSchema: false) ~> CADSource\nUSDCurrency, CADSource union(byName: true)~> Union\nUnion derive(NewCurrencyRate = round(CurrentConversionRate*1.25)) ~> NewCurrencyColumn\nNewCurrencyColumn split(Country == 'USD',Country == 'CAD',disjoint: false) ~> ConditionalSplit1@(USD, CAD)\nConditionalSplit1@USD sink(saveMode:'overwrite' ) ~> USDSink\nConditionalSplit1@CAD sink(saveMode:'overwrite' ) ~> CADSink"),
	// 			Sinks: []*armdatafactory.DataFlowSink{
	// 				{
	// 					Name: to.Ptr("USDSink"),
	// 					Dataset: &armdatafactory.DatasetReference{
	// 						Type: to.Ptr(armdatafactory.DatasetReferenceTypeDatasetReference),
	// 						ReferenceName: to.Ptr("USDOutput"),
	// 					},
	// 				},
	// 				{
	// 					Name: to.Ptr("CADSink"),
	// 					Dataset: &armdatafactory.DatasetReference{
	// 						Type: to.Ptr(armdatafactory.DatasetReferenceTypeDatasetReference),
	// 						ReferenceName: to.Ptr("CADOutput"),
	// 					},
	// 			}},
	// 			Sources: []*armdatafactory.DataFlowSource{
	// 				{
	// 					Name: to.Ptr("USDCurrency"),
	// 					Dataset: &armdatafactory.DatasetReference{
	// 						Type: to.Ptr(armdatafactory.DatasetReferenceTypeDatasetReference),
	// 						ReferenceName: to.Ptr("CurrencyDatasetUSD"),
	// 					},
	// 				},
	// 				{
	// 					Name: to.Ptr("CADSource"),
	// 					Dataset: &armdatafactory.DatasetReference{
	// 						Type: to.Ptr(armdatafactory.DatasetReferenceTypeDatasetReference),
	// 						ReferenceName: to.Ptr("CurrencyDatasetCAD"),
	// 					},
	// 			}},
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { DataFactoryManagementClient } = require("@azure/arm-datafactory");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets a data flow.
 *
 * @summary Gets a data flow.
 * x-ms-original-file: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/DataFlows_Get.json
 */
async function dataFlowsGet() {
  const subscriptionId =
    process.env["DATAFACTORY_SUBSCRIPTION_ID"] || "12345678-1234-1234-1234-12345678abc";
  const resourceGroupName = process.env["DATAFACTORY_RESOURCE_GROUP"] || "exampleResourceGroup";
  const factoryName = "exampleFactoryName";
  const dataFlowName = "exampleDataFlow";
  const credential = new DefaultAzureCredential();
  const client = new DataFactoryManagementClient(credential, subscriptionId);
  const result = await client.dataFlows.get(resourceGroupName, factoryName, dataFlowName);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.DataFactory;
using Azure.ResourceManager.DataFactory.Models;

// Generated from example definition: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/DataFlows_Get.json
// this example is just showing the usage of "DataFlows_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this DataFactoryDataFlowResource created on azure
// for more information of creating DataFactoryDataFlowResource, please refer to the document of DataFactoryDataFlowResource
string subscriptionId = "12345678-1234-1234-1234-12345678abc";
string resourceGroupName = "exampleResourceGroup";
string factoryName = "exampleFactoryName";
string dataFlowName = "exampleDataFlow";
ResourceIdentifier dataFactoryDataFlowResourceId = DataFactoryDataFlowResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, factoryName, dataFlowName);
DataFactoryDataFlowResource dataFactoryDataFlow = client.GetDataFactoryDataFlowResource(dataFactoryDataFlowResourceId);

// invoke the operation
DataFactoryDataFlowResource result = await dataFactoryDataFlow.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
DataFactoryDataFlowData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

Date: Mon, 22 Apr 2019 18:33:50 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-reads: 11993
x-ms-request-id: 48983fb5-612a-44c6-8158-add7ffebb32b
x-ms-correlation-request-id: 48983fb5-612a-44c6-8158-add7ffebb32b

Response Body

{
  "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/dataflows/exampleDataFlow",
  "name": "exampleDataFlow",
  "type": "Microsoft.DataFactory/factories/dataflows",
  "properties": {
    "description": "Sample demo data flow to convert currencies showing usage of union, derive and conditional split transformation.",
    "type": "MappingDataFlow",
    "typeProperties": {
      "sources": [
        {
          "dataset": {
            "referenceName": "CurrencyDatasetUSD",
            "type": "DatasetReference"
          },
          "name": "USDCurrency"
        },
        {
          "dataset": {
            "referenceName": "CurrencyDatasetCAD",
            "type": "DatasetReference"
          },
          "name": "CADSource"
        }
      ],
      "sinks": [
        {
          "dataset": {
            "referenceName": "USDOutput",
            "type": "DatasetReference"
          },
          "name": "USDSink"
        },
        {
          "dataset": {
            "referenceName": "CADOutput",
            "type": "DatasetReference"
          },
          "name": "CADSink"
        }
      ],
      "script": "source(output(PreviousConversionRate as double,Country as string,DateTime1 as string,CurrentConversionRate as double),allowSchemaDrift: false,validateSchema: false) ~> USDCurrency\nsource(output(PreviousConversionRate as double,Country as string,DateTime1 as string,CurrentConversionRate as double),allowSchemaDrift: true,validateSchema: false) ~> CADSource\nUSDCurrency, CADSource union(byName: true)~> Union\nUnion derive(NewCurrencyRate = round(CurrentConversionRate*1.25)) ~> NewCurrencyColumn\nNewCurrencyColumn split(Country == 'USD',Country == 'CAD',disjoint: false) ~> ConditionalSplit1@(USD, CAD)\nConditionalSplit1@USD sink(saveMode:'overwrite' ) ~> USDSink\nConditionalSplit1@CAD sink(saveMode:'overwrite' ) ~> CADSink"
    }
  },
  "etag": "15004c4f-0000-0200-0000-5cbe090e0000"
}

Definitions

Name	Description
CloudError	The object that defines the structure of an Azure Data Factory error response.
DataFlowReference	Data flow reference type.
DataFlowReferenceType	Data flow reference type.
DataFlowResource	Data flow resource type.
DataFlowSink	Transformation for data flow sink.
DataFlowSource	Transformation for data flow source.
DatasetReference	Dataset reference type.
Flowlet	Data flow flowlet
Folder	The folder that this data flow is in. If not specified, Data flow will appear at the root level.
LinkedServiceReference	Linked service reference type.
MappingDataFlow	Mapping data flow.
PowerQuerySource	Power query source.
Transformation	A data flow transformation.
Type	Linked service reference type.
WranglingDataFlow	Power Query data flow.

CloudError

The object that defines the structure of an Azure Data Factory error response.

Name	Type	Description
error.code	string	Error code.
error.details	CloudError[]	Array with additional error details.
error.message	string	Error message.
error.target	string	Property name/path in request associated with error.

DataFlowReference

Data flow reference type.

Name	Type	Description
datasetParameters	object	Reference data flow parameters from dataset.
parameters	object	Data flow parameters
referenceName	string	Reference data flow name.
type	DataFlowReferenceType	Data flow reference type.

DataFlowReferenceType

Data flow reference type.

Name	Type	Description
DataFlowReference	string

DataFlowResource

Data flow resource type.

Name	Type	Description
etag	string	Etag identifies change in the resource.
id	string	The resource identifier.
name	string	The resource name.
properties	DataFlow: Flowlet MappingDataFlow WranglingDataFlow	Data flow properties.
type	string	The resource type.

DataFlowSink

Transformation for data flow sink.

Name	Type	Description
dataset	DatasetReference	Dataset reference.
description	string	Transformation description.
flowlet	DataFlowReference	Flowlet Reference
linkedService	LinkedServiceReference	Linked service reference.
name	string	Transformation name.
rejectedDataLinkedService	LinkedServiceReference	Rejected data linked service reference.
schemaLinkedService	LinkedServiceReference	Schema linked service reference.

DataFlowSource

Transformation for data flow source.

Name	Type	Description
dataset	DatasetReference	Dataset reference.
description	string	Transformation description.
flowlet	DataFlowReference	Flowlet Reference
linkedService	LinkedServiceReference	Linked service reference.
name	string	Transformation name.
schemaLinkedService	LinkedServiceReference	Schema linked service reference.

DatasetReference

Dataset reference type.

Name	Type	Description
parameters	object	Arguments for dataset.
referenceName	string	Reference dataset name.
type	enum: DatasetReference	Dataset reference type.

Flowlet

Data flow flowlet

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the data flow.
description	string	The description of the data flow.
folder	Folder	The folder that this data flow is in. If not specified, Data flow will appear at the root level.
type	string: Flowlet	Type of data flow.
typeProperties.script	string	Flowlet script.
typeProperties.scriptLines	string[]	Flowlet script lines.
typeProperties.sinks	DataFlowSink[]	List of sinks in Flowlet.
typeProperties.sources	DataFlowSource[]	List of sources in Flowlet.
typeProperties.transformations	Transformation[]	List of transformations in Flowlet.

Folder

The folder that this data flow is in. If not specified, Data flow will appear at the root level.

Name	Type	Description
name	string	The name of the folder that this data flow is in.

LinkedServiceReference

Linked service reference type.

Name	Type	Description
parameters	object	Arguments for LinkedService.
referenceName	string	Reference LinkedService name.
type	Type	Linked service reference type.

MappingDataFlow

Mapping data flow.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the data flow.
description	string	The description of the data flow.
folder	Folder	The folder that this data flow is in. If not specified, Data flow will appear at the root level.
type	string: MappingDataFlow	Type of data flow.
typeProperties.script	string	DataFlow script.
typeProperties.scriptLines	string[]	Data flow script lines.
typeProperties.sinks	DataFlowSink[]	List of sinks in data flow.
typeProperties.sources	DataFlowSource[]	List of sources in data flow.
typeProperties.transformations	Transformation[]	List of transformations in data flow.

PowerQuerySource

Power query source.

Name	Type	Description
dataset	DatasetReference	Dataset reference.
description	string	Transformation description.
flowlet	DataFlowReference	Flowlet Reference
linkedService	LinkedServiceReference	Linked service reference.
name	string	Transformation name.
schemaLinkedService	LinkedServiceReference	Schema linked service reference.
script	string	source script.

Transformation

A data flow transformation.

Name	Type	Description
dataset	DatasetReference	Dataset reference.
description	string	Transformation description.
flowlet	DataFlowReference	Flowlet Reference
linkedService	LinkedServiceReference	Linked service reference.
name	string	Transformation name.

Type

Linked service reference type.

Name	Type	Description
LinkedServiceReference	string

WranglingDataFlow

Power Query data flow.

Name	Type	Description
annotations	object[]	List of tags that can be used for describing the data flow.
description	string	The description of the data flow.
folder	Folder	The folder that this data flow is in. If not specified, Data flow will appear at the root level.
type	string: WranglingDataFlow	Type of data flow.
typeProperties.documentLocale	string	Locale of the Power query mashup document.
typeProperties.script	string	Power query mashup script.
typeProperties.sources	PowerQuerySource[]	List of sources in Power Query.