Skip to content

Commit e6cd09a

Browse files
jackmagic313Dongwei Wang
jackmagic313
and
Dongwei Wang
authored
[Synapse] Fix create debug session payload on Synapse workspace. (#15731)
* add debug creation info * add debug creation info * push more fixs for other gaps * update stable version as well * fix examples * Resolve conflicts Co-authored-by: Dongwei Wang <[email protected]>
1 parent ee1dc80 commit e6cd09a

File tree

9 files changed

+239
-132
lines changed

9 files changed

+239
-132
lines changed

‎specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/artifacts.json

Lines changed: 67 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -2888,32 +2888,41 @@
28882888
"description": "Request body structure for creating data flow debug session.",
28892889
"type": "object",
28902890
"properties": {
2891-
"dataFlowName": {
2892-
"description": "The name of the data flow.",
2893-
"type": "string"
2894-
},
2895-
"existingClusterId": {
2896-
"description": "The ID of existing Databricks cluster.",
2891+
"computeType": {
2892+
"description": "Compute type of the cluster. The value will be overwritten by the same setting in integration runtime if provided.",
28972893
"type": "string"
28982894
},
2899-
"clusterTimeout": {
2900-
"description": "Timeout setting for Databricks cluster.",
2895+
"coreCount": {
2896+
"description": "Core count of the cluster. The value will be overwritten by the same setting in integration runtime if provided.",
29012897
"type": "integer"
29022898
},
2903-
"newClusterName": {
2904-
"description": "The name of new Databricks cluster.",
2905-
"type": "string"
2906-
},
2907-
"newClusterNodeType": {
2908-
"description": "The type of new Databricks cluster.",
2909-
"type": "string"
2899+
"timeToLive": {
2900+
"description": "Time to live setting of the cluster in minutes.",
2901+
"type": "integer"
29102902
},
2911-
"dataBricksLinkedService": {
2912-
"description": "Data bricks linked service.",
2913-
"$ref": "#/definitions/LinkedServiceResource"
2903+
"integrationRuntime": {
2904+
"description": "Set to use integration runtime setting for data flow debug session.",
2905+
"$ref": "#/definitions/IntegrationRuntimeDebugResource"
29142906
}
29152907
}
29162908
},
2909+
"IntegrationRuntimeDebugResource": {
2910+
"description": "Integration runtime debug resource.",
2911+
"allOf": [
2912+
{
2913+
"$ref": "#/definitions/SubResourceDebugResource"
2914+
}
2915+
],
2916+
"properties": {
2917+
"properties": {
2918+
"$ref": "../../../../resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/integrationRuntime.json#/definitions/IntegrationRuntime",
2919+
"description": "Integration runtime properties."
2920+
}
2921+
},
2922+
"required": [
2923+
"properties"
2924+
]
2925+
},
29172926
"CreateDataFlowDebugSessionResponse": {
29182927
"description": "Response body structure for creating data flow debug session.",
29192928
"type": "object",
@@ -2981,10 +2990,6 @@
29812990
"sessionId": {
29822991
"description": "The ID of data flow debug session.",
29832992
"type": "string"
2984-
},
2985-
"dataFlowName": {
2986-
"description": "The data flow which contains the debug session.",
2987-
"type": "string"
29882993
}
29892994
}
29902995
},
@@ -3062,29 +3067,58 @@
30623067
}
30633068
},
30643069
"DataFlowDebugCommandRequest": {
3065-
"description": "Request body structure for data flow expression preview.",
3070+
"description": "Request body structure for data flow debug command.",
30663071
"type": "object",
30673072
"properties": {
30683073
"sessionId": {
30693074
"description": "The ID of data flow debug session.",
30703075
"type": "string"
30713076
},
3072-
"dataFlowName": {
3073-
"description": "The data flow which contains the debug session.",
3074-
"type": "string"
3075-
},
3076-
"commandName": {
3077-
"description": "The command name.",
3078-
"type": "string"
3077+
"command": {
3078+
"description": "The command type.",
3079+
"type": "string",
3080+
"enum": [
3081+
"executePreviewQuery",
3082+
"executeStatisticsQuery",
3083+
"executeExpressionQuery"
3084+
],
3085+
"x-ms-enum": {
3086+
"name": "DataFlowDebugCommandType",
3087+
"modelAsString": true
3088+
}
30793089
},
30803090
"commandPayload": {
30813091
"description": "The command payload object.",
3082-
"type": "object"
3092+
"$ref": "#/definitions/DataFlowDebugCommandPayload"
3093+
}
3094+
}
3095+
},
3096+
"DataFlowDebugCommandPayload": {
3097+
"description": "Structure of command payload.",
3098+
"type": "object",
3099+
"properties": {
3100+
"streamName": {
3101+
"description": "The stream name which is used for preview.",
3102+
"type": "string"
3103+
},
3104+
"rowLimits": {
3105+
"description": "Row limits for preview response.",
3106+
"type": "integer"
3107+
},
3108+
"columns": {
3109+
"description": "Array of column names.",
3110+
"type": "array",
3111+
"items": {
3112+
"type": "string"
3113+
}
3114+
},
3115+
"expression": {
3116+
"description": "The expression which is used for preview.",
3117+
"type": "string"
30833118
}
30843119
},
30853120
"required": [
3086-
"sessionId",
3087-
"commandPayload"
3121+
"streamName"
30883122
]
30893123
},
30903124
"DataFlowDebugQueryResponse": {

‎specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataFlowDebugSession_Create.json

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,21 @@
22
"parameters": {
33
"endpoint": "exampleWorkspace.dev.azuresynapse.net",
44
"request": {
5-
"dataFlowName": "dataflow",
6-
"existingClusterId": "1221221",
7-
"clusterTimeout": 50,
8-
"newClusterName": "newClusterName",
9-
"newClusterNodeType": "newClusterNodeType",
10-
"dataBricksLinkedService": {
5+
"timeToLive": 60,
6+
"integrationRuntime": {
7+
"name": "ir1",
118
"properties": {
12-
"type": "AzureStorage",
9+
"type": "Managed",
1310
"typeProperties": {
14-
"connectionString": {
15-
"type": "SecureString",
16-
"value": "DefaultEndpointsProtocol=https;AccountName=examplestorageaccount;AccountKey=<storage key>"
11+
"computeProperties": {
12+
"location": "AutoResolve",
13+
"dataFlowProperties": {
14+
"computeType": "General",
15+
"coreCount": 48,
16+
"timeToLive": 10
17+
}
1718
}
18-
},
19-
"description": "Example description"
19+
}
2020
}
2121
}
2222
},

‎specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataFlowDebugSession_ExecuteCommand.json

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,11 @@
22
"parameters": {
33
"endpoint": "exampleWorkspace.dev.azuresynapse.net",
44
"request": {
5-
"dataFlowName": "dataFlowName",
65
"commandPayload": {
76
"streamName": "source1",
87
"rowLimits": 100
98
},
10-
"commandName": "executePreviewQuery",
9+
"command": "executePreviewQuery",
1110
"sessionId": "f06ed247-9d07-49b2-b05e-2cb4a2fc871e"
1211
},
1312
"api-version": "2019-06-01-preview"

‎specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/dataflows.json

Lines changed: 67 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -511,32 +511,41 @@
511511
"description": "Request body structure for creating data flow debug session.",
512512
"type": "object",
513513
"properties": {
514-
"dataFlowName": {
515-
"description": "The name of the data flow.",
516-
"type": "string"
517-
},
518-
"existingClusterId": {
519-
"description": "The ID of existing Databricks cluster.",
514+
"computeType": {
515+
"description": "Compute type of the cluster. The value will be overwritten by the same setting in integration runtime if provided.",
520516
"type": "string"
521517
},
522-
"clusterTimeout": {
523-
"description": "Timeout setting for Databricks cluster.",
518+
"coreCount": {
519+
"description": "Core count of the cluster. The value will be overwritten by the same setting in integration runtime if provided.",
524520
"type": "integer"
525521
},
526-
"newClusterName": {
527-
"description": "The name of new Databricks cluster.",
528-
"type": "string"
529-
},
530-
"newClusterNodeType": {
531-
"description": "The type of new Databricks cluster.",
532-
"type": "string"
522+
"timeToLive": {
523+
"description": "Time to live setting of the cluster in minutes.",
524+
"type": "integer"
533525
},
534-
"dataBricksLinkedService": {
535-
"description": "Data bricks linked service.",
536-
"$ref": "linkedServices.json#/definitions/LinkedServiceResource"
526+
"integrationRuntime": {
527+
"description": "Set to use integration runtime setting for data flow debug session.",
528+
"$ref": "#/definitions/IntegrationRuntimeDebugResource"
537529
}
538530
}
539531
},
532+
"IntegrationRuntimeDebugResource": {
533+
"description": "Integration runtime debug resource.",
534+
"allOf": [
535+
{
536+
"$ref": "artifacts.json#/definitions/SubResourceDebugResource"
537+
}
538+
],
539+
"properties": {
540+
"properties": {
541+
"$ref": "../../../../resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/integrationRuntime.json#/definitions/IntegrationRuntime",
542+
"description": "Integration runtime properties."
543+
}
544+
},
545+
"required": [
546+
"properties"
547+
]
548+
},
540549
"CreateDataFlowDebugSessionResponse": {
541550
"description": "Response body structure for creating data flow debug session.",
542551
"type": "object",
@@ -862,29 +871,58 @@
862871
}
863872
},
864873
"DataFlowDebugCommandRequest": {
865-
"description": "Request body structure for data flow expression preview.",
874+
"description": "Request body structure for data flow debug command.",
866875
"type": "object",
867876
"properties": {
868877
"sessionId": {
869878
"description": "The ID of data flow debug session.",
870879
"type": "string"
871880
},
872-
"dataFlowName": {
873-
"description": "The data flow which contains the debug session.",
874-
"type": "string"
875-
},
876-
"commandName": {
877-
"description": "The command name.",
878-
"type": "string"
881+
"command": {
882+
"description": "The command type.",
883+
"type": "string",
884+
"enum": [
885+
"executePreviewQuery",
886+
"executeStatisticsQuery",
887+
"executeExpressionQuery"
888+
],
889+
"x-ms-enum": {
890+
"name": "DataFlowDebugCommandType",
891+
"modelAsString": true
892+
}
879893
},
880894
"commandPayload": {
881895
"description": "The command payload object.",
882-
"type": "object"
896+
"$ref": "#/definitions/DataFlowDebugCommandPayload"
897+
}
898+
}
899+
},
900+
"DataFlowDebugCommandPayload": {
901+
"description": "Structure of command payload.",
902+
"type": "object",
903+
"properties": {
904+
"streamName": {
905+
"description": "The stream name which is used for preview.",
906+
"type": "string"
907+
},
908+
"rowLimits": {
909+
"description": "Row limits for preview response.",
910+
"type": "integer"
911+
},
912+
"columns": {
913+
"description": "Array of column names.",
914+
"type": "array",
915+
"items": {
916+
"type": "string"
917+
}
918+
},
919+
"expression": {
920+
"description": "The expression which is used for preview.",
921+
"type": "string"
883922
}
884923
},
885924
"required": [
886-
"sessionId",
887-
"commandPayload"
925+
"streamName"
888926
]
889927
},
890928
"DataFlowDebugQueryResponse": {

‎specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/DataFlowDebugSession_Create.json

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,21 @@
22
"parameters": {
33
"endpoint": "exampleWorkspace.dev.azuresynapse.net",
44
"request": {
5-
"dataFlowName": "dataflow",
6-
"existingClusterId": "1221221",
7-
"clusterTimeout": 50,
8-
"newClusterName": "newClusterName",
9-
"newClusterNodeType": "newClusterNodeType",
10-
"dataBricksLinkedService": {
5+
"timeToLive": 60,
6+
"integrationRuntime": {
7+
"name": "ir1",
118
"properties": {
12-
"type": "AzureStorage",
9+
"type": "Managed",
1310
"typeProperties": {
14-
"connectionString": {
15-
"type": "SecureString",
16-
"value": "DefaultEndpointsProtocol=https;AccountName=examplestorageaccount;AccountKey=<storage key>"
11+
"computeProperties": {
12+
"location": "AutoResolve",
13+
"dataFlowProperties": {
14+
"computeType": "General",
15+
"coreCount": 48,
16+
"timeToLive": 10
17+
}
1718
}
18-
},
19-
"description": "Example description"
19+
}
2020
}
2121
}
2222
},

‎specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/DataFlowDebugSession_ExecuteCommand.json

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,11 @@
22
"parameters": {
33
"endpoint": "exampleWorkspace.dev.azuresynapse.net",
44
"request": {
5-
"dataFlowName": "dataFlowName",
65
"commandPayload": {
76
"streamName": "source1",
87
"rowLimits": 100
98
},
10-
"commandName": "executePreviewQuery",
9+
"command": "executePreviewQuery",
1110
"sessionId": "f06ed247-9d07-49b2-b05e-2cb4a2fc871e"
1211
},
1312
"api-version": "2021-06-01-preview"

0 commit comments

Comments
 (0)