To connect Azure Purview (now called Microsoft Purview) with another tool using its API, you'll need the following information:
- Base URL for Purview API
- What it is: The endpoint URL for your Microsoft Purview account, used to make HTTP API calls.
- How to Find It:
- Go to the Azure portal.
- Navigate to your Purview account.
- The Base URL is in the "Overview" tab and typically follows this pattern:
https://<your-purview-account-name>.purview.azure.com
- Client ID
- What it is: The application ID of the Azure AD application registered for authentication.
- How to Get It:
- Go to the Azure Active Directory section in the Azure portal.
- Navigate to App registrations > New registration to create an app for your integration.
- After registration, the Application (client) ID is displayed. Use this as the Client ID.
- Client Secret
- What it is: A key used for authenticating your application to access the Purview API.
- How to Create It:
- In the registered app (from the previous step), go to Certificates & secrets.
- Under Client secrets, click New client secret.
- Provide a description and expiration date, then create it.
- Copy the value of the secret (you won't be able to view it again later).
Additional Steps to Set Up API Access
- Grant API Permissions:
- In your registered app, go to API permissions.
- Add the Microsoft Purview Resource Provider permissions (usually
Azure Purview Data Plane
andAzure Purview Resource
). - Ensure admin consent is provided.
- Assign Roles in Purview:
- Go to your Purview account in the Azure portal.
- Under Access control (IAM), assign the necessary role (e.g.,
Data Reader
,Data Curator
, orData Source Administrator
) to the app.
To summarize:
- Base URL:
https://your-purview-account.purview.azure.com
- Client ID: Found in App registrations > Application (client) ID.
- Client Secret: Created under Certificates & secrets in the registered app.
If the above response helps answer your question, remember to "Accept Answer" so that others in the community facing similar issues can easily find the solution. Your contribution is highly appreciated.
hth
Marcin