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 パラメーター

名前	/	必須	型	説明
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]+)*$	ファクトリ名。
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+$	リソースグループ名。
subscriptionId	path	True	string	サブスクリプション識別子。
api-version	query	True	string	API のバージョン。

要求ヘッダー

名前	必須	型	説明
If-None-Match		string	データフローエンティティの ETag。 get にのみ指定する必要があります。 ETag が既存のエンティティタグと一致する場合、または * が指定された場合、コンテンツは返されません。

応答

名前	型	説明
200 OK	DataFlowResource	わかりました。
Other Status Codes	CloudError	Azure Data Factory サービスから受信したエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
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"
}

定義

名前	説明
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 エラー応答の構造を定義するオブジェクト。

名前	型	説明
error.code	string	エラーコード。
error.details	CloudError[]	追加のエラーの詳細を含む配列。
error.message	string	エラーメッセージ。
error.target	string	エラーに関連付けられている要求のプロパティ名/パス。

DataFlowReference

Object

データフロー参照型。

名前	型	説明
datasetParameters	object	データセットからデータフローパラメーターを参照します。
parameters	object	データフローパラメーター
referenceName	string	参照データフロー名。
type	DataFlowReferenceType	データフロー参照型。

DataFlowReferenceType

列挙

データフロー参照型。

値	説明
DataFlowReference

DataFlowResource

Object

データフローリソースの種類。

名前	型	説明
etag	string	Etag は、リソース内の変更を識別します。
id	string	リソース識別子。
name	string	リソース名。
properties	DataFlow: Flowlet MappingDataFlow WranglingDataFlow	データフローのプロパティ。
type	string	リソースの種類。

DataFlowSink

Object

データフローシンクの変換。

名前	型	説明
dataset	DatasetReference	データセット参照。
description	string	変換の説明。
flowlet	DataFlowReference	Flowlet リファレンス
linkedService	LinkedServiceReference	リンクされたサービス参照。
name	string	変換名。
rejectedDataLinkedService	LinkedServiceReference	拒否されたデータのリンクされたサービス参照。
schemaLinkedService	LinkedServiceReference	スキーマのリンクされたサービス参照。

DataFlowSource

Object

データフローソースの変換。

名前	型	説明
dataset	DatasetReference	データセット参照。
description	string	変換の説明。
flowlet	DataFlowReference	Flowlet リファレンス
linkedService	LinkedServiceReference	リンクされたサービス参照。
name	string	変換名。
schemaLinkedService	LinkedServiceReference	スキーマのリンクされたサービス参照。

DatasetReference

Object

データセット参照型。

名前	型	説明
parameters	object	データセットの引数。
referenceName	string	参照データセット名。
type	enum: DatasetReference	データセット参照型。

Flowlet

Object

データフローフローレット

名前	型	説明
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

このデータフローが存在するフォルダー。指定しない場合、データフローはルートレベルで表示されます。

名前	型	説明
name	string	このデータフローが存在するフォルダーの名前。

LinkedServiceReference

Object

リンクされたサービス参照の種類。

名前	型	説明
parameters	object	LinkedService の引数。
referenceName	string	LinkedService 名を参照します。
type	Type	リンクされたサービス参照の種類。

MappingDataFlow

Object

マッピングデータフロー。

名前	型	説明
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

電源クエリソース。

名前	型	説明
dataset	DatasetReference	データセット参照。
description	string	変換の説明。
flowlet	DataFlowReference	Flowlet リファレンス
linkedService	LinkedServiceReference	リンクされたサービス参照。
name	string	変換名。
schemaLinkedService	LinkedServiceReference	スキーマのリンクされたサービス参照。
script	string	ソーススクリプト。

Transformation

Object

データフロー変換。

名前	型	説明
dataset	DatasetReference	データセット参照。
description	string	変換の説明。
flowlet	DataFlowReference	Flowlet リファレンス
linkedService	LinkedServiceReference	リンクされたサービス参照。
name	string	変換名。

Type

列挙

リンクされたサービス参照の種類。

値	説明
LinkedServiceReference

WranglingDataFlow

Object

Power Query データフロー。

名前	型	説明
annotations	object[]	データフローの記述に使用できるタグの一覧。
description	string	データフローの説明。
folder	Folder	このデータフローが存在するフォルダー。指定しない場合、データフローはルートレベルで表示されます。
type	string: WranglingDataFlow	データフローの種類。
typeProperties.documentLocale	string	Power クエリマッシュアップドキュメントのロケール。
typeProperties.script	string	Power Query マッシュアップスクリプト。
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