Spark Job Definition - Rename Spark Job Definition

Service:

Synapse

API Version:

2020-12-01

Renames a sparkJobDefinition.

POST {endpoint}/sparkJobDefinitions/{sparkJobDefinitionName}/rename?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.
sparkJobDefinitionName	path	True	string	The spark job definition name.
api-version	query	True	string	The Synapse client API Version.

Request Body

Name	Type	Description
newName	string minLength: 1 maxLength: 260 pattern: ^[A-Za-z0-9_][^<>*#.%&:\\+?/]*$	New name of the artifact.

Responses

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

Examples

SparkJobDefinitions_Rename

Sample request

HTTP

POST exampleWorkspace.dev.azuresynapse.net/sparkJobDefinitions/examplesparkJobDefinition/rename?api-version=2020-12-01

{
  "newName": "newSparkJobDefinition"
}

Sample response

Status code:

200

Status code:

202

Definitions

Name	Description
ArtifactRenameRequest	Request body structure for rename artifact.
CloudError	The object that defines the structure of an Azure Synapse error response.

ArtifactRenameRequest

Object

Request body structure for rename artifact.

Name	Type	Description
newName	string minLength: 1 maxLength: 260 pattern: ^[A-Za-z0-9_][^<>*#.%&:\\+?/]*$	New name of the artifact.

CloudError

Object

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.