Rest API to synapse from purview

Jose Antony 1 Reputation point
2022-10-29T06:18:52.573+00:00

Hi,
Iam using rest api to register different datasources to Purview inorder do scan,while going through Microsoft Learn for each sources (azure storege,synapse,powerbi )we need to pass different parameters in request body.

Below is the url which I used to find request url,supported datasources,params all
https://learn.microsoft.com/en-us/rest/api/purview/scanningdataplane/data-sources

But I could only see an example for registering Azure storage in example section(screen shot attached).Similarly I need to know the what will be the request body for registering synapse.

255326-image.png

thanks

Microsoft Purview
Microsoft Purview
A Microsoft data governance service that helps manage and govern on-premises, multicloud, and software-as-a-service data. Previously known as Azure Purview.
1,065 questions
{count} votes

1 answer

Sort by: Most helpful
  1. KranthiPakala-MSFT 46,442 Reputation points Microsoft Employee
    2022-11-03T19:42:53.35+00:00

    Hello @Jose Antony ,

    Thanks for the question and using MS Q&A platform.

    For Synapse the kind field in Request body should be one of the following depends on what you are trying to create.

    256961-image.png

    Sample Request body for creating SynapseWorkspaceDataSource:

    {  
      "kind": "AzureSynapseWorkspace",  
      "properties": {  
        "endpoint": "https://SynapseWorkspaceName.dev.azuresynapse.net",  
        "collection": {  
          "referenceName": "CollectionName",  
          "type": "CollectionReference"  
        }  
      }  
    }  
    

    Hope this will help. Please let us know if any further queries.

    ------------------------------

    • Please don't forget to click on 130616-image.png or upvote 130671-image.png button whenever the information provided helps you. Original posters help the community find answers faster by identifying the correct answer. Here is how