Azure REST API to List vaults in the specified resource group ignores $top parameter and always returns 4

Question

Azure REST API to List vaults in the specified resource group ignores $top parameter and always returns 4

Anita Govindarajan 6

https://learn.microsoft.com/en-us/rest/api/keyvault/vaults/list-by-resource-group

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults?$top={$top}&api-version=2019-09-01

The URI optional parameter $top should set the maximum number of results to return but does not work. It always returns 4 and ignores any value used with $top.
The nextLink parameter appears and recursive queries need to be used to display any list greater than 4.

This does not work with Postman or with C# code and appears to be a bug. Thanks for any help with resolving this issue.

Dondee Tan 1 Reputation point

2021-11-05T22:21:39.553+00:00

Confirmed. I too get the same problem

1 answer

Your answer

Dondee Tan 1 Reputation point

2021-11-05T22:21:39.553+00:00

Confirmed. I too get the same problem

Answer 1

JamesTran-MSFT 37,231 Microsoft Employee Moderator

@Anita Govindarajan
Thank you for your time and patience throughout this issue!

I was able to confirm that the $top parameter isn't working within the Vaults - List By Resource Group REST API. When running the API for myself, it was returning all 3 Key Vaults that I had within my resource group even with the top parameter.

Note: The output was too large to capture my 3rd vault within this screenshot.

I've reached out to our Key Vault engineering team and will update as soon as possible.

If you have any other questions, please let me know.
Thank you for your time and patience throughout this issue.

----------

Please remember to "Accept Answer" if any answer/reply helped, so that others in the community facing similar issues can easily find the solution.

JamesTran-MSFT 37,231 Reputation points Microsoft Employee Moderator

2021-11-09T22:54:45.09+00:00

@Anita Govindarajan
Thank you for your time and patience throughout this issue!

I received a response from our engineering team and it's suggested to use the /resources API and not the "List By Resource Group" or "List By Subscription" API since they'll ignore the $top OData filter.

Vaults - List REST API:
GET https://management.azure.com/subscriptions/{subscriptionId}/resources?$filter=resourceType eq 'Microsoft.KeyVault/vaults'&$top={$top}&api-version=2019-09-01

If you have any other questions, please let me know.
Thank you for your time and patience throughout this issue.

----------

Please remember to "Accept Answer" if any answer/reply helped, so that others in the community facing similar issues can easily find the solution.
JamesTran-MSFT 37,231 Reputation points Microsoft Employee Moderator

2021-11-10T17:36:14.157+00:00

@Anita Govindarajan
I just wanted to check in and see if you had any other questions or if you were able to resolve this issue?
Anita Govindarajan 6 Reputation points

2021-11-11T00:46:25.36+00:00

Thanks for your kind response. However, this solution does not work as I have several key vaults in a subscription. I would to see all the key vaults in a particular subscription and resource group with one API call.

I am using the Azure Fluent SDK https://learn.microsoft.com/en-us/dotnet/api/microsoft.azure.management.keyvault.fluent?view=azure-dotnet for this purpose and it is working well.

It will be great if the existing bug with Listing Key vaults by Resource Group is fixed.

Thanks.

Share via

Azure REST API to List vaults in the specified resource group ignores $top parameter and always returns 4

1 answer

Your answer