Data Flows - Get

Odwołanie

Service:: Data Factory

API Version:: 2018-06-01

Pobiera przepływ danych.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
dataFlowName	path	True	string	Nazwa przepływu danych. Regex pattern: `^[A-Za-z0-9_][^<>#.%&:\\+?/]$`
factoryName	path	True	string	Nazwa fabryki. Regex pattern: `^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$`
resourceGroupName	path	True	string	Nazwa grupy zasobów. Regex pattern: `^[-\w\._\(\)]+$`
subscriptionId	path	True	string	Identyfikator subskrypcji.
api-version	query	True	string	Wersja interfejsu API.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
If-None-Match		string	Element ETag jednostki przepływu danych. Należy określić tylko dla polecenia get. Jeśli element ETag pasuje do istniejącego tagu jednostki lub jeśli * został podany, nie zostanie zwrócona żadna zawartość.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	DataFlowResource	OK.
Other Status Codes	CloudError	Odebrano odpowiedź o błędzie z usługi Azure Data Factory.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory.

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

Scopes

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

DataFlows_Get

Sample Request

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

/** 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

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

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/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/5c9459305484e0456b4a922e3d31a61e2ddd3c99/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

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

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 DataFactoryResource created on azure
// for more information of creating DataFactoryResource, please refer to the document of DataFactoryResource
string subscriptionId = "12345678-1234-1234-1234-12345678abc";
string resourceGroupName = "exampleResourceGroup";
string factoryName = "exampleFactoryName";
ResourceIdentifier dataFactoryResourceId = DataFactoryResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, factoryName);
DataFactoryResource dataFactory = client.GetDataFactoryResource(dataFactoryResourceId);

// get the collection of this DataFactoryDataFlowResource
DataFactoryDataFlowCollection collection = dataFactory.GetDataFactoryDataFlows();

// invoke the operation
string dataFlowName = "exampleDataFlow";
bool result = await collection.ExistsAsync(dataFlowName);

Console.WriteLine($"Succeeded: {result}");

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"
}

Definicje

Nazwa	Opis
CloudError	Obiekt, który definiuje strukturę odpowiedzi Azure Data Factory błędu.
DataFlowReference	Typ odwołania do przepływu danych.
DataFlowReferenceType	Typ odwołania do przepływu danych.
DataFlowResource	Typ zasobu przepływu danych.
DataFlowSink	Przekształcanie ujścia przepływu danych.
DataFlowSource	Przekształcanie źródła przepływu danych.
DatasetReference	Typ odwołania do zestawu danych.
Flowlet	Przepływ danych — przepływ pracy
Folder	Folder, w ramach którego znajduje się ten przepływ danych. Jeśli nie zostanie określony, przepływ danych będzie wyświetlany na poziomie głównym.
LinkedServiceReference	Typ odwołania do połączonej usługi.
MappingDataFlow	Przepływ mapowania danych.
PowerQuerySource	Źródło dodatku Power Query.
Transformation	Przekształcenie przepływu danych.
Type	Typ odwołania do połączonej usługi.
WranglingDataFlow	Power Query przepływ danych.

CloudError

Obiekt, który definiuje strukturę odpowiedzi Azure Data Factory błędu.

Nazwa	Typ	Opis
error.code	string	Kod błędu.
error.details	CloudError[]	Tablica z dodatkowymi szczegółami błędu.
error.message	string	Komunikat o błędzie.
error.target	string	Nazwa/ścieżka właściwości w żądaniu skojarzonym z błędem.

DataFlowReference

Typ odwołania do przepływu danych.

Nazwa	Typ	Opis
datasetParameters	object	Odwoływanie się do parametrów przepływu danych z zestawu danych.
parameters	object	Parametry przepływu danych
referenceName	string	Nazwa przepływu danych referencyjnych.
type	DataFlowReferenceType	Typ odwołania do przepływu danych.

DataFlowReferenceType

Typ odwołania do przepływu danych.

Nazwa	Typ	Opis
DataFlowReference	string

DataFlowResource

Typ zasobu przepływu danych.

Nazwa	Typ	Opis
etag	string	Etag identyfikuje zmiany w zasobie.
id	string	Identyfikator zasobu.
name	string	Nazwa zasobu.
properties	DataFlow: Flowlet MappingDataFlow WranglingDataFlow	Właściwości przepływu danych.
type	string	Typ zasobu.

DataFlowSink

Przekształcanie ujścia przepływu danych.

Nazwa	Typ	Opis
dataset	DatasetReference	Dokumentacja zestawu danych.
description	string	Opis przekształcenia.
flowlet	DataFlowReference	Odwołanie do przepływów
linkedService	LinkedServiceReference	Dokumentacja połączonej usługi.
name	string	Nazwa przekształcenia.
rejectedDataLinkedService	LinkedServiceReference	Odrzucone odwołanie do połączonej usługi danych.
schemaLinkedService	LinkedServiceReference	Dokumentacja połączonej usługi schematu.

DataFlowSource

Przekształcanie źródła przepływu danych.

Nazwa	Typ	Opis
dataset	DatasetReference	Dokumentacja zestawu danych.
description	string	Opis przekształcenia.
flowlet	DataFlowReference	Odwołanie do przepływów
linkedService	LinkedServiceReference	Dokumentacja połączonej usługi.
name	string	Nazwa przekształcenia.
schemaLinkedService	LinkedServiceReference	Dokumentacja połączonej usługi schematu.

DatasetReference

Typ odwołania do zestawu danych.

Nazwa	Typ	Opis
parameters	object	Argumenty dla zestawu danych.
referenceName	string	Nazwa zestawu danych odwołania.
type	enum: DatasetReference	Typ odwołania do zestawu danych.

Flowlet

Przepływ danych — przepływ pracy

Nazwa	Typ	Opis
annotations	object[]	Lista tagów, których można użyć do opisywania przepływu danych.
description	string	Opis przepływu danych.
folder	Folder	Folder, w ramach którego znajduje się ten przepływ danych. Jeśli nie zostanie określony, przepływ danych będzie wyświetlany na poziomie głównym.
type	string: Flowlet	Typ przepływu danych.
typeProperties.script	string	Skrypt flowletu.
typeProperties.scriptLines	string[]	Wiersze skryptu flowletu.
typeProperties.sinks	DataFlowSink[]	Lista ujść w przepływie.
typeProperties.sources	DataFlowSource[]	Lista źródeł w przepływie.
typeProperties.transformations	Transformation[]	Lista przekształceń w elemecie Flowlet.

Folder

Folder, w ramach którego znajduje się ten przepływ danych. Jeśli nie zostanie określony, przepływ danych będzie wyświetlany na poziomie głównym.

Nazwa	Typ	Opis
name	string	Nazwa folderu, w ramach którego znajduje się ten przepływ danych.

LinkedServiceReference

Typ odwołania do połączonej usługi.

Nazwa	Typ	Opis
parameters	object	Argumenty dla usługi LinkedService.
referenceName	string	Odwoływanie się do nazwy usługi połączonej.
type	Type	Typ odwołania do połączonej usługi.

MappingDataFlow

Przepływ mapowania danych.

Nazwa	Typ	Opis
annotations	object[]	Lista tagów, których można użyć do opisywania przepływu danych.
description	string	Opis przepływu danych.
folder	Folder	Folder, w ramach którego znajduje się ten przepływ danych. Jeśli nie zostanie określony, przepływ danych będzie wyświetlany na poziomie głównym.
type	string: MappingDataFlow	Typ przepływu danych.
typeProperties.script	string	Skrypt przepływu danych.
typeProperties.scriptLines	string[]	Wiersze skryptu przepływu danych.
typeProperties.sinks	DataFlowSink[]	Lista ujść w przepływie danych.
typeProperties.sources	DataFlowSource[]	Lista źródeł w przepływie danych.
typeProperties.transformations	Transformation[]	Lista przekształceń w przepływie danych.

PowerQuerySource

Źródło dodatku Power Query.

Nazwa	Typ	Opis
dataset	DatasetReference	Dokumentacja zestawu danych.
description	string	Opis przekształcenia.
flowlet	DataFlowReference	Odwołanie do przepływów
linkedService	LinkedServiceReference	Dokumentacja połączonej usługi.
name	string	Nazwa przekształcenia.
schemaLinkedService	LinkedServiceReference	Dokumentacja połączonej usługi schematu.
script	string	skrypt źródłowy.

Transformation

Przekształcenie przepływu danych.

Nazwa	Typ	Opis
dataset	DatasetReference	Dokumentacja zestawu danych.
description	string	Opis przekształcenia.
flowlet	DataFlowReference	Odwołanie do przepływów
linkedService	LinkedServiceReference	Dokumentacja połączonej usługi.
name	string	Nazwa przekształcenia.

Type

Typ odwołania do połączonej usługi.

Nazwa	Typ	Opis
LinkedServiceReference	string

WranglingDataFlow

Power Query przepływ danych.

Nazwa	Typ	Opis
annotations	object[]	Lista tagów, których można użyć do opisywania przepływu danych.
description	string	Opis przepływu danych.
folder	Folder	Folder, w ramach którego znajduje się ten przepływ danych. Jeśli nie zostanie określony, przepływ danych będzie wyświetlany na poziomie głównym.
type	string: WranglingDataFlow	Typ przepływu danych.
typeProperties.documentLocale	string	Ustawienia regionalne dokumentu mashup power query.
typeProperties.script	string	Skrypt mashupu dodatku Power Query.
typeProperties.sources	PowerQuerySource[]	Lista źródeł w Power Query.