diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/artifacts.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/artifacts.json index c79b02126869..2aaacc2f4590 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/artifacts.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/artifacts.json @@ -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", @@ -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" } } }, @@ -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": { diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataFlowDebugSession_Create.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataFlowDebugSession_Create.json index b1644c6737c5..20d28c3cafba 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataFlowDebugSession_Create.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataFlowDebugSession_Create.json @@ -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=" + "computeProperties": { + "location": "AutoResolve", + "dataFlowProperties": { + "computeType": "General", + "coreCount": 48, + "timeToLive": 10 + } } - }, - "description": "Example description" + } } } }, diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataFlowDebugSession_ExecuteCommand.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataFlowDebugSession_ExecuteCommand.json index 9c88adb10bde..dcd9fefdfbca 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataFlowDebugSession_ExecuteCommand.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataFlowDebugSession_ExecuteCommand.json @@ -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" diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/dataflows.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/dataflows.json index e04b77149c12..8ef780903d4b 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/dataflows.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/dataflows.json @@ -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", @@ -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": { diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/DataFlowDebugSession_Create.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/DataFlowDebugSession_Create.json index 357f7f941d7a..cb80c7752465 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/DataFlowDebugSession_Create.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/DataFlowDebugSession_Create.json @@ -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=" + "computeProperties": { + "location": "AutoResolve", + "dataFlowProperties": { + "computeType": "General", + "coreCount": 48, + "timeToLive": 10 + } } - }, - "description": "Example description" + } } } }, diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/DataFlowDebugSession_ExecuteCommand.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/DataFlowDebugSession_ExecuteCommand.json index d5ce58ed0bb0..c251d90ee689 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/DataFlowDebugSession_ExecuteCommand.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/examples/DataFlowDebugSession_ExecuteCommand.json @@ -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" diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/dataflows.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/dataflows.json index e1d5356beb0d..1e02efac302c 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/dataflows.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/dataflows.json @@ -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", @@ -869,22 +878,51 @@ "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": { diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/DataFlowDebugSession_Create.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/DataFlowDebugSession_Create.json index 8945f99f3520..7b2b93851a47 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/DataFlowDebugSession_Create.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/DataFlowDebugSession_Create.json @@ -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=" + "computeProperties": { + "location": "AutoResolve", + "dataFlowProperties": { + "computeType": "General", + "coreCount": 48, + "timeToLive": 10 + } } - }, - "description": "Example description" + } } } }, diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/DataFlowDebugSession_ExecuteCommand.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/DataFlowDebugSession_ExecuteCommand.json index 870e2fecca8f..ba36e72fce4f 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/DataFlowDebugSession_ExecuteCommand.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/examples/DataFlowDebugSession_ExecuteCommand.json @@ -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": "2020-12-01"