Spark Configuration DataPlane Api's Swagger Changes (#15085)

* Spark Configuration DataPlane Api's Swagger Changes Spark Configuration DataPlane Api's Swagger Changes * Spark Configuration DataPlane Api's Swagger Changes Spark Configuration DataPlane Api's Swagger Changes * Updated readme file Updated readme file * Fix CI Errors Fix CI Errors * Update readme.md Updated readme file * Fixed CI Errors Fixed CI Errors * Fixed comments Fixed comments * Added changes for new preview version Added changes for new preview version
AzureSDKAutomation · Jul 9, 2021 · c7ce6ad · c7ce6ad
1 parent 313e78f
commit c7ce6ad
Show file tree

Hide file tree

Showing 10 changed files with 556 additions and 0 deletions.
diff --git a/custom-words.txt b/custom-words.txt
@@ -1758,6 +1758,8 @@ southcentralus
 southeastasia
 southindia
 sparkconf
+sparkconfiguration
+sparkconfigurations
 sparkr
 sparql
 SPDX

diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/artifacts.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/artifacts.json
@@ -2897,6 +2897,231 @@
           }
         }
       }
+    },
+    "/sparkconfigurations": {
+      "get": {
+        "tags": [
+          "sparkconfigurations"
+        ],
+        "operationId": "SparkConfiguration_GetSparkConfigurationsByWorkspace",
+        "x-ms-examples": {
+          "SparkConfigurations_ListByWorkspace": {
+            "$ref": "./examples/SparkConfigurations_ListByWorkspace.json"
+          }
+        },
+        "description": "Lists sparkconfigurations.",
+        "parameters": [
+          {
+            "$ref": "#/parameters/ApiVersionParameter"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK.",
+            "schema": {
+              "$ref": "#/definitions/SparkConfigurationListResponse"
+            }
+          },
+          "default": {
+            "description": "An error response received from the Azure Synapse service.",
+            "schema": {
+              "$ref": "#/definitions/CloudError"
+            }
+          }
+        },
+        "x-ms-pageable": {
+          "nextLinkName": "nextLink"
+        }
+      }
+    },
+    "/sparkconfigurations/{sparkConfigurationName}": {
+      "put": {
+        "tags": [
+          "sparkconfigurations"
+        ],
+        "operationId": "SparkConfiguration_CreateOrUpdateSparkConfiguration",
+        "x-ms-examples": {
+          "SparkConfigurations_Create": {
+            "$ref": "./examples/SparkConfigurations_Create.json"
+          },
+          "SparkConfigurations_Update": {
+            "$ref": "./examples/SparkConfigurations_Update.json"
+          }
+        },
+        "description": "Creates or updates a sparkconfiguration.",
+        "x-ms-long-running-operation": true,
+        "parameters": [
+          {
+            "$ref": "#/parameters/sparkConfigurationName"
+          },
+          {
+            "$ref": "#/parameters/ApiVersionParameter"
+          },
+          {
+            "name": "If-Match",
+            "in": "header",
+            "required": false,
+            "type": "string",
+            "x-ms-client-name": "IfMatch",
+            "description": "ETag of the sparkConfiguration entity.  Should only be specified for update, for which it should match existing entity or can be * for unconditional update."
+          },
+          {
+            "name": "sparkConfiguration",
+            "description": "SparkConfiguration resource definition.",
+            "in": "body",
+            "required": true,
+            "schema": {
+              "$ref": "#/definitions/SparkConfigurationResource"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK.",
+            "schema": {
+              "$ref": "#/definitions/SparkConfigurationResource"
+            }
+          },
+          "202": {
+            "description": "Accepted."
+          },
+          "default": {
+            "description": "An error response received from the Azure Synapse service.",
+            "schema": {
+              "$ref": "#/definitions/CloudError"
+            }
+          }
+        }
+      },
+      "get": {
+        "tags": [
+          "sparkconfigurations"
+        ],
+        "operationId": "SparkConfiguration_GetSparkConfiguration",
+        "x-ms-examples": {
+          "SparkConfigurations_Get": {
+            "$ref": "./examples/SparkConfigurations_Get.json"
+          }
+        },
+        "description": "Gets a sparkConfiguration.",
+        "parameters": [
+          {
+            "$ref": "#/parameters/sparkConfigurationName"
+          },
+          {
+            "$ref": "#/parameters/ApiVersionParameter"
+          },
+          {
+            "name": "If-None-Match",
+            "in": "header",
+            "required": false,
+            "type": "string",
+            "x-ms-client-name": "IfNoneMatch",
+            "description": "ETag of the sparkConfiguration entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned."
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK.",
+            "schema": {
+              "$ref": "#/definitions/SparkConfigurationResource"
+            }
+          },
+          "304": {
+            "description": "Not modified."
+          },
+          "default": {
+            "description": "An error response received from the Azure Synapse service.",
+            "schema": {
+              "$ref": "#/definitions/CloudError"
+            }
+          }
+        }
+      },
+      "delete": {
+        "tags": [
+          "sparkconfigurations"
+        ],
+        "operationId": "SparkConfiguration_DeleteSparkConfiguration",
+        "x-ms-examples": {
+          "SparkConfigurations_Delete": {
+            "$ref": "./examples/SparkConfigurations_Delete.json"
+          }
+        },
+        "description": "Deletes a sparkConfiguration.",
+        "x-ms-long-running-operation": true,
+        "parameters": [
+          {
+            "$ref": "#/parameters/sparkConfigurationName"
+          },
+          {
+            "$ref": "#/parameters/ApiVersionParameter"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK."
+          },
+          "202": {
+            "description": "Accepted."
+          },
+          "204": {
+            "description": "No Content."
+          },
+          "default": {
+            "description": "An error response received from the Azure Synapse service.",
+            "schema": {
+              "$ref": "#/definitions/CloudError"
+            }
+          }
+        }
+      }
+    },
+    "/sparkconfigurations/{sparkConfigurationName}/rename": {
+      "post": {
+        "tags": [
+          "sparkconfigurations"
+        ],
+        "operationId": "SparkConfiguration_RenameSparkConfiguration",
+        "x-ms-examples": {
+          "SparkConfigurations_Rename": {
+            "$ref": "./examples/SparkConfigurations_Rename.json"
+          }
+        },
+        "description": "Renames a sparkConfiguration.",
+        "x-ms-long-running-operation": true,
+        "parameters": [
+          {
+            "$ref": "#/parameters/sparkConfigurationName"
+          },
+          {
+            "$ref": "#/parameters/ApiVersionParameter"
+          },
+          {
+            "name": "request",
+            "description": "proposed new name.",
+            "in": "body",
+            "required": true,
+            "schema": {
+              "$ref": "#/definitions/ArtifactRenameRequest"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK."
+          },
+          "202": {
+            "description": "Accepted."
+          },
+          "default": {
+            "description": "An error response received from the Azure Synapse service.",
+            "schema": {
+              "$ref": "#/definitions/CloudError"
+            }
+          }
+        }
+      }
     }
   },
   "definitions": {
@@ -3133,6 +3358,44 @@
         }
       }
     },
+    "SparkConfigurationListResponse": {
+      "description": "A list of sparkconfiguration resources.",
+      "type": "object",
+      "required": [
+        "value"
+      ],
+      "properties": {
+        "value": {
+          "type": "array",
+          "description": "List of sparkconfigurations.",
+          "items": {
+            "$ref": "#/definitions/SparkConfigurationResource"
+          }
+        },
+        "nextLink": {
+          "description": "The link to the next page of results, if any remaining results exist.",
+          "type": "string"
+        }
+      }
+    },
+    "SparkConfigurationResource": {
+      "description": "Spark Configuration resource type.",
+      "type": "object",
+      "allOf": [
+        {
+          "$ref": "#/definitions/SubResource"
+        }
+      ],
+      "properties": {
+        "properties": {
+          "$ref": "./entityTypes/SparkConfiguration.json#/definitions/SparkConfiguration",
+          "description": "Properties of Spark Configuration."
+        }
+      },
+      "required": [
+        "properties"
+      ]
+    },
     "CreateDataFlowDebugSessionRequest": {
       "description": "Request body structure for creating data flow debug session.",
       "type": "object",
@@ -4919,6 +5182,14 @@
       "type": "string",
       "x-ms-parameter-location": "method"
     },
+    "sparkConfigurationName": {
+      "name": "sparkConfigurationName",
+      "description": "The spark Configuration name.",
+      "in": "path",
+      "required": true,
+      "type": "string",
+      "x-ms-parameter-location": "method"
+    },
     "NotebookName": {
       "name": "notebookName",
       "description": "The notebook name.",

diff --git a/...ta-plane/Microsoft.Synapse/preview/2021-06-01-preview/entityTypes/SparkConfiguration.json b/...ta-plane/Microsoft.Synapse/preview/2021-06-01-preview/entityTypes/SparkConfiguration.json
@@ -0,0 +1,51 @@
+{
+  "swagger": "2.0",
+  "info": {
+    "title": "ArtifactsClient",
+    "version": "2021-06-01-preview"
+  },
+  "paths": {},
+  "definitions": {
+    "SparkConfiguration": {
+      "type": "object",
+      "description": "SparkConfiguration Artifact information",
+      "title": "Information about a SparkConfiguration created at the workspace level.",
+      "properties": {
+        "description": {
+          "type": "string",
+          "description": "Description about the SparkConfiguration."
+        },
+        "configs": {
+          "type": "object",
+          "description": "SparkConfiguration configs.",
+          "additionalProperties": {
+            "type": "string"
+          }
+        },
+        "annotations": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Annotations for SparkConfiguration."
+        },
+        "notes": {
+          "type": "string",
+          "description": "additional Notes."
+        },
+        "createdBy": {
+          "type": "string",
+          "description": "The identity that created the resource."
+        },
+        "created": {
+          "type": "string",
+          "format": "date-time",
+          "description": "The timestamp of resource creation."
+        }
+      },
+      "required": [
+        "configs"
+      ]
+    }
+  }
+}