[Synapse] Support long running operation and add subclass of Activity…

… in artifact (Azure#10270) * change response status code * add activities * fix ModelValidation and PrettierCheck * long running operation * fix description * fix tab Co-authored-by: Wan Yang <[email protected]>
00Kai0 · Oct 12, 2020 · d3e7133 · d3e7133
1 parent aea2b89
commit d3e7133
Show file tree

Hide file tree

Showing 15 changed files with 257 additions and 18 deletions.
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
@@ -77,6 +77,7 @@
           }
         },
         "description": "Creates or updates a linked service.",
+        "x-ms-long-running-operation": true,
         "parameters": [
           {
             "$ref": "#/parameters/linkedServiceName"
@@ -108,6 +109,9 @@
               "$ref": "#/definitions/LinkedServiceResource"
             }
           },
+          "202": {
+            "description": "Accepted."
+          },
           "default": {
             "description": "An error response received from the Azure Synapse service.",
             "schema": {
@@ -171,6 +175,7 @@
           }
         },
         "description": "Deletes a linked service.",
+        "x-ms-long-running-operation": true,
         "parameters": [
           {
             "$ref": "#/parameters/linkedServiceName"
@@ -183,6 +188,9 @@
           "200": {
             "description": "OK."
           },
+          "202": {
+            "description": "Accepted."
+          },
           "204": {
             "description": "No Content."
           },
@@ -415,6 +423,7 @@
           }
         },
         "description": "Creates or updates a pipeline.",
+        "x-ms-long-running-operation": true,
         "parameters": [
           {
             "$ref": "#/parameters/pipelineName"
@@ -446,6 +455,9 @@
               "$ref": "#/definitions/PipelineResource"
             }
           },
+          "202": {
+            "description": "Accepted."
+          },
           "default": {
             "description": "An error response received from the Azure Synapse service.",
             "schema": {
@@ -509,6 +521,7 @@
           }
         },
         "description": "Deletes a pipeline.",
+        "x-ms-long-running-operation": true,
         "parameters": [
           {
             "$ref": "#/parameters/pipelineName"
@@ -521,6 +534,9 @@
           "200": {
             "description": "OK."
           },
+          "202": {
+            "description": "Accepted."
+          },
           "204": {
             "description": "No Content."
           },
@@ -545,6 +561,7 @@
           }
         },
         "description": "Creates a run of a pipeline.",
+        "x-ms-long-running-operation": true,
         "parameters": [
           {
             "$ref": "#/parameters/pipelineName"
@@ -593,6 +610,9 @@
               "$ref": "#/definitions/CreateRunResponse"
             }
           },
+          "202": {
+            "description": "Accepted."
+          },
           "default": {
             "description": "An error response received from the Azure Synapse service.",
             "schema": {
@@ -819,6 +839,7 @@
           }
         },
         "description": "Creates or updates a trigger.",
+        "x-ms-long-running-operation": true,
         "parameters": [
           {
             "$ref": "#/parameters/triggerName"
@@ -850,6 +871,9 @@
               "$ref": "#/definitions/TriggerResource"
             }
           },
+          "202": {
+            "description": "Accepted."
+          },
           "default": {
             "description": "An error response received from the Azure Synapse service.",
             "schema": {
@@ -913,6 +937,7 @@
           }
         },
         "description": "Deletes a trigger.",
+        "x-ms-long-running-operation": true,
         "parameters": [
           {
             "$ref": "#/parameters/triggerName"
@@ -925,6 +950,9 @@
           "200": {
             "description": "OK."
           },
+          "202": {
+            "description": "Accepted."
+          },
           "204": {
             "description": "No Content."
           },
@@ -2145,6 +2173,7 @@
           }
         },
         "description": "Creates or updates a Note Book.",
+        "x-ms-long-running-operation": true,
         "parameters": [
           {
             "$ref": "#/parameters/NotebookName"
@@ -2176,6 +2205,9 @@
               "$ref": "#/definitions/NotebookResource"
             }
           },
+          "202": {
+            "description": "Accepted."
+          },
           "default": {
             "description": "An error response received from the Azure Synapse service.",
             "schema": {
@@ -2239,6 +2271,7 @@
           }
         },
         "description": "Deletes a Note book.",
+        "x-ms-long-running-operation": true,
         "parameters": [
           {
             "$ref": "#/parameters/NotebookName"
@@ -2251,6 +2284,9 @@
           "200": {
             "description": "OK."
           },
+          "202": {
+            "description": "Accepted."
+          },
           "204": {
             "description": "No Content."
           },
@@ -4166,6 +4202,78 @@
           "readOnly": true
         }
       }
+    },
+    "SynapseNotebookReference": {
+      "description": "Synapse notebook reference type.",
+      "properties": {
+        "type": {
+          "type": "string",
+          "description": "Synapse notebook reference type.",
+          "enum": [
+            "NotebookReference"
+          ],
+          "x-ms-enum": {
+            "name": "NotebookReferenceType",
+            "modelAsString": true
+          }
+        },
+        "referenceName": {
+          "type": "string",
+          "description": "Reference notebook name."
+        }
+      },
+      "required": [
+        "type",
+        "referenceName"
+      ]
+    },
+    "SynapseSparkJobReference": {
+      "description": "Synapse spark job reference type.",
+      "properties": {
+        "type": {
+          "type": "string",
+          "description": "Synapse spark job reference type.",
+          "enum": [
+            "SparkJobDefinitionReference"
+          ],
+          "x-ms-enum": {
+            "name": "SparkJobReferenceType",
+            "modelAsString": true
+          }
+        },
+        "referenceName": {
+          "type": "string",
+          "description": "Reference spark job name."
+        }
+      },
+      "required": [
+        "type",
+        "referenceName"
+      ]
+    },
+    "SqlPoolReference": {
+      "description": "SQL pool reference type.",
+      "properties": {
+        "type": {
+          "type": "string",
+          "description": "SQL pool reference type.",
+          "enum": [
+            "SqlPoolReference"
+          ],
+          "x-ms-enum": {
+            "name": "SqlPoolReferenceType",
+            "modelAsString": true
+          }
+        },
+        "referenceName": {
+          "type": "string",
+          "description": "Reference SQL pool name."
+        }
+      },
+      "required": [
+        "type",
+        "referenceName"
+      ]
     }
   },
   "parameters": {

diff --git a/...synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/Pipeline.json b/...synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/Pipeline.json
@@ -5831,6 +5831,115 @@
       "required": [
         "dataFlow"
       ]
+    },
+    "SynapseNotebookActivity": {
+      "description": "Execute Synapse notebook activity.",
+      "x-ms-discriminator-value": "SynapseNotebook",
+      "allOf": [
+        {
+          "$ref": "#/definitions/Activity"
+        }
+      ],
+      "properties": {
+        "typeProperties": {
+          "x-ms-client-flatten": true,
+          "description": "Execute Synapse notebook activity properties.",
+          "$ref": "#/definitions/SynapseNotebookActivityTypeProperties"
+        }
+      },
+      "required": [
+        "typeProperties"
+      ]
+    },
+    "SynapseNotebookActivityTypeProperties": {
+      "description": "Execute Synapse notebook activity properties.",
+      "properties": {
+        "notebook": {
+          "description": "Synapse notebook reference.",
+          "$ref": "../artifacts.json#/definitions/SynapseNotebookReference"
+        },
+        "parameters": {
+          "description": "Notebook parameters.",
+          "$ref": "../artifacts.json#/definitions/ParameterValueSpecification"
+        }
+      },
+      "required": [
+        "notebook"
+      ]
+    },
+    "SynapseSparkJobDefinitionActivity": {
+      "description": "Execute spark job activity.",
+      "x-ms-discriminator-value": "SparkJob",
+      "allOf": [
+        {
+          "$ref": "#/definitions/Activity"
+        }
+      ],
+      "properties": {
+        "typeProperties": {
+          "x-ms-client-flatten": true,
+          "description": "Execute spark job activity properties.",
+          "$ref": "#/definitions/SynapseSparkJobActivityTypeProperties"
+        }
+      },
+      "required": [
+        "typeProperties"
+      ]
+    },
+    "SynapseSparkJobActivityTypeProperties": {
+      "description": "Execute spark job activity properties.",
+      "properties": {
+        "sparkJob": {
+          "description": "Synapse spark job reference.",
+          "$ref": "../artifacts.json#/definitions/SynapseSparkJobReference"
+        }
+      },
+      "required": [
+        "sparkJob"
+      ]
+    },
+    "SqlPoolStoredProcedureActivity": {
+      "description": "Execute SQL pool stored procedure activity.",
+      "x-ms-discriminator-value": "SqlPoolStoredProcedure",
+      "allOf": [
+        {
+          "$ref": "#/definitions/Activity"
+        }
+      ],
+      "properties": {
+        "sqlPool": {
+          "description": "SQL pool stored procedure reference.",
+          "$ref": "../artifacts.json#/definitions/SqlPoolReference"
+        },
+        "typeProperties": {
+          "x-ms-client-flatten": true,
+          "description": "Execute SQL pool stored procedure activity properties.",
+          "$ref": "#/definitions/SqlPoolStoredProcedureActivityTypeProperties"
+        }
+      },
+      "required": [
+        "sqlPool",
+        "typeProperties"
+      ]
+    },
+    "SqlPoolStoredProcedureActivityTypeProperties": {
+      "description": "SQL stored procedure activity properties.",
+      "properties": {
+        "storedProcedureName": {
+          "type": "object",
+          "description": "Stored procedure name. Type: string (or Expression with resultType string)."
+        },
+        "storedProcedureParameters": {
+          "description": "Value and type setting for stored procedure parameters. Example: \"{Parameter1: {value: \"1\", type: \"int\"}}\".",
+          "type": "object",
+          "additionalProperties": {
+            "$ref": "#/definitions/StoredProcedureParameter"
+          }
+        }
+      },
+      "required": [
+        "storedProcedureName"
+      ]
     }
   }
 }
diff --git a/...ta-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/LinkedServices_Create.json b/...ta-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/LinkedServices_Create.json
@@ -17,14 +17,16 @@
     "api-version": "2019-06-01-preview"
   },
   "responses": {
-    "200": {
+    "202": {
       "headers": {
         "Date": "Sat, 16 Jun 2018 00:37:34 GMT",
         "X-Content-Type-Options": "nosniff",
         "x-ms-ratelimit-remaining-subscription-writes": "1196",
         "x-ms-request-id": "b3b336b3-b203-4654-9cb6-a3a8d3a4b5de",
         "x-ms-correlation-request-id": "b3b336b3-b203-4654-9cb6-a3a8d3a4b5de"
-      },
+      }
+    },
+    "200": {
       "body": {
         "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/linkedservices/exampleLinkedService",
         "name": "exampleLinkedService",

diff --git a/...ta-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/LinkedServices_Delete.json b/...ta-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/LinkedServices_Delete.json
@@ -6,6 +6,7 @@
   },
   "responses": {
     "200": {},
+    "202": {},
     "204": {}
   }
 }