{ "swagger": "2.0", "info": { "version": "2020-12-01", "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": { "/notebooks": { "get": { "tags": [ "notebooks" ], "operationId": "Notebook_GetNotebooksByWorkspace", "x-ms-examples": { "Notebooks_ListByWorkspace": { "$ref": "./examples/Notebooks_ListByWorkspace.json" } }, "description": "Lists Notebooks.", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK.", "schema": { "$ref": "#/definitions/NotebookListResponse" } }, "default": { "description": "An error response received from the Azure Synapse service.", "schema": { "$ref": "../../../../common/v1/types.json#/definitions/CloudError" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/notebooksSummary": { "get": { "tags": [ "notebooks" ], "operationId": "Notebook_GetNotebookSummaryByWorkSpace", "x-ms-examples": { "Notebooks_ListSummaryByWorkSpace": { "$ref": "./examples/Notebooks_ListSummaryByWorkSpace.json" } }, "description": "Lists a summary of Notebooks.", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK.", "schema": { "$ref": "#/definitions/NotebookListResponse" } }, "default": { "description": "An error response received from the Azure Synapse service.", "schema": { "$ref": "../../../../common/v1/types.json#/definitions/CloudError" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/notebooks/{notebookName}": { "put": { "tags": [ "notebooks" ], "operationId": "Notebook_CreateOrUpdateNotebook", "x-ms-examples": { "Notebooks_Create": { "$ref": "./examples/Notebooks_Create.json" }, "Notebooks_Update": { "$ref": "./examples/Notebooks_Update.json" } }, "description": "Creates or updates a Note Book.", "x-ms-long-running-operation": true, "parameters": [ { "$ref": "#/parameters/NotebookName" }, { "$ref": "#/parameters/ApiVersionParameter" }, { "name": "If-Match", "in": "header", "required": false, "type": "string", "description": "ETag of the Note book entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update." }, { "name": "Notebook", "description": "Note book resource definition.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/NotebookResource" } } ], "responses": { "200": { "description": "OK.", "schema": { "$ref": "#/definitions/NotebookResource" } }, "202": { "description": "Accepted." }, "default": { "description": "An error response received from the Azure Synapse service.", "schema": { "$ref": "../../../../common/v1/types.json#/definitions/CloudError" } } } }, "get": { "tags": [ "notebooks" ], "operationId": "Notebook_GetNotebook", "x-ms-examples": { "Notebooks_Get": { "$ref": "./examples/Notebooks_Get.json" } }, "description": "Gets a Note Book.", "parameters": [ { "$ref": "#/parameters/NotebookName" }, { "$ref": "#/parameters/ApiVersionParameter" }, { "name": "If-None-Match", "in": "header", "required": false, "type": "string", "description": "ETag of the Notebook 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/NotebookResource" } }, "304": { "description": "Not modified." }, "default": { "description": "An error response received from the Azure Synapse service.", "schema": { "$ref": "../../../../common/v1/types.json#/definitions/CloudError" } } } }, "delete": { "tags": [ "notebooks" ], "operationId": "Notebook_DeleteNotebook", "x-ms-examples": { "Notebooks_Delete": { "$ref": "./examples/Notebooks_Delete.json" } }, "description": "Deletes a Note book.", "x-ms-long-running-operation": true, "parameters": [ { "$ref": "#/parameters/NotebookName" }, { "$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": "../../../../common/v1/types.json#/definitions/CloudError" } } } } }, "/notebooks/{notebookName}/rename": { "post": { "tags": [ "notebooks" ], "operationId": "Notebook_RenameNotebook", "x-ms-examples": { "Notebooks_Rename": { "$ref": "./examples/Notebooks_Rename.json" } }, "description": "Renames a notebook.", "x-ms-long-running-operation": true, "parameters": [ { "$ref": "#/parameters/NotebookName" }, { "$ref": "#/parameters/ApiVersionParameter" }, { "name": "request", "description": "proposed new name.", "in": "body", "required": true, "schema": { "$ref": "artifacts.json#/definitions/ArtifactRenameRequest" } } ], "responses": { "200": { "description": "OK." }, "202": { "description": "Accepted." }, "default": { "description": "An error response received from the Azure Synapse service.", "schema": { "$ref": "../../../../common/v1/types.json#/definitions/CloudError" } } } } }, "/notebookOperationResults/{operationId}": { "get": { "tags": [ "OperationResult" ], "operationId": "NotebookOperationResult_Get", "description": "Get notebook operation result", "x-ms-examples": { "List Sql Pools": { "$ref": "./examples/NotebookOperationResult_Get.json" } }, "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" }, { "name": "operationId", "in": "path", "required": true, "type": "string", "description": "Operation ID." } ], "responses": { "200": { "description": "" }, "201": { "description": "" }, "202": { "description": "" }, "204": { "description": "" }, "default": { "schema": { "$ref": "../../../../common/v1/types.json#/definitions/ErrorContract" }, "description": "" } } } } }, "definitions": { "NotebookListResponse": { "description": "A list of Notebook resources.", "type": "object", "required": [ "value" ], "properties": { "value": { "type": "array", "description": "List of Notebooks.", "items": { "$ref": "#/definitions/NotebookResource" } }, "nextLink": { "description": "The link to the next page of results, if any remaining results exist.", "type": "string" } } }, "NotebookResource": { "description": "Notebook resource type.", "type": "object", "properties": { "id": { "readOnly": true, "type": "string", "description": "Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" }, "name": { "type": "string", "description": "The name of the resource" }, "type": { "readOnly": true, "type": "string", "description": "The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts." }, "etag": { "type": "string", "readOnly": true, "description": "Resource Etag." }, "properties": { "$ref": "./entityTypes/Notebook.json#/definitions/Notebook", "description": "Properties of Notebook." } }, "required": [ "name", "properties" ] } }, "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", "format": "uri" }, "NotebookName": { "name": "notebookName", "description": "The notebook name.", "in": "path", "required": true, "type": "string", "x-ms-parameter-location": "method" } } }