Service Principal grant permission to access Purview data assets(Entity)

Question

Service Principal grant permission to access Purview data assets(Entity)

宇翔刘 21

I have a service principal that want to access data assets in Microsoft Purview.

The service principal is used in a python program, thus I use python sdk to access the purview instance.

Strangely, it can only return an empty list of data assets. But the assets actually exist and can be found in Purview portal.

The api I use is shown below.

client.discovery.query({"keywords": "*"})

Chandra Boorla 14,685 Reputation points Microsoft External Staff Moderator

2025-02-20T07:06:57.8966667+00:00

Hi @宇翔刘

Thank you for posting you query!

It looks like your Python SDK call client.discovery.query({"keywords": "*"}) is intended to retrieve all data assets from Microsoft Purview, but it's returning an empty list despite assets being visible in the Purview portal.

Here are some possible causes and solutions:

Permissions - Ensure the service principal has been assigned the correct role-based access control (RBAC) permissions in Purview, such as Data Reader or Data Curator. The service principal must be explicitly granted access at the correct Purview collection level where the assets reside.

Query Scope - Try running a more specific query, e.g., {"keywords": "specific-asset-name"} to verify if it's a search issue. Use {"keywords": "", "limit": 10} to check if pagination is preventing full results from loading.

Authentication & Connection - Confirm that your service principal is properly authenticated and connected to the correct Purview instance. Ensure the API is using the correct authentication token in requests.

Check Collection Hierarchy - If assets are stored in nested collections, ensure the service principal has the right access permissions for those collections.

Logs & Debugging - Check API logs for any authentication or permission-related errors. If possible, try running the same query with a user account to compare results.

Purview API & SDK Compatibility - Ensure that the Microsoft Purview Python SDK version you are using is compatible with the Purview API version. By verifying these points, you should be able to identify why the query is returning an empty list.

I hope this information helps. Please do let us know if you have any further queries.

Kindly consider upvoting the comment if the information provided is helpful. This can assist other community members in resolving similar issues.

Thank you.

Accepted answer

1 additional answer

Your answer

Chandra Boorla 14,685 Reputation points Microsoft External Staff Moderator

2025-02-20T07:06:57.8966667+00:00

Hi @宇翔刘

Thank you for posting you query!

It looks like your Python SDK call client.discovery.query({"keywords": "*"}) is intended to retrieve all data assets from Microsoft Purview, but it's returning an empty list despite assets being visible in the Purview portal.

Here are some possible causes and solutions:

Permissions - Ensure the service principal has been assigned the correct role-based access control (RBAC) permissions in Purview, such as Data Reader or Data Curator. The service principal must be explicitly granted access at the correct Purview collection level where the assets reside.

Query Scope - Try running a more specific query, e.g., {"keywords": "specific-asset-name"} to verify if it's a search issue. Use {"keywords": "", "limit": 10} to check if pagination is preventing full results from loading.

Authentication & Connection - Confirm that your service principal is properly authenticated and connected to the correct Purview instance. Ensure the API is using the correct authentication token in requests.

Check Collection Hierarchy - If assets are stored in nested collections, ensure the service principal has the right access permissions for those collections.

Logs & Debugging - Check API logs for any authentication or permission-related errors. If possible, try running the same query with a user account to compare results.

Purview API & SDK Compatibility - Ensure that the Microsoft Purview Python SDK version you are using is compatible with the Purview API version. By verifying these points, you should be able to identify why the query is returning an empty list.

I hope this information helps. Please do let us know if you have any further queries.

Kindly consider upvoting the comment if the information provided is helpful. This can assist other community members in resolving similar issues.

Thank you.

Answer 1

@宇翔刘

I'm glad that you were able to resolve your issue and thank you for posting your solution so that others experiencing the same thing can easily reference this! Since the Microsoft Q&A community has a policy that "The question author cannot accept their own answer. They can only accept answers by others ", I'll repost your solution in case you'd like to accept the answer.

Issue:

Service Principal grant permission to access Purview data assets(Entity)

Solution:

"I have resolved the issue. The problem was due to selecting an incorrect targeted deployment."

If I missed anything please let me know and I'd be happy to add it to my answer, or feel free to comment below with any additional information.

Hope this helps. Do let us know if you have any further queries.

If this answers your query, do click Accept Answer and Yes for was this answer helpful. And, if you have any further query do let us know.

Chandra Boorla 14,685 Reputation points Microsoft External Staff Moderator

2025-02-21T06:32:39.72+00:00

@宇翔刘

Following up to see if the above suggestion was helpful. If this answers your query, do click Accept Answer and Yes for was this answer helpful. This will assist other community members facing similar problems. If you have any further questions, please let us know. And, if you have any further query do let us know.

Answer 2

宇翔刘 21

The issue is resolved by myself. I chose a wrong targeted deployment that containing another set of client_id, client_secret and tenant

Chandra Boorla 14,685 Reputation points Microsoft External Staff Moderator

2025-02-20T10:47:02.79+00:00

@宇翔刘

I'm glad that you were able to resolve your issue and thank you for posting your solution so that others experiencing the same thing can easily reference this! Since the Microsoft Q&A community has a policy that "The question author cannot accept their own answer. They can only accept answers by others ", I'll repost your solution in case you'd like to accept the answer.

Share via

Service Principal grant permission to access Purview data assets(Entity)

1 additional answer

Your answer