Create API service using powershell

Question

Create API service using powershell

WinTechie 286

Hi

I am looking for powershell command to provision API service (one of the app service kind)

I can't find relevant knowledge base on this azure offering, although I can create it from azure marketplace using portal.

When I look for the powershell commands most of them are either related to APIM service OR azure webapp service (New-AzWebApp)

Any suggestions or inputs would be highly appreciated

Konstantinos Passadis 19,586 Reputation points MVP

2023-09-03T16:46:11.3533333+00:00

Hello @WinTechie !

I suppose you are referring to Azure APP Service

Here is my suggestion :

Install AZ Module and Connect :

Install-Module -Name Az -AllowClobber -Scope CurrentUser -Force

Import-Module Az

Connect-AzAccount

Select your Subscription

Select-AzSubscription -SubscriptionId "your-subscription-id"

Create a Resource Group

New-AzResourceGroup -Name 'myResourceGroup' -Location 'West Europe'

Create APP Service Plan:

New-AzAppServicePlan -ResourceGroupName 'myResourceGroup' -Name 'myAppServicePlan' -Location 'West Europe' -Tier Free

Create the APP :

New-AzWebApp -ResourceGroupName 'myResourceGroup' -Name 'myAPIAppName' -Location 'West Europe' -AppServicePlan 'myAppServicePlan'

And you have now your APP Service

Here is a guide to host a RESTful API with CORS in Azure App Service

https://learn.microsoft.com/en-us/azure/app-service/app-service-web-tutorial-rest-api

ALSO

Powershell Samples for Azure APP Service:

https://learn.microsoft.com/en-us/azure/app-service/samples-powershell

IF you mean the API Definitions you need an APIM instance to link your APP

https://learn.microsoft.com/en-us/azure/api-management/api-management-key-concepts

https://learn.microsoft.com/en-us/azure/api-management/powershell-create-service-instance

I hope this helps!

Kindly mark the answer as Accepted and Upvote in case it helped!

Regards
WinTechie 286 Reputation points

2023-09-03T18:14:57.8866667+00:00

Hi,

Thanks for the inputs. but this is not what I was looking for.

there are multiple kinds of App services available in Azure and some of them are WebApp, API App etc.

what you have shared is the WebApp portion, I am looking for API App which you can find in the Marketplace published Microsoft itself (see screenshot below).
Konstantinos Passadis 19,586 Reputation points MVP

2023-09-04T01:11:52.4266667+00:00

Hello @WinTechie !

Thank you for the Update !

Yes i got the question !

If you deploy the Marketplace application it is an APP Service API APP

Microsoft Azure App Service API Apps offers secure and flexible development, deployment, and scaling options for any sized RESTful API application. Use frameworks and templates to create RESTful APIs in seconds. Choose from source control options like TFS, GitHub, and BitBucket. Use any tool or OS to develop your RESTful API with .NET, Java, PHP, Node.js or Python

This is done via the APP Service you can look at the links

https://azure.microsoft.com/en-us/products/app-service/api#layout-container-uidfe1a

This is what you are looking for but in Powershell :

https://learn.microsoft.com/en-us/azure/app-service/app-service-web-tutorial-rest-api

And here is the Sample for Powershell

https://learn.microsoft.com/en-us/azure/app-service/scripts/powershell-deploy-local-git?toc=%2Fpowershell%2Fmodule%2Ftoc.json

I hope this helps!

Kindly mark the answer as Accepted and Upvote in case it helped!

Regards
Konstantinos Passadis 19,586 Reputation points MVP

2023-09-04T01:39:55.9+00:00
Hello !

I would like also to point this out :

https://learn.microsoft.com/en-us/azure/app-service/deploy-configure-credentials?tabs=powershell#appscope

Configure user-scope credentials

Azure CLI Azure PowerShell Azure portal

You can't configure the user-scope credentials with Azure PowerShell. Use a different method, or consider using application-scope credentials.

So az cli seems the best way to do this !

I hope i helped !

Kindly post your feedback or set the answer that helped to Accepted !

Regards!
Konstantinos Passadis 19,586 Reputation points MVP

2023-09-05T08:52:55.17+00:00

Hello @WinTechie !

I was wondering whether my answer helped you or if there is anything else we can assist you with!

Do you have any feedback or is your issue resolved?

In case any answer helped kindly mark it as Accepted and upvote so others can benefit as well!

Otherwise post your feedback to provide additional help!

Regards

Accepted answer

1 additional answer

Your answer

Konstantinos Passadis 19,586 Reputation points MVP

2023-09-03T16:46:11.3533333+00:00

Hello @WinTechie !

I suppose you are referring to Azure APP Service

Here is my suggestion :

Install AZ Module and Connect :

Install-Module -Name Az -AllowClobber -Scope CurrentUser -Force

Import-Module Az

Connect-AzAccount

Select your Subscription

Select-AzSubscription -SubscriptionId "your-subscription-id"

Create a Resource Group

New-AzResourceGroup -Name 'myResourceGroup' -Location 'West Europe'

Create APP Service Plan:

New-AzAppServicePlan -ResourceGroupName 'myResourceGroup' -Name 'myAppServicePlan' -Location 'West Europe' -Tier Free

Create the APP :

New-AzWebApp -ResourceGroupName 'myResourceGroup' -Name 'myAPIAppName' -Location 'West Europe' -AppServicePlan 'myAppServicePlan'

And you have now your APP Service

Here is a guide to host a RESTful API with CORS in Azure App Service

https://learn.microsoft.com/en-us/azure/app-service/app-service-web-tutorial-rest-api

ALSO

Powershell Samples for Azure APP Service:

https://learn.microsoft.com/en-us/azure/app-service/samples-powershell

IF you mean the API Definitions you need an APIM instance to link your APP

https://learn.microsoft.com/en-us/azure/api-management/api-management-key-concepts

https://learn.microsoft.com/en-us/azure/api-management/powershell-create-service-instance

I hope this helps!

Kindly mark the answer as Accepted and Upvote in case it helped!

Regards
WinTechie 286 Reputation points

2023-09-03T18:14:57.8866667+00:00

Hi,

Thanks for the inputs. but this is not what I was looking for.

there are multiple kinds of App services available in Azure and some of them are WebApp, API App etc.

what you have shared is the WebApp portion, I am looking for API App which you can find in the Marketplace published Microsoft itself (see screenshot below).
Konstantinos Passadis 19,586 Reputation points MVP

2023-09-04T01:11:52.4266667+00:00

Hello @WinTechie !

Thank you for the Update !

Yes i got the question !

If you deploy the Marketplace application it is an APP Service API APP

Microsoft Azure App Service API Apps offers secure and flexible development, deployment, and scaling options for any sized RESTful API application. Use frameworks and templates to create RESTful APIs in seconds. Choose from source control options like TFS, GitHub, and BitBucket. Use any tool or OS to develop your RESTful API with .NET, Java, PHP, Node.js or Python

This is done via the APP Service you can look at the links

https://azure.microsoft.com/en-us/products/app-service/api#layout-container-uidfe1a

This is what you are looking for but in Powershell :

https://learn.microsoft.com/en-us/azure/app-service/app-service-web-tutorial-rest-api

And here is the Sample for Powershell

https://learn.microsoft.com/en-us/azure/app-service/scripts/powershell-deploy-local-git?toc=%2Fpowershell%2Fmodule%2Ftoc.json

I hope this helps!

Kindly mark the answer as Accepted and Upvote in case it helped!

Regards
Konstantinos Passadis 19,586 Reputation points MVP

2023-09-04T01:39:55.9+00:00

Hello !

I would like also to point this out :

https://learn.microsoft.com/en-us/azure/app-service/deploy-configure-credentials?tabs=powershell#appscope

Configure user-scope credentials

Azure CLI Azure PowerShell Azure portal

You can't configure the user-scope credentials with Azure PowerShell. Use a different method, or consider using application-scope credentials.

So az cli seems the best way to do this !

I hope i helped !

Kindly post your feedback or set the answer that helped to Accepted !

Regards!
Konstantinos Passadis 19,586 Reputation points MVP

2023-09-05T08:52:55.17+00:00

Hello @WinTechie !

I was wondering whether my answer helped you or if there is anything else we can assist you with!

Do you have any feedback or is your issue resolved?

In case any answer helped kindly mark it as Accepted and upvote so others can benefit as well!

Otherwise post your feedback to provide additional help!

Regards

Answer 1

Hello @WinTechie !

Azure API Apps and Web Apps are both technically Azure App Services under the hood. The differentiation like "kind" is a matter of how Azure sets up and manages the app, rather than it being a completely separate resource. This is evident when you see that there's no direct PowerShell commandlet for creating an API App.

In fact the API app can deploy any package the same way as other APP Services

So to sum it up , no there is no similar command in Powershell

If you look here :https://learn.microsoft.com/en-us/powershell/module/az.websites/new-azwebapp?view=azps-10.2.0

you can see the supported commands

I agree that the template shows API as kind but the only actual and observable difference is the Premium version

We can re deploy the Template and change the kind to API as well , the same result we will get !

Here is my proof , i deployed the same template :----------->

User's image

And then just changed the word api to app in the same template :

User's image

Success! Only the icon changes !

I hope this helps!

Kindly mark the answer as Accepted and Upvote in case it helped!

Regards

Answer 2

Konstantinos Passadis 19,586 MVP

Hello @WinTechie !

Good news !

Finally i got this :

https://learn.microsoft.com/en-us/azure/app-service/deploy-local-git?tabs=powershell

Just change the cloned Repo to the API Repo !

With a small tweak :

git remote add azure <url>

git push azure main:master It worked !

Just skip the step to create a Deployment User and use the available from the Portal , Local Git Credentials!

It worked like a charm !

User's image

I hope this helps!

Kindly mark the answer as Accepted and Upvote in case it helped!

Regards

WinTechie 286 Reputation points

2023-09-06T13:19:12.9133333+00:00

Hi @Konstantinos Passadis

Thanks for the answers so far.

when I looked at the proposed solution, it looks like it still would create a WebApp variant of app service than APIApp.

I am not very concerned about deploying code in the app but rather how to create the APIApp itself than a WebApp.

I was hoping if there was a similar powershell commandlet like ''New-AzAPIApp" just like "New-AzWebApp" but I could not find it.

upon searching further, I found that there is property called "kind" in the json template of the running app service which probably decides what type of app service would it be. I found following values again kind property of the running webapp and apiapp

WebApp, kind = app

APIApp, kind = api

but that is applicable for template based provisioning, and I am looking for powershell here

Share via

Create API service using powershell

1 additional answer

Your answer