你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Data Flow - Get Data Flow

参考

服务:: Synapse

API 版本:: 2020-12-01

获取数据流。

GET {endpoint}/dataflows/{dataFlowName}?api-version=2020-12-01

URI 参数

名称	在	必需	类型	说明
dataFlowName	path	True	string minLength: 1 maxLength: 260 pattern: ^[A-Za-z0-9_][^<>#.%&:\\+?/]$	数据流名称。
endpoint	path	True	string (uri)	工作区开发终结点，例如 `https://myworkspace.dev.azuresynapse.net`。
api-version	query	True	string	Synapse 客户端 API 版本。

请求头

名称	必需	类型	说明
If-None-Match		string	数据流实体的 ETag。应仅指定 get。如果 ETag 与现有实体标记匹配，或者如果提供 *，则不会返回任何内容。

响应

名称	类型	说明
200 OK	DataFlowResource	还行。
Other Status Codes	CloudError	从 Azure Synapse 服务收到的错误响应。

示例

DataFlows_Get

示例请求

HTTP

GET exampleWorkspace.dev.azuresynapse.net/dataflows/exampleDataFlow?api-version=2020-12-01

示例响应

状态代码:: 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.Synapse/workspaces/exampleWorkspaceName/dataflows/exampleDataFlow",
  "name": "exampleDataFlow",
  "type": "Microsoft.Synapse/workspaces/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 Synapse 错误响应结构的对象。
DataFlowReference	数据流引用类型。
DataFlowReferenceType	数据流引用类型。
DataFlowResource	数据流资源类型。
DataFlowSink	数据流接收器的转换。
DataFlowSource	数据流源的转换。
DatasetReference	数据集引用类型。
DatasetReferenceType	数据集引用类型。
Flowlet	数据流流
Folder	此数据流所在的文件夹。如果未指定，数据流将显示在根级别。
LinkedServiceReference	链接服务引用类型。
MappingDataFlow	映射数据流。
Transformation	数据流转换。
Type	链接服务引用类型。

CloudError

Object

定义 Azure Synapse 错误响应结构的对象。

名称	类型	说明
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	资源的完全限定资源 ID。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	资源的名称
properties	DataFlow: Flowlet MappingDataFlow	数据流属性。
type	string	资源的类型。例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

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	DatasetReferenceType	数据集引用类型。

DatasetReferenceType

枚举

数据集引用类型。

值	说明
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[]	数据流中的转换列表。

Transformation

Object

数据流转换。

名称	类型	说明
dataset	DatasetReference	数据集引用。
description	string	转换说明。
flowlet	DataFlowReference	Flowlet 参考
linkedService	LinkedServiceReference	链接服务引用。
name	string	转换名称。

Type

枚举

链接服务引用类型。

值	说明
LinkedServiceReference

通过

Data Flow - Get Data Flow

URI 参数

请求头

响应

示例

DataFlows_Get

示例请求

示例响应

定义

CloudError

DataFlowReference

DataFlowReferenceType

DataFlowResource

DataFlowSink

DataFlowSource

DatasetReference

DatasetReferenceType

Flowlet

Folder

LinkedServiceReference

MappingDataFlow

Transformation

Type