If I Add Endpoints to an Azure Function, Do I Need to Import it into API Management Again?

Question

If I Add Endpoints to an Azure Function, Do I Need to Import it into API Management Again?

Nassirpour, Matthew@DGS 46

I am using Azure API Management. I imported an Azure Function into it, which configured all of the endpoint links for me. If another developer updates the underlying Function and adds more endpoints, will APIM pick that up automatically, or will I have to manually append them every time? If so, what's the best way to automate this process? ARM?

Accepted answer

1 additional answer

Your answer

Answer 1

I think it comes down to how you are deploying currently and how that process can be extended. As you state, using the portal's 'import' functionality is just an automated method of creating an API in APIM which references the backend function. This is a 'point-in-time' view and, while there now appears to be a link between the backend API and the API definition in APIM, it is not a dynamic link - just an imported API based upon specific definitions of the back-end, named-values etc. So, if you update your back-end with a new endpoint then you need to add this manually in APIM (or potentially re-import). What you need to do is create a process that dynamically updates the API management front-end endpoints for your API when the code changes and a new endpoint is added / something is changed.

You mention use of CI/CD. Take a look at this article. It uses YAML CI/CD pipelines to generate an OpenAPI definition of the API (In the article's case it is a webapi) from the startup assembly as part of CI, and then uses this OpenAPI spec to then update the API management instance as part of the CD stages. It may be an approach that you can adopt to achieve what you are looking for.

automating-your-openapi-updates-to-api-management-through-your-cicd-pipeline

Good Luck!

Nassirpour, Matthew@DGS 46 Reputation points

2022-08-04T17:16:42.633+00:00

This looks much closer to what I need. Thank you so much!

Answer 2

JananiRamesh-MSFT 29,261

Hi @Nassirpour, Matthew@DGS Thanks for reaching out. From the description I understand that you wanted to know is there a way to import an azure function automatically please refer this blog post which explains importing Azure function app to APIM Programmatically https://techcommunity.microsoft.com/t5/azure-paas-blog/import-azure-function-app-to-azure-api-management/ba-p/2594810

please let me know incase of further queries, I would be happy to assist you.

Please 'Accept as answer' and ‘Upvote’ if it helped so that it can help others in the community looking for help on similar topics.

Nassirpour, Matthew@DGS 46 Reputation points

2022-08-03T20:42:15.727+00:00

I'm sorry, this blog entry is somewhat difficult to follow, and doesn't seem to pertain to my particular use case. This blog seems to be walking you through importing a NEW Function by using the exported skeleton of an existing function. That isn't what I want. This also seems to rely on manually running a PowerShell script at some point, which sort of defeats the purpose, when I could just go in to the existing APIM entry and re-import the Function. Given the restrictions my organization has set on our tenant, I may not even be able to run PS scripts against it.

My use case is this:

I have a Function called MyFunction. It has two endpoints, GetThing and SetThing. I've linked it to the APIM. The APIM lists GetThing and SetThing when MyFunction is selected.

Now I have a second developer come along and add another endpoint to MyFunction called ListThings. Our CI/CD pushes the updated Function into Azure, but as far as I can tell, APIM still doesn't know about the endpoint ListThings and won't know about it until I manually go into the APIM, select MyFunction, and select Import, at which point it tries to import ALL of the endpoints instead of just the new ones. As far as I can tell, it doesn't automatically read the Function definition whenever it's triggered. So until I do the work, the APIM still only knows about GetThing and SetThing.

I'd like to automatically update APIM as part of the CI/CD process whenever MyFunction gets updated.

Share via

If I Add Endpoints to an Azure Function, Do I Need to Import it into API Management Again?

1 additional answer

Your answer