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.

Sign up for GitHub

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

[Synapse] Fix create debug session payload on Synapse workspace. #15731

Merged
merged 6 commits into from
Sep 14, 2021
Merged

[Synapse] Fix create debug session payload on Synapse workspace. #15731

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
171a1b0
add debug creation info
jackmagic313 Aug 20, 2021
82376a9
add debug creation info
jackmagic313 Aug 20, 2021
bee85ff
push more fixs for other gaps
jackmagic313 Aug 24, 2021
644de70
update stable version as well
jackmagic313 Aug 27, 2021
ecd2c50
fix examples
jackmagic313 Sep 7, 2021
11763ac
Resolve conflicts
Sep 14, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
100 changes: 67 additions & 33 deletions specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/artifacts.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2888,32 +2888,41 @@
"description": "Request body structure for creating data flow debug session.",
"type": "object",
"properties": {
"dataFlowName": {
"description": "The name of the data flow.",
"type": "string"
},
"existingClusterId": {
"description": "The ID of existing Databricks cluster.",
"computeType": {
"description": "Compute type of the cluster. The value will be overwritten by the same setting in integration runtime if provided.",
"type": "string"
},
"clusterTimeout": {
"description": "Timeout setting for Databricks cluster.",
"coreCount": {
"description": "Core count of the cluster. The value will be overwritten by the same setting in integration runtime if provided.",
"type": "integer"
},
"newClusterName": {
"description": "The name of new Databricks cluster.",
"type": "string"
},
"newClusterNodeType": {
"description": "The type of new Databricks cluster.",
"type": "string"
"timeToLive": {
"description": "Time to live setting of the cluster in minutes.",
"type": "integer"
},
"dataBricksLinkedService": {
"description": "Data bricks linked service.",
"$ref": "#/definitions/LinkedServiceResource"
"integrationRuntime": {
"description": "Set to use integration runtime setting for data flow debug session.",
"$ref": "#/definitions/IntegrationRuntimeDebugResource"
}
}
},
"IntegrationRuntimeDebugResource": {
"description": "Integration runtime debug resource.",
"allOf": [
{
"$ref": "#/definitions/SubResourceDebugResource"
}
],
"properties": {
"properties": {
"$ref": "../../../../resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/integrationRuntime.json#/definitions/IntegrationRuntime",
"description": "Integration runtime properties."
}
},
"required": [
"properties"
]
},
"CreateDataFlowDebugSessionResponse": {
"description": "Response body structure for creating data flow debug session.",
"type": "object",
Expand Down Expand Up @@ -2981,10 +2990,6 @@
"sessionId": {
"description": "The ID of data flow debug session.",
"type": "string"
},
"dataFlowName": {
"description": "The data flow which contains the debug session.",
"type": "string"
}
}
},
Expand Down Expand Up @@ -3062,29 +3067,58 @@
}
},
"DataFlowDebugCommandRequest": {
"description": "Request body structure for data flow expression preview.",
"description": "Request body structure for data flow debug command.",
"type": "object",
"properties": {
"sessionId": {
"description": "The ID of data flow debug session.",
"type": "string"
},
"dataFlowName": {
"description": "The data flow which contains the debug session.",
"type": "string"
},
"commandName": {
"description": "The command name.",
"type": "string"
"command": {
"description": "The command type.",
"type": "string",
"enum": [
"executePreviewQuery",
"executeStatisticsQuery",
"executeExpressionQuery"
],
"x-ms-enum": {
"name": "DataFlowDebugCommandType",
"modelAsString": true
}
},
"commandPayload": {
"description": "The command payload object.",
"type": "object"
"$ref": "#/definitions/DataFlowDebugCommandPayload"
}
}
},
"DataFlowDebugCommandPayload": {
"description": "Structure of command payload.",
"type": "object",
"properties": {
"streamName": {
"description": "The stream name which is used for preview.",
"type": "string"
},
"rowLimits": {
"description": "Row limits for preview response.",
"type": "integer"
},
"columns": {
"description": "Array of column names.",
"type": "array",
"items": {
"type": "string"
}
},
"expression": {
"description": "The expression which is used for preview.",
"type": "string"
}
},
"required": [
"sessionId",
"commandPayload"
"streamName"
]
},
"DataFlowDebugQueryResponse": {
Expand Down
24 changes: 12 additions & 12 deletions ...ne/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataFlowDebugSession_Create.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,21 @@
"parameters": {
"endpoint": "exampleWorkspace.dev.azuresynapse.net",
"request": {
"dataFlowName": "dataflow",
"existingClusterId": "1221221",
"clusterTimeout": 50,
"newClusterName": "newClusterName",
"newClusterNodeType": "newClusterNodeType",
"dataBricksLinkedService": {
"timeToLive": 60,
"integrationRuntime": {
"name": "ir1",
"properties": {
"type": "AzureStorage",
"type": "Managed",
"typeProperties": {
"connectionString": {
"type": "SecureString",
"value": "DefaultEndpointsProtocol=https;AccountName=examplestorageaccount;AccountKey=<storage key>"
"computeProperties": {
"location": "AutoResolve",
"dataFlowProperties": {
"computeType": "General",
"coreCount": 48,
"timeToLive": 10
}
}
},
"description": "Example description"
}
}
}
},
Expand Down
3 changes: 1 addition & 2 deletions ...soft.Synapse/preview/2019-06-01-preview/examples/DataFlowDebugSession_ExecuteCommand.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,11 @@
"parameters": {
"endpoint": "exampleWorkspace.dev.azuresynapse.net",
"request": {
"dataFlowName": "dataFlowName",
"commandPayload": {
"streamName": "source1",
"rowLimits": 100
},
"commandName": "executePreviewQuery",
"command": "executePreviewQuery",
"sessionId": "f06ed247-9d07-49b2-b05e-2cb4a2fc871e"
},
"api-version": "2019-06-01-preview"
Expand Down
96 changes: 67 additions & 29 deletions specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/dataflows.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -511,32 +511,41 @@
"description": "Request body structure for creating data flow debug session.",
"type": "object",
"properties": {
"dataFlowName": {
"description": "The name of the data flow.",
"type": "string"
},
"existingClusterId": {
"description": "The ID of existing Databricks cluster.",
"computeType": {
"description": "Compute type of the cluster. The value will be overwritten by the same setting in integration runtime if provided.",
"type": "string"
},
"clusterTimeout": {
"description": "Timeout setting for Databricks cluster.",
"coreCount": {
"description": "Core count of the cluster. The value will be overwritten by the same setting in integration runtime if provided.",
"type": "integer"
},
"newClusterName": {
"description": "The name of new Databricks cluster.",
"type": "string"
},
"newClusterNodeType": {
"description": "The type of new Databricks cluster.",
"type": "string"
"timeToLive": {
"description": "Time to live setting of the cluster in minutes.",
"type": "integer"
},
"dataBricksLinkedService": {
"description": "Data bricks linked service.",
"$ref": "linkedServices.json#/definitions/LinkedServiceResource"
"integrationRuntime": {
"description": "Set to use integration runtime setting for data flow debug session.",
"$ref": "#/definitions/IntegrationRuntimeDebugResource"
}
}
},
"IntegrationRuntimeDebugResource": {
"description": "Integration runtime debug resource.",
"allOf": [
{
"$ref": "artifacts.json#/definitions/SubResourceDebugResource"
}
],
"properties": {
"properties": {
"$ref": "../../../../resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/integrationRuntime.json#/definitions/IntegrationRuntime",
"description": "Integration runtime properties."
}
},
"required": [
"properties"
]
},
"CreateDataFlowDebugSessionResponse": {
"description": "Response body structure for creating data flow debug session.",
"type": "object",
Expand Down Expand Up @@ -862,29 +871,58 @@
}
},
"DataFlowDebugCommandRequest": {
"description": "Request body structure for data flow expression preview.",
"description": "Request body structure for data flow debug command.",
"type": "object",
"properties": {
"sessionId": {
"description": "The ID of data flow debug session.",
"type": "string"
},
"dataFlowName": {
"description": "The data flow which contains the debug session.",
"type": "string"
},
"commandName": {
"description": "The command name.",
"type": "string"
"command": {
"description": "The command type.",
"type": "string",
"enum": [
"executePreviewQuery",
"executeStatisticsQuery",
"executeExpressionQuery"
],
"x-ms-enum": {
"name": "DataFlowDebugCommandType",
"modelAsString": true
}
},
"commandPayload": {
"description": "The command payload object.",
"type": "object"
"$ref": "#/definitions/DataFlowDebugCommandPayload"
}
}
},
"DataFlowDebugCommandPayload": {
"description": "Structure of command payload.",
"type": "object",
"properties": {
"streamName": {
"description": "The stream name which is used for preview.",
"type": "string"
},
"rowLimits": {
"description": "Row limits for preview response.",
"type": "integer"
},
"columns": {
"description": "Array of column names.",
"type": "array",
"items": {
"type": "string"
}
},
"expression": {
"description": "The expression which is used for preview.",
"type": "string"
}
},
"required": [
"sessionId",
"commandPayload"
"streamName"
]
},
"DataFlowDebugQueryResponse": {
Expand Down
24 changes: 12 additions & 12 deletions ...ne/Microsoft.Synapse/preview/2021-06-01-preview/examples/DataFlowDebugSession_Create.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,21 @@
"parameters": {
"endpoint": "exampleWorkspace.dev.azuresynapse.net",
"request": {
"dataFlowName": "dataflow",
"existingClusterId": "1221221",
"clusterTimeout": 50,
"newClusterName": "newClusterName",
"newClusterNodeType": "newClusterNodeType",
"dataBricksLinkedService": {
"timeToLive": 60,
"integrationRuntime": {
"name": "ir1",
"properties": {
"type": "AzureStorage",
"type": "Managed",
"typeProperties": {
"connectionString": {
"type": "SecureString",
"value": "DefaultEndpointsProtocol=https;AccountName=examplestorageaccount;AccountKey=<storage key>"
"computeProperties": {
"location": "AutoResolve",
"dataFlowProperties": {
"computeType": "General",
"coreCount": 48,
"timeToLive": 10
}
}
},
"description": "Example description"
}
}
}
},
Expand Down
3 changes: 1 addition & 2 deletions ...soft.Synapse/preview/2021-06-01-preview/examples/DataFlowDebugSession_ExecuteCommand.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,11 @@
"parameters": {
"endpoint": "exampleWorkspace.dev.azuresynapse.net",
"request": {
"dataFlowName": "dataFlowName",
"commandPayload": {
"streamName": "source1",
"rowLimits": 100
},
"commandName": "executePreviewQuery",
"command": "executePreviewQuery",
"sessionId": "f06ed247-9d07-49b2-b05e-2cb4a2fc871e"
},
"api-version": "2021-06-01-preview"
Expand Down
Loading