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 index ab2e1da22643..9ed4fe5f65b0 100644 --- 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 @@ -2649,209 +2649,6 @@ } } }, - "/kqlScripts": { - "get": { - "tags": [ - "kqlScripts" - ], - "operationId": "KqlScripts_GetAll", - "description": "Get all KQL scripts", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK.", - "schema": { - "$ref": "#/definitions/KqlScripts_ResourceCollectionResponse" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/workspace.json#/definitions/ErrorContract" - } - } - }, - "x-ms-examples": { - "KqlScripts_GetAll": { - "$ref": "./examples/KqlScripts_GetAll.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/kqlScripts/{kqlScriptName}": { - "put": { - "tags": [ - "kqlScripts" - ], - "operationId": "KqlScript_CreateOrUpdate", - "description": "Creates or updates a KQL Script", - "parameters": [ - { - "$ref": "#/parameters/KqlScriptName" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "name": "kqlScript", - "description": "KQL script", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/KqlScriptResource" - } - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/KqlScriptResource" - } - }, - "202": { - "description": "Accepted" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/workspace.json#/definitions/ErrorContract" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "KqlScript_CreateOrUpdate": { - "$ref": "./examples/KqlScript_CreateOrUpdate.json" - } - } - }, - "get": { - "tags": [ - "kqlScripts" - ], - "operationId": "KqlScript_GetByName", - "description": "Get KQL script by name", - "parameters": [ - { - "$ref": "#/parameters/KqlScriptName" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/KqlScriptResource" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../common/v1/types.json#/definitions/ErrorContract" - } - } - }, - "x-ms-examples": { - "KqlScript_GetByName": { - "$ref": "./examples/KqlScript_GetByName.json" - } - } - }, - "delete": { - "tags": [ - "kqlScripts" - ], - "operationId": "KqlScript_DeleteByName", - "description": "Delete KQL script by name", - "parameters": [ - { - "$ref": "#/parameters/KqlScriptName" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK" - }, - "202": { - "description": "Accepted" - }, - "204": { - "description": "No Content" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../common/v1/types.json#/definitions/ErrorContract" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "KqlScript_DeleteByName": { - "$ref": "./examples/KqlScript_DeleteByName.json" - } - } - } - }, - "/kqlScripts/{kqlScriptName}/rename": { - "post": { - "tags": [ - "kqlScripts" - ], - "operationId": "KqlScript_Rename", - "description": "Rename KQL script", - "parameters": [ - { - "$ref": "#/parameters/KqlScriptName" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "renameRequest", - "description": "Rename request", - "required": true, - "schema": { - "$ref": "#/definitions/ArtifactRenameRequest" - } - } - ], - "responses": { - "200": { - "description": "OK" - }, - "202": { - "description": "Accepted" - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "../../../../common/v1/types.json#/definitions/ErrorContract" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "KqlScript_Rename": { - "$ref": "./examples/KqlScript_Rename.json" - } - } - } - }, "/notebookOperationResults/{operationId}": { "get": { "tags": [ @@ -5095,66 +4892,6 @@ "maxLength": 260 } } - }, - "KqlScripts_ResourceCollectionResponse": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/KqlScriptResource" - } - }, - "nextLink": { - "type": "string" - } - } - }, - "KqlScriptResource": { - "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "type": { - "type": "string" - }, - "properties": { - "$ref": "#/definitions/KqlScript", - "description": "Properties of sql script." - } - } - }, - "KqlScript": { - "properties": { - "content": { - "properties": { - "query": { - "type": "string" - }, - "metadata": { - "type": "object", - "properties": { - "language": { - "type": "string" - } - } - }, - "currentConnection": { - "properties": { - "name": { - "type": "string" - }, - "type": { - "type": "string" - } - } - } - } - } - } } }, "parameters": { @@ -5322,14 +5059,6 @@ "in": "path", "x-ms-skip-url-encoding": true, "x-ms-parameter-location": "client" - }, - "KqlScriptName": { - "name": "kqlScriptName", - "in": "path", - "required": true, - "type": "string", - "description": "KQL script name", - "x-ms-parameter-location": "method" } } } diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/kqlScripts.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/kqlScripts.json new file mode 100644 index 000000000000..51e3fb510f19 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/kqlScripts.json @@ -0,0 +1,329 @@ +{ + "swagger": "2.0", + "info": { + "version": "2021-06-01-preview", + "title": "ArtifactsClient", + "x-ms-code-generation-settings": { + "useDateTimeOffset": true + } + }, + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + } + ] + }, + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/kqlScripts": { + "get": { + "tags": [ + "kqlScripts" + ], + "operationId": "KqlScripts_GetAll", + "description": "Get all KQL scripts", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/KqlScripts_ResourceCollectionResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/workspace.json#/definitions/ErrorContract" + } + } + }, + "x-ms-examples": { + "KqlScripts_GetAll": { + "$ref": "./examples/KqlScripts_GetAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/kqlScripts/{kqlScriptName}": { + "put": { + "tags": [ + "kqlScripts" + ], + "operationId": "KqlScript_CreateOrUpdate", + "description": "Creates or updates a KQL Script", + "parameters": [ + { + "$ref": "#/parameters/KqlScriptName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "kqlScript", + "description": "KQL script", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/KqlScriptResource" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/KqlScriptResource" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/workspace.json#/definitions/ErrorContract" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "KqlScript_CreateOrUpdate": { + "$ref": "./examples/KqlScript_CreateOrUpdate.json" + } + } + }, + "get": { + "tags": [ + "kqlScripts" + ], + "operationId": "KqlScript_GetByName", + "description": "Get KQL script by name", + "parameters": [ + { + "$ref": "#/parameters/KqlScriptName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/KqlScriptResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../common/v1/types.json#/definitions/ErrorContract" + } + } + }, + "x-ms-examples": { + "KqlScript_GetByName": { + "$ref": "./examples/KqlScript_GetByName.json" + } + } + }, + "delete": { + "tags": [ + "kqlScripts" + ], + "operationId": "KqlScript_DeleteByName", + "description": "Delete KQL script by name", + "parameters": [ + { + "$ref": "#/parameters/KqlScriptName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../common/v1/types.json#/definitions/ErrorContract" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "KqlScript_DeleteByName": { + "$ref": "./examples/KqlScript_DeleteByName.json" + } + } + } + }, + "/kqlScripts/{kqlScriptName}/rename": { + "post": { + "tags": [ + "kqlScripts" + ], + "operationId": "KqlScript_Rename", + "description": "Rename KQL script", + "parameters": [ + { + "$ref": "#/parameters/KqlScriptName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "renameRequest", + "description": "Rename request", + "required": true, + "schema": { + "$ref": "./artifacts.json#/definitions/ArtifactRenameRequest" + } + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../common/v1/types.json#/definitions/ErrorContract" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "KqlScript_Rename": { + "$ref": "./examples/KqlScript_Rename.json" + } + } + } + } + }, + "definitions": { + "KqlScripts_ResourceCollectionResponse": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/KqlScriptResource" + } + }, + "nextLink": { + "type": "string" + } + } + }, + "KqlScriptResource": { + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "type": { + "type": "string" + }, + "properties": { + "$ref": "#/definitions/KqlScript", + "description": "Properties of sql script." + } + } + }, + "KqlScript": { + "properties": { + "content": { + "properties": { + "query": { + "type": "string" + }, + "metadata": { + "type": "object", + "properties": { + "language": { + "type": "string" + } + } + }, + "currentConnection": { + "properties": { + "name": { + "type": "string" + }, + "type": { + "type": "string" + } + } + } + } + } + } + } + }, + "parameters": { + "workspaceName": { + "name": "workspaceName", + "description": "The workspace name.", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The Synapse client API Version." + }, + "Endpoint": { + "name": "endpoint", + "description": "The workspace development endpoint, for example https://myworkspace.dev.azuresynapse.net.", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "client" + }, + "KqlScriptName": { + "name": "kqlScriptName", + "in": "path", + "required": true, + "type": "string", + "description": "KQL script name", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/synapse/data-plane/readme.md b/specification/synapse/data-plane/readme.md index 6c28199da6e9..433e21066871 100644 --- a/specification/synapse/data-plane/readme.md +++ b/specification/synapse/data-plane/readme.md @@ -47,6 +47,17 @@ tag: package-vnet-2020-12-01 tag: package-monitoring-2020-12-01 ``` +### Tag: package-kql-script-2021-06-preview + +These settings apply only when `--tag=package-kql-script-2021-06-preview` is specified on the command line. + +**ATTENTION**: Please DO NOT generate SDK based on this tag. KQL script API set is not ready to be widely used. + +``` yaml $(tag) == 'package-kql-script-2021-06-preview' +input-file: + - Microsoft.Synapse/preview/2021-06-01-preview/kqlScripts.json +``` + ### Tag: package-spark-2019-11-01-preview These settings apply only when `--tag=package-spark-2019-11-01-preview` is specified on the command line.