Library - Flush

Service:

Synapse

API Version:

2020-12-01

Flush Library

POST {endpoint}/libraries/{libraryName}/flush?api-version=2020-12-01

URI Parameters

Name	In	Required	Type	Description
endpoint	path	True	string uri	The workspace development endpoint, for example https://myworkspace.dev.azuresynapse.net.
libraryName	path	True	string	file name to upload. Minimum length of the filename should be 1 excluding the extension length.
api-version	query	True	string	The Synapse client API Version.

Responses

Name	Type	Description
200 OK		Ok.
202 Accepted	LibraryResourceInfo	Accepted.
Other Status Codes	CloudError	An error response received from the Azure Synapse service.

Examples

Flush Library

Sample request

HTTP

POST exampleWorkspace.dev.azuresynapse.net/libraries/exampleLibraryName.jar/flush?api-version=2020-12-01

Sample response

Status code:

200

Status code:

202

Date: Fri, 23 Oct 2020 08:28:16 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-writes: 1192
x-ms-request-id: e4c589b7-a9fe-4c28-981c-3855ec27d264
x-ms-correlation-request-id: e4c589b7-a9fe-4c28-981c-3855ec27d264

{
  "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/libraries/exampleLibraryName.jar",
  "recordId": 1234,
  "state": "Creating",
  "created": "2020-10-23T07:59:29.1573546+00:00",
  "changed": "2020-10-23T07:59:29.1573546+00:00",
  "type": "LibraryArtifact",
  "name": "exampleLibraryName.jar",
  "operationId": "1500474f-0000-0200-0000-5cbe090d0000",
  "artifactId": "2222222e-222d-222f-2222-22a2f222d2f2"
}

Definitions

Name	Description
CloudError	The object that defines the structure of an Azure Synapse error response.
LibraryResourceInfo	Library resource info

CloudError

The object that defines the structure of an Azure Synapse error response.

Name	Type	Description
error.code	string	Error code.
error.details	CloudError[]	Array with additional error details.
error.message	string	Error message.
error.target	string	Property name/path in request associated with error.

LibraryResourceInfo

Library resource info

Name	Type	Description
artifactId	string	artifact Id of the library/package.
changed	string	The last updated time of the library/package.
created	string	The creation time of the library/package.
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Name of the library/package.
operationId	string	Operation Id of the operation performed on library/package.
recordId	integer	record Id of the library/package.
state	string	Provisioning status of the library/package.
type	string	The type of the resource. E.g. LibraryArtifact