Please provide a Microsoft API that will return all Azure App Services names as shown in the image below. Assuming there is an API, what authorize API permissions are required?

Hi Michael, You may use below REST API to retrieve list as shown in your screenshot: Web Apps - List https://learn.microsoft.com/en-us/rest/api/appservice/web-apps/list The user calling the api will need Microsoft.Web/sites/Read permission at subscription scope. In the Azure portal, if you navigate to your subscription, Access control (IAM) blade, click Add -- Add Custom role, you may create a custom role that only has the above permission. Once the custom role has been created, use the same Access control (IAM) blade to assign the custom role to the user that will be calling the API. Please click Accept Answer if the above was useful. Thanks. -TP

Azure App Services - need API to return all names

Accepted answer

TP 95,221 Reputation points

2023-10-01T08:25:59.59+00:00

Hi Michael,

You may use below REST API to retrieve list as shown in your screenshot:

Web Apps - List

https://learn.microsoft.com/en-us/rest/api/appservice/web-apps/list

The user calling the api will need Microsoft.Web/sites/Read permission at subscription scope. In the Azure portal, if you navigate to your subscription, Access control (IAM) blade, click Add -- Add Custom role, you may create a custom role that only has the above permission.

Once the custom role has been created, use the same Access control (IAM) blade to assign the custom role to the user that will be calling the API.

Please click Accept Answer if the above was useful.

Thanks.

-TP
Please sign in to rate this answer.
TP 95,221 Reputation points

2023-10-04T15:41:20.4133333+00:00

@Tarkowski, Michael (M.) Any update?

Tarkowski, Michael (M.) 156 Reputation points

2023-10-04T15:55:10.45+00:00

The provided URL only returns the Function apps and NOT the Web apps for the given subscription number.

TP 95,221 Reputation points

2023-10-04T16:04:40.59+00:00

@Tarkowski, Michael (M.) I just re-tested and it returned a mix of function apps and web apps in the subscription (7 total).

In the subscription I tested with the function apps were all consumption, web apps were free and premium tiers.

Tarkowski, Michael (M.) 156 Reputation points

2023-10-04T16:16:43.8766667+00:00

Here is what I see in the portal. Only the last app is returned in the API request.

TP 95,221 Reputation points

2023-10-04T16:52:54.5+00:00

Did you make the API call using same account that was used for portal? You only have total of 6 web/function apps in this subscription? I ask because I haven't tested api with large numbers, say hundreds, although it should page.

If you run Get-AzWebApp from local PC (not in cloud shell), does it only return the function app, or all web/function apps?

Off the top of my head I was thinking the account that was used to call the API only has permission to the individual function app instead of permission at subscription level scope.

Tarkowski, Michael (M.) 156 Reputation points

2023-10-04T17:09:01.5233333+00:00

What do you mean when you say account? Are you referring to the access token clientId? Subscription id used in the above request?

TP 95,221 Reputation points

2023-10-04T17:21:18.6633333+00:00

Azure AD account (aka Entra ID account)

Tarkowski, Michael (M.) 156 Reputation points

2023-10-07T12:03:35.2833333+00:00

Thank you for your help on this.
Sign in to comment

Use comments to ask for clarification, additional information, or improvements to the question.

Share via

Azure App Services - need API to return all names

0 additional answers

Your answer