Data Flow - Create Or Update Data Flow

Cria ou atualiza um fluxo de dados.

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

Parâmetros do URI

Name In Required Type Description
dataFlowName
path True
  • string

O nome do fluxo de dados.

Regex pattern: ^[A-Za-z0-9_][^<>*#.%&:\\+?/]*$

endpoint
path True
  • string

O ponto final de desenvolvimento do espaço de trabalho, por https://myworkspace.dev.azuresynapse.net exemplo.

api-version
query True
  • string

A versão API do cliente synapse.

Cabeçalho do Pedido

Name Required Type Description
If-Match
  • string

ETag da entidade de fluxo de dados. Só deve ser especificado para atualização, para a qual deve corresponder à entidade existente ou pode ser * para atualização incondicional.

Corpo do Pedido

Name Required Type Description
properties True DataFlow:

Propriedades de fluxo de dados.

Respostas

Name Type Description
200 OK

OK.

202 Accepted

Aceite.

Other Status Codes

Uma resposta de erro recebida do serviço Azure Synapse.

Exemplos

DataFlows_Create
DataFlows_Update

DataFlows_Create

Sample Request

PUT exampleWorkspace.dev.azuresynapse.net/dataflows/exampleDataFlow?api-version=2020-12-01
{
  "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"
    }
  }
}

Sample Response

Date: Sat, 16 Jun 2019 00:37:38 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-writes: 1194
x-ms-request-id: ce95d6dd-c04d-4b02-b7ad-fe79c9b26df0
x-ms-correlation-request-id: ce95d6dd-c04d-4b02-b7ad-fe79c9b26df0
{
  "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/datasets/exampleDataset",
  "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": "0a0066d4-0000-0000-0000-5b245bd20000"
}

DataFlows_Update

Sample Request

PUT exampleWorkspace.dev.azuresynapse.net/dataflows/exampleDataFlow?api-version=2020-12-01
{
  "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"
    }
  }
}

Sample Response

Date: Sat, 16 Jun 2019 00:37:38 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-writes: 1193
x-ms-request-id: ce95d6dd-c04d-4b02-b7ad-fe79c9b26df0
x-ms-correlation-request-id: ce95d6dd-c04d-4b02-b7ad-fe79c9b26df0
{
  "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/datasets/exampleDataset",
  "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": "0a0068d4-0000-0000-0000-5b245bd30002"
}

Definições

CloudError

O objeto que define a estrutura de uma resposta de erro Azure Synapse.

DataFlowResource

Tipo de recurso de fluxo de dados.

DataFlowSink

Transformação para fluxo de dados afundar.

DataFlowSource

Transformação para fonte de fluxo de dados.

DatasetReference

Tipo de referência de conjunto de dados.

DatasetReferenceType

Tipo de referência de conjunto de dados.

Folder

A pasta em que este fluxo de dados está dentro. Se não for especificado, o fluxo de dados aparecerá ao nível da raiz.

LinkedServiceReference

Tipo de referência de serviço ligado.

MappingDataFlow

Mapeamento do fluxo de dados.

Transformation

Uma transformação do fluxo de dados.

Type

Tipo de referência de serviço ligado.

CloudError

O objeto que define a estrutura de uma resposta de erro Azure Synapse.

Name Type Description
error.code
  • string

Código de erro.

error.details

Array com detalhes de erro adicionais.

error.message
  • string

Mensagem de erro.

error.target
  • string

Nome/caminho da propriedade em pedido associado a erro.

DataFlowResource

Tipo de recurso de fluxo de dados.

Name Type Description
etag
  • string

Recurso Etag.

id
  • string

Identificação de recursos totalmente qualificada para o recurso. Ex - /subscrições/{subscriçãoD}/resourceGroups/{resourceGroupName}/fornecedores/{resourceProviderNamespace}/{resourceType}/{resourceName}

name
  • string

O nome do recurso

properties DataFlow:

Propriedades de fluxo de dados.

type
  • string

O tipo de recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft. Armazenamento/armazenamentoCotas"

DataFlowSink

Transformação para fluxo de dados afundar.

Name Type Description
dataset

Referência do conjunto de dados.

description
  • string

Descrição da transformação.

linkedService

Referência de serviço ligada.

name
  • string

Nome de transformação.

schemaLinkedService

Referência de serviço ligada a Schema.

DataFlowSource

Transformação para fonte de fluxo de dados.

Name Type Description
dataset

Referência do conjunto de dados.

description
  • string

Descrição da transformação.

linkedService

Referência de serviço ligada.

name
  • string

Nome de transformação.

schemaLinkedService

Referência de serviço ligada a Schema.

DatasetReference

Tipo de referência de conjunto de dados.

Name Type Description
parameters
  • object

Argumentos para conjunto de dados.

referenceName
  • string

Nome do conjunto de dados de referência.

type

Tipo de referência de conjunto de dados.

DatasetReferenceType

Tipo de referência de conjunto de dados.

Name Type Description
DatasetReference
  • string

Folder

A pasta em que este fluxo de dados está dentro. Se não for especificado, o fluxo de dados aparecerá ao nível da raiz.

Name Type Description
name
  • string

O nome da pasta em que este fluxo de dados está dentro.

LinkedServiceReference

Tipo de referência de serviço ligado.

Name Type Description
parameters
  • object

Argumentos para o LinkedService.

referenceName
  • string

Nome do LinkedService de referência.

type

Tipo de referência de serviço ligado.

MappingDataFlow

Mapeamento do fluxo de dados.

Name Type Description
annotations
  • object[]

Lista de tags que podem ser usadas para descrever o fluxo de dados.

description
  • string

A descrição do fluxo de dados.

folder

A pasta em que este fluxo de dados está dentro. Se não for especificado, o fluxo de dados aparecerá ao nível da raiz.

type string:

Tipo de fluxo de dados.

typeProperties.script
  • string

DataFlow script.

typeProperties.sinks

Lista de pias no fluxo de dados.

typeProperties.sources

Lista de fontes no fluxo de dados.

typeProperties.transformations

Lista de transformações no fluxo de dados.

Transformation

Uma transformação do fluxo de dados.

Name Type Description
description
  • string

Descrição da transformação.

name
  • string

Nome de transformação.

Type

Tipo de referência de serviço ligado.

Name Type Description
LinkedServiceReference
  • string