DataFlow

AnalyticsApache SparkBig DataData IntegrationData WarehouseETLSQL

Properties

Name Type Description
type string Type of data flow.
description string
annotations array
folder object
typeProperties object
View JSON Schema on GitHub

JSON Schema

microsoft-azure-synapse-analytics-dataflow-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/DataFlow",
  "title": "DataFlow",
  "type": "object",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "type": "string",
      "description": "Type of data flow.",
      "enum": [
        "MappingDataFlow",
        "Flowlet"
      ]
    },
    "description": {
      "type": "string"
    },
    "annotations": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "folder": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        }
      }
    },
    "typeProperties": {
      "type": "object",
      "properties": {
        "sources": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string"
              },
              "dataset": {
                "type": "object",
                "properties": {
                  "referenceName": {
                    "type": "string"
                  },
                  "type": {
                    "type": "string"
                  }
                }
              }
            }
          }
        },
        "sinks": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string"
              },
              "dataset": {
                "type": "object",
                "properties": {
                  "referenceName": {
                    "type": "string"
                  },
                  "type": {
                    "type": "string"
                  }
                }
              }
            }
          }
        },
        "transformations": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string"
              },
              "description": {
                "type": "string"
              }
            }
          }
        },
        "script": {
          "type": "string",
          "description": "DataFlow script."
        }
      }
    }
  }
}