Data Flows - Get

服務:: Data Factory

API 版本:: 2018-06-01

取得數據流。

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

URI 參數

名稱	位於	必要	類型	Description
dataFlowName	path	True	string minLength: 1 maxLength: 260 pattern: ^[A-Za-z0-9_][^<>#.%&:\\+?/]$	數據流名稱。
factoryName	path	True	string minLength: 3 maxLength: 63 pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$	Factory 名稱。
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+$	資源組名。
subscriptionId	path	True	string	訂用帳戶標識碼。
api-version	query	True	string	API 版本。

要求標頭

名稱	必要	類型	Description
If-None-Match		string	數據流實體的 ETag。應該只指定 get。如果 ETag 符合現有的實體標記，或提供 *，則不會傳回任何內容。

回應

名稱	類型	Description
200 OK	DataFlowResource	還行。
Other Status Codes	CloudError	從 Azure Data Factory 服務收到的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

DataFlows_Get

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

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

// Generated from example definition: specification/datafactory/resource-manager/Microsoft.DataFactory/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";
NullableResponse<DataFactoryDataFlowResource> response = await collection.GetIfExistsAsync(dataFlowName);
DataFactoryDataFlowResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // 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

範例回覆

狀態碼:: 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

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

定義

名稱	Description
CloudError	對象，定義 Azure Data Factory 錯誤響應的結構。
DataFlowReference	數據流參考類型。
DataFlowReferenceType	數據流參考類型。
DataFlowResource	數據流資源類型。
DataFlowSink	數據流接收的轉換。
DataFlowSource	數據流來源的轉換。
DatasetReference	數據集參考類型。
Flowlet	數據流流程
Folder	此數據流位於的資料夾。如果未指定，數據流將會出現在根層級。
LinkedServiceReference	連結服務參考類型。
MappingDataFlow	對應數據流。
PowerQuerySource	電源查詢來源。
Transformation	數據流轉換。
Type	連結服務參考類型。
WranglingDataFlow	Power Query 數據流。

CloudError

Object

對象，定義 Azure Data Factory 錯誤響應的結構。

名稱	類型	Description
error.code	string	錯誤碼。
error.details	CloudError[]	具有其他錯誤詳細數據的陣列。
error.message	string	錯誤資訊。
error.target	string	與錯誤相關聯之要求中的屬性名稱/路徑。

DataFlowReference

Object

數據流參考類型。

名稱	類型	Description
datasetParameters	object	從數據集參考數據流參數。
parameters	object	數據流參數
referenceName	string	參考數據流名稱。
type	DataFlowReferenceType	數據流參考類型。

DataFlowReferenceType

列舉型別

數據流參考類型。

值	Description
DataFlowReference

DataFlowResource

Object

數據流資源類型。

名稱	類型	Description
etag	string	Etag 會識別資源中的變更。
id	string	資源標識碼。
name	string	資源名稱。
properties	DataFlow: Flowlet MappingDataFlow WranglingDataFlow	數據流屬性。
type	string	資源類型。

DataFlowSink

Object

數據流接收的轉換。

名稱	類型	Description
dataset	DatasetReference	數據集參考。
description	string	轉換描述。
flowlet	DataFlowReference	Flowlet 參考
linkedService	LinkedServiceReference	鏈接的服務參考。
name	string	轉換名稱。
rejectedDataLinkedService	LinkedServiceReference	拒絕的數據連結服務參考。
schemaLinkedService	LinkedServiceReference	架構連結服務參考。

DataFlowSource

Object

數據流來源的轉換。

名稱	類型	Description
dataset	DatasetReference	數據集參考。
description	string	轉換描述。
flowlet	DataFlowReference	Flowlet 參考
linkedService	LinkedServiceReference	鏈接的服務參考。
name	string	轉換名稱。
schemaLinkedService	LinkedServiceReference	架構連結服務參考。

DatasetReference

Object

數據集參考類型。

名稱	類型	Description
parameters	object	數據集的自變數。
referenceName	string	參考數據集名稱。
type	enum: DatasetReference	數據集參考類型。

Flowlet

Object

數據流流程

名稱	類型	Description
annotations	object[]	可用於描述數據流的標記清單。
description	string	數據流的描述。
folder	Folder	此數據流位於的資料夾。如果未指定，數據流將會出現在根層級。
type	string: Flowlet	數據流的類型。
typeProperties.script	string	Flowlet 腳本。
typeProperties.scriptLines	string[]	Flowlet 腳本行。
typeProperties.sinks	DataFlowSink[]	Flowlet 中的接收清單。
typeProperties.sources	DataFlowSource[]	Flowlet 中的來源清單。
typeProperties.transformations	Transformation[]	Flowlet 中的轉換清單。

Folder

Object

此數據流位於的資料夾。如果未指定，數據流將會出現在根層級。

名稱	類型	Description
name	string	此數據流位於的資料夾名稱。

LinkedServiceReference

Object

連結服務參考類型。

名稱	類型	Description
parameters	object	LinkedService 的自變數。
referenceName	string	參考 LinkedService 名稱。
type	Type	連結服務參考類型。

MappingDataFlow

Object

對應數據流。

名稱	類型	Description
annotations	object[]	可用於描述數據流的標記清單。
description	string	數據流的描述。
folder	Folder	此數據流位於的資料夾。如果未指定，數據流將會出現在根層級。
type	string: MappingDataFlow	數據流的類型。
typeProperties.script	string	DataFlow 腳本。
typeProperties.scriptLines	string[]	數據流腳本行。
typeProperties.sinks	DataFlowSink[]	數據流中的接收清單。
typeProperties.sources	DataFlowSource[]	數據流中的來源清單。
typeProperties.transformations	Transformation[]	數據流中的轉換清單。

PowerQuerySource

Object

電源查詢來源。

名稱	類型	Description
dataset	DatasetReference	數據集參考。
description	string	轉換描述。
flowlet	DataFlowReference	Flowlet 參考
linkedService	LinkedServiceReference	鏈接的服務參考。
name	string	轉換名稱。
schemaLinkedService	LinkedServiceReference	架構連結服務參考。
script	string	來源腳本。

Transformation

Object

數據流轉換。

名稱	類型	Description
dataset	DatasetReference	數據集參考。
description	string	轉換描述。
flowlet	DataFlowReference	Flowlet 參考
linkedService	LinkedServiceReference	鏈接的服務參考。
name	string	轉換名稱。

Type

列舉型別

連結服務參考類型。

值	Description
LinkedServiceReference

WranglingDataFlow

Object

Power Query 數據流。

名稱	類型	Description
annotations	object[]	可用於描述數據流的標記清單。
description	string	數據流的描述。
folder	Folder	此數據流位於的資料夾。如果未指定，數據流將會出現在根層級。
type	string: WranglingDataFlow	數據流的類型。
typeProperties.documentLocale	string	Power 查詢混搭文件的地區設定。
typeProperties.script	string	Power query mashup 腳本。
typeProperties.sources	PowerQuerySource[]	Power Query 中的來源清單。

共用方式為

Data Flows - Get

URI 參數

要求標頭

回應

安全性

azure_auth

範圍

範例

DataFlows_Get

範例要求

範例回覆

定義

CloudError

DataFlowReference

DataFlowReferenceType

DataFlowResource

DataFlowSink

DataFlowSource

DatasetReference

Flowlet

Folder

LinkedServiceReference

MappingDataFlow

PowerQuerySource

Transformation

Type

WranglingDataFlow