Share via

Azure Synapse Analytics REST API

  • Article

Use the Azure Synapse Analytics REST APIs to create and manage Azure Synapse resources through Azure Resource Manager and Azure Synapse endpoints. All task operations conform to the HTTP/1.1 protocol specification and most operations return an x-ms-request-id header that can be used to obtain information about the request. You must make sure that requests made to these resources are secure, using https. For more information on making secure requests, see Acquire an access token.

Common parameters and headers

The following information is common to all tasks that you might do related to Azure Synapse:

  • Replace {api-version} with 2019-06-01-preview for management operations, or 2019-11-01-preview for data plane operations.
  • Replace {subscription-id} in the URI with your Azure subscription identifier.
  • Replace {resource-group-name} with the resource group. For more information, see Using Resource groups to manage your Azure resources. Replace {account-name} in the URI with your Data Lake Analytics account name.
  • Set the Content-Type header to application/json.
  • Set the Authorization header to a JSON Web Token that you obtain from Azure Active Directory. For data plane operations, be sure to obtain a token for the resource URI / audience claim "https://dev.azuresynapse.net/", NOT "https://management.core.windows.net/" nor "https://management.azure.com/". For more information, see Acquire an access token.

See also