Import an Azure Function App as an API in Azure API Management

• 06/28/2019
• 4 minutes to read
• • 
  • 
  • 
  • 
  • 

Azure API Management supports importing Azure Function Apps as new APIs or appending them to existing APIs. The process automatically generates a host key in the Azure Function App, which is then assigned to a named value in Azure API Management.

This article walks through importing an Azure Function App as an API in Azure API Management. It also describes the testing process.

You will learn how to:

Prerequisites

• Complete the quickstart Create an Azure API Management instance.
• Make sure you have an Azure Functions app in your subscription. For more information, see Create an Azure Function App. It has to contain Functions with HTTP trigger and authorization level setting set to Anonymous or Function.

Go to your API Management instance

1. Sign in to the Azure portal.

2. Select All services.

3. In the search box, enter api management.

4. In the search results, select API Management services.

5. Select your API Management service instance.

Import an Azure Function App as a new API

Follow the steps below to create a new API from an Azure Function App.

1. In your Azure API Management service instance, select APIs from the menu on the left.

2. In the Add a new API list, select Function App.

   

3. Click Browse to select Functions for import.

   

4. Click on the Function App section to choose from the list of available Function Apps.

   

5. Find the Function App you want to import Functions from, click on it and press Select.

   

6. Select the Functions you would like to import and click Select.

   

   Note

   You can import only Functions that are based off HTTP trigger and have the authorization level setting set to Anonymous or Function.

7. Switch to the Full view and assign Product to your new API. If needed, edit other pre-populated fields.

   

8. Click Create.

Append Azure Function App to an existing API

Follow the steps below to append Azure Function App to an existing API.

1. In your Azure API Management service instance, select APIs from the menu on the left.

2. Choose an API you want to import an Azure Function App to. Click ... and select Import from the context menu.

   

3. Click on the Function App tile.

   

4. In the pop-up window, click Browse.

   

5. Click on the Function App section to choose from the list of available Function Apps.

   

6. Find the Function App you want to import Functions from, click on it and press Select.

   

7. Select the Functions you would like to import and click Select.

   

8. Click Import.

   

Authorization

Import of an Azure Function App automatically generates:

• Host key inside the Function App with the name apim-{your Azure API Management service instance name},
• Named value inside the Azure API Management instance with the name {your Azure Function App instance name}-key, which contains the created host key.

For APIs created after April 4th 2019, the host key is passed in HTTP requests from API Management to the Function App in a header. Older APIs pass the host key as a query parameter. This behavior may be changed through the PATCH Backend REST API call on the Backend entity associated with the Function App.

Access Azure Function App host key

1. Navigate to your Azure Function App instance.

2. Select Function App settings from the overview.

   

3. The key is located in the Host Keys section.

   

Access the named value in Azure API Management

Navigate to your Azure API Management instance and select Named values from the menu on the left. The Azure Function App key is stored there.

Test the new API Management API in the Azure portal

You can call operations directly from the Azure portal. Using the Azure portal is a convenient way to view and test the operations of an API.

1. Select the API that you created in the preceding section.

2. Select the Test tab.

3. Select an operation.

   The page displays fields for query parameters and fields for the headers. One of the headers is Ocp-Apim-Subscription-Key, for the subscription key of the product that is associated with this API. If you created the API Management instance, you are an administrator already, so the key is filled in automatically.

4. Select Send.

   The back end responds with 200 OK and some data.

Call an operation from the developer portal

You can also call operations from the developer portal to test APIs.

1. Select the API that you created in Import and publish a back-end API.

2. Select Developer portal.

   The developer portal site opens.

3. Select the API that you created.

4. Select the operation you want to test.

5. Select Try it.

6. Select Send.

   After an operation is invoked, the developer portal displays the Response status, the Response headers, and any Response content.

Related topics

• API import limitations
• Import an OpenAPI Specification
• Import a SOAP API
• Import a SOAP API and convert to REST
• Import an Azure API app
• Import an Azure Function App
• Import an Azure Logic App
• Import a Service Fabric service
• Edit an API

Next steps