Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Data Factory] data flow + debug session API swagger #7088

Merged
merged 15 commits into from
Sep 24, 2019

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1,143 @@
{
"swagger": "2.0",
"info": {
"title": "DataFactoryManagementClient",
"version": "2018-06-01"
},
"paths": {},
"definitions": {
"DataFlow": {
"description": "Azure Data Factory nested object which contains a flow with data movements and transformations.",
"type": "object",
"discriminator": "type",
"properties": {
"type": {
"type": "string",
"description": "Type of data flow."
},
"description": {
"description": "The description of the data flow.",
"type": "string"
},
"annotations": {
"description": "List of tags that can be used for describing the data flow.",
"type": "array",
"items": {
"type": "object"
}
},
"folder": {
"description": "The folder that this data flow is in. If not specified, Data flow will appear at the root level.",
"type": "object",
"properties": {
"name": {
"description": "The name of the folder that this data flow is in.",
"type": "string"
}
}
}
}
},
"MappingDataFlow": {
"x-ms-discriminator-value": "MappingDataFlow",
"description": "Mapping data flow.",
"type": "object",
"allOf": [
{
"$ref": "#/definitions/DataFlow"
}
],
"properties": {
"typeProperties": {
"description": "Mapping data flow type properties.",
"x-ms-client-flatten": true,
"$ref": "#/definitions/MappingDataFlowTypeProperties"
}
}
},
"MappingDataFlowTypeProperties": {
"description": "Mapping data flow type properties.",
"properties": {
"sources": {
"type": "array",
"description": "List of sources in data flow.",
"items": {
"$ref": "#/definitions/DataFlowSource"
}
},
"sinks": {
"type": "array",
"description": "List of sinks in data flow.",
"items": {
"$ref": "#/definitions/DataFlowSink"
}
},
"transformations": {
"type": "array",
"description": "List of transformations in data flow.",
"items": {
"$ref": "#/definitions/Transformation"
}
},
"script": {
"type": "string",
"description": "DataFlow script."
}
}
},
"Transformation": {
"description": "A data flow transformation.",
"type": "object",
"properties": {
"name": {
"description": "Transformation name.",
"type": "string"
},
"description": {
"description": "Transformation description.",
"type": "string"
}
},
"additionalProperties": {
"type": "object"
},
"required": [
"name"
]
},
"DataFlowSource": {
"description": "Transformation for data flow source.",
"allOf": [
{
"$ref": "#/definitions/Transformation"
}
],
"properties": {
"dataset": {
"description": "Dataset reference.",
"$ref": "../datafactory.json#/definitions/DatasetReference"
}
},
"additionalProperties": {
"type": "object"
}
},
"DataFlowSink": {
"description": "Transformation for data flow sink.",
"allOf": [
{
"$ref": "#/definitions/Transformation"
}
],
"properties": {
"dataset": {
"description": "Dataset reference.",
"$ref": "../datafactory.json#/definitions/DatasetReference"
}
},
"additionalProperties": {
"type": "object"
}
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -5317,6 +5317,45 @@
"method",
"url"
]
},
"ExecuteDataFlowActivity": {
"description": "Execute data flow activity.",
"x-ms-discriminator-value": "ExecuteDataFlow",
"allOf": [
{
"$ref": "#/definitions/ExecutionActivity"
}
],
"properties": {
"typeProperties": {
"x-ms-client-flatten": true,
"description": "Execute data flow activity properties.",
"$ref": "#/definitions/ExecuteDataFlowActivityTypeProperties"
}
},
"required": [
"typeProperties"
]
},
"ExecuteDataFlowActivityTypeProperties": {
"description": "Execute data flow activity properties.",
"properties": {
"dataFlow": {
"description": "Data flow reference.",
"$ref": "../datafactory.json#/definitions/DataFlowReference"
},
"staging": {
"description": "Staging info for execute data flow activity.",
"$ref": "../datafactory.json#/definitions/DataFlowStagingInfo"
},
"integrationRuntime": {
"description": "The integration runtime reference.",
"$ref": "../datafactory.json#/definitions/IntegrationRuntimeReference"
}
},
"required": [
"dataFlow"
]
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
{
"parameters": {
"subscriptionId": "12345678-1234-1234-1234-12345678abc",
"resourceGroupName": "exampleResourceGroup",
"factoryName": "exampleFactoryName",
"request": {
"dataFlow": {
"properties": {
"type": "MappingDataFlow",
"typeProperties": {
"sources": [
{
"dataset": {
"referenceName": "DelimitedText2",
"type": "DatasetReference"
},
"name": "source1",
"typeProperties": {}
}
],
"sinks": [],
"transformations": [],
"script": "\n\nsource(output(\n\t\tColumn_1 as string\n\t),\n\tallowSchemaDrift: true,\n\tvalidateSchema: false) ~> source1"
}
}
},
"datasets": [
{
"properties": {
"linkedServiceName": {
"referenceName": "linkedService5",
"type": "LinkedServiceReference"
},
"annotations": [],
"type": "DelimitedText",
"typeProperties": {
"location": {
"type": "AzureBlobStorageLocation",
"fileName": "Ansiencoding.csv",
"container": "dataflow-sample-data"
},
"columnDelimiter": ",",
"escapeChar": "\\",
"firstRowAsHeader": true,
"quoteChar": "\""
},
"schema": [
{
"type": "String"
}
]
}
}
],
"linkedServices": [
{
"properties": {
"type": "AzureBlobStorage",
"typeProperties": {
"connectionString": "DefaultEndpointsProtocol=https;AccountName=<storageName>;EndpointSuffix=core.windows.net;",
"encryptedCredential": "<credential>"
},
"annotations": []
}
}
],
"debugSettings": {
"sourceSettings": [
{
"sourceName": "source1",
"rowLimit": 1000
},
{
"sourceName": "source2",
"rowLimit": 222
}
],
"parameters": {
"sourcePath": "Toy"
},
"datasetParameters": {
"Movies": {
"path": "abc"
},
"Output": {
"time": "def"
}
}
},
"sessionId": "f06ed247-9d07-49b2-b05e-2cb4a2fc871e"
},
"api-version": "2018-06-01"
},
"responses": {
"200": {
"headers": {
"Date": "Sat, 16 Jun 2018 00:40:01 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-ratelimit-remaining-subscription-reads": "14989",
"x-ms-request-id": "2f955e10-c6df-45a7-97d4-81acdb8540cd",
"x-ms-correlation-request-id": "2f955e10-c6df-45a7-97d4-81acdb8540cd"
},
"body": {
"jobVersion": "e5328ee7-c524-4207-8ba4-b709010db33d"
}
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
{
"parameters": {
"subscriptionId": "12345678-1234-1234-1234-12345678abc",
"resourceGroupName": "exampleResourceGroup",
"factoryName": "exampleFactoryName",
"request": {
"timeToLive": 60,
"integrationRuntime": {
"properties": {
"type": "Managed",
"typeProperties": {
"computeProperties": {
"location": "AutoResolve",
"dataFlowProperties": {
"computeType": "General",
"coreCount": 48,
"timeToLive": 10
}
}
}
}
}
},
"api-version": "2018-06-01"
},
"responses": {
"202": {
"headers": {
"Date": "Sat, 16 Jun 2018 00:40:01 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-ratelimit-remaining-subscription-reads": "14989",
"x-ms-request-id": "2f955e10-c6df-45a7-97d4-81acdb8540cd",
"x-ms-correlation-request-id": "2f955e10-c6df-45a7-97d4-81acdb8540cd",
"location": "https://management.azure.com/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/operationStatuses/dfCreateSession$$229c688c-944c-44ac-b31a-82d50f347154?api-version=2018-06-01"
}
},
"200": {
"body": {
"status": "Succeeded",
"sessionId": "229c688c-944c-44ac-b31a-82d50f347154"
}
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
{
"parameters": {
"subscriptionId": "12345678-1234-1234-1234-12345678abc",
"resourceGroupName": "exampleResourceGroup",
"factoryName": "exampleFactoryName",
"request": {
"sessionId": "91fb57e0-8292-47be-89ff-c8f2d2bb2a7e"
},
"api-version": "2018-06-01"
},
"responses": {
"200": {
"headers": {
"Date": "Sat, 16 Jun 2018 00:40:01 GMT",
"X-Content-Type-Options": "nosniff",
"x-ms-ratelimit-remaining-subscription-reads": "14989",
"x-ms-request-id": "2f955e10-c6df-45a7-97d4-81acdb8540cd",
"x-ms-correlation-request-id": "2f955e10-c6df-45a7-97d4-81acdb8540cd"
}
}
}
}
Loading