Does management group descendants API return only the active entities?

Question

Does management group descendants API return only the active entities?

Rachana Pole 10

Hi team,

We have a query if the below query list only for ACTIVE ENTITIES? If not, is there an API to list only ACTIVE entities under management groups ?

GET https://management.azure.com/providers/Microsoft.Management/managementGroups/{groupId}/descendants?api-version=2020-05-01

https://learn.microsoft.com/en-us/rest/api/managementgroups/management-groups/get-descendants?view=rest-managementgroups-2020-05-01&tabs=HTTP

Vinod Pittala 735 Reputation points Microsoft External Staff

2025-03-07T07:32:33.01+00:00
Hello Rachana Pole,

Apologies for the delay in response.

We could not see any query to list only for ACTIVE ENTITIES in your question. However, As there is no direct API to list only Active entities under management groups, all we have to do is use optional parameters to filter the results, including filtering by the status of the entities to list only active ones.

here is the request preview of the API that will give you the list of only active entities. Please try out and let us know the results.

POST https://management.azure.com/providers/Microsoft.Management/getEntities?api-version=2020-05-01 Content-Type: application/json Authorization: Bearer <your-access-token> { "$filter": "status eq 'Active'" }

FYR: sample request preview

If the comment helpful, please click Upvote it.

Thanks
Vinod Pittala 735 Reputation points Microsoft External Staff

2025-03-10T05:15:30.8033333+00:00

Hello Rachana Pole,

Just want to check if the above answer worked for you or else please let us know if any help needed, we are always here to help whenever you need us.

Please do not forget to “upvote it” wherever the information provided helps you, this can be beneficial to other community members.it would be greatly appreciated and helpful to others. Thanks

1 answer

Your answer

Vinod Pittala 735 Reputation points Microsoft External Staff

2025-03-07T07:32:33.01+00:00

Hello Rachana Pole,

Apologies for the delay in response.

We could not see any query to list only for ACTIVE ENTITIES in your question. However, As there is no direct API to list only Active entities under management groups, all we have to do is use optional parameters to filter the results, including filtering by the status of the entities to list only active ones.

here is the request preview of the API that will give you the list of only active entities. Please try out and let us know the results.

POST https://management.azure.com/providers/Microsoft.Management/getEntities?api-version=2020-05-01 Content-Type: application/json Authorization: Bearer <your-access-token> { "$filter": "status eq 'Active'" }

FYR: sample request preview

If the comment helpful, please click Upvote it.

Thanks
Vinod Pittala 735 Reputation points Microsoft External Staff

2025-03-10T05:15:30.8033333+00:00

Hello Rachana Pole,

Just want to check if the above answer worked for you or else please let us know if any help needed, we are always here to help whenever you need us.

Please do not forget to “upvote it” wherever the information provided helps you, this can be beneficial to other community members.it would be greatly appreciated and helpful to others. Thanks

Answer 1

Hi @Anonymous

There isn't a direct API to list all active entities from the Management Group. However, by utilizing optional parameters, we can achieve the desired outcome. To list the active entities that descend from a Management Group, you can use the following alternative custom API:

To view entities based on specific permissions they possess:

POST 
https://management.azure.com/providers/Microsoft.Management/getEntities?api-version=2020-05-01&$skiptoken={$skiptoken}&$skip={$skip}&$top={$top}&$view={$view}&groupName={groupName}

Using the filter parameter to view active entities:

POST
 https://management.azure.com/providers/Microsoft.Management/getEntities?api-version=2020-05-01&$skiptoken={$skiptoken}&$skip={$skip}&$top={$top}&$filter={statuseq'Active'}&groupName={groupName}

Reference :

Entities - List - REST API (Azure Management Groups) | Microsoft Learn
Management Groups - Get Descendants - REST API (Azure Management Groups) | Microsoft Learn

If you are looking for the Management Group Descendants, you can use the following API:

 GET https://management.azure.com/providers/Microsoft.Management/managementGroups/{groupId}/descendants?api-version=2020-05-01&$skiptoken={$skiptoken}&$top={$top}

If you have any further queries, do let us know.

Please do not forget to "Accept the answer” and upvote it wherever the information provided helps you, this can be beneficial to other community members.it would be greatly appreciated and helpful to others.

Vinod Pittala 735 Reputation points Microsoft External Staff

2025-03-12T01:50:47.88+00:00

Hello Rachana Pole,

I would like to check if the issue has been resolved or if you need any assistance. Please feel free to let us know, as we are always here to help.

Please do not forget to "Accept the answer” and “upvote it” wherever the information provided helps you, this can be beneficial to other community members.it would be greatly appreciated and helpful to others.

Thanks

Share via

Does management group descendants API return only the active entities?

1 answer

Your answer