search

MicrosoftDocs / azure-docs

Open source documentation of Microsoft Azure
https://docs.microsoft.com/azure
Creative Commons Attribution 4.0 International
10.2k stars 21.34k forks source link

No page on how to create an API with Bicep #115643

Closed karl-petter-sj closed 10 months ago

karl-petter-sj commented 11 months ago

Is there any good reason or why is there no page/tutorial on how to use Bicep to add/create a new API into an existing instance of APIM?

We have centrally managed APIM instances but allow the different teams to use pipelines to deploy and modify resources but they do not have access to do that in the portal since we want our infrastructure in code. It would help developers new to Azure a lot to have a tutorial to follow on how to add an API to an existing APIM instance.

Document Details

⚠ Do not edit this section. It is required for learn.microsoft.com ➟ GitHub issue linking.

SaibabaBalapur-MSFT commented 11 months ago

@karl-petter-sj Thanks for your feedback! We will investigate and update as appropriate.

dlepow commented 11 months ago

@karl-petter-sj - Thanks for your feedback. Here are a couple of resources that might help with adding an API using bicep.

  1. Blog post: https://techcommunity.microsoft.com/t5/azure-developer-community-blog/automate-your-api-deployments-with-azure-api-management-and/ba-p/3682278

  2. Bicep reference: https://learn.microsoft.com/en-us/azure/templates/microsoft.apimanagement/2022-08-01/service/apis?pivots=deployment-language-bicep

Please let us know if this information helps. Thanks.

karl-petter-sj commented 11 months ago

@dlepow I know how to do it. I am part of the plattform team here at SJ but we have several teams that are new to Azure and we want them to use IaC for all their infra. APIM is setup by us in the platform team but the teams themselves add the different APIs. So I looked at MS Learn for an article on how to use bicep to add an API so I do not have to explain it everytime a team asks. Of course I could write an article in our docs on how to do it and send the link to the team, but it would be so much nicer to have an article in MS Learn to send them. First it hints them to look in there for problems rather than asking us but it will also be updated by you when anything in APIM changes and we do not need to keep track of every detail. Thus I asked if there was any specific reason why there where no section or page on how to do it with Bicep since there were documented so many other different ways.

dlepow commented 10 months ago

@karl-petter-sj - Thanks for the clarification, and I understand your context better now :). There's not a specific reason why we don't have the information, except perhaps that the complete set of tooling options isn't always available when we create/update content. I've noted your request for our backlog and will see that the work to update articles on creating an API is assigned in an upcoming doc sprint.

According to our usual process I'll now proceed to close this issue. Thanks again for raising the issue and for your feedback.

please-close