Skip to content

Latest commit

 

History

History
171 lines (99 loc) · 9.98 KB

import-function-app-as-api.md

File metadata and controls

171 lines (99 loc) · 9.98 KB
title titleSuffix description services author ms.service ms.topic ms.date ms.author
Import an Azure Function App as an API in API Management
Azure API Management
Learn how to import an Azure function app into Azure API Management as an API.
api-management
dlepow
azure-api-management
how-to
03/28/2025
danlep

Import an Azure function app as an API in Azure API Management

[!INCLUDE api-management-availability-all-tiers]

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 API Management.

[!INCLUDE api-management-workspace-availability]

This article describes how to import an Azure function app as an API to Azure API Management and test the API.

You'll learn how to:

[!div class="checklist"]

  • Import an Azure function app as an API
  • Append an Azure function app to an API
  • View the new function app host key and API Management named value
  • Test the API in the Azure portal

Prerequisites

Note

You can also use the API Management Extension for Visual Studio Code to import and manage your APIs. Complete the API Management Extension tutorial to get started.

Import an Azure function app as a new API

To create a new API from an Azure function app:

  1. Navigate to your API Management service in the Azure portal.

  2. Select APIs > APIs in the left pane.

  3. Under Create from Azure resource, select Function App:

    :::image type="content" source="./media/import-function-app-as-api/add-01.png" alt-text="Screenshot that shows the Function App tile in the Azure portal.":::

  4. Select the Browse button:

    :::image type="content" source="./media/import-function-app-as-api/add-02.png" alt-text="Screenshot that highlights the Browse button." lightbox="./media/import-function-app-as-api/add-02.png":::

  5. Click the Select button under Configure required settings to choose from the list of available function apps:

    :::image type="content" source="./media/import-function-app-as-api/add-03.png" alt-text="Screenshot that shows the Select button." lightbox="./media/import-function-app-as-api/add-03.png":::

  6. Find the function app that you want to import functions from, select it, and then click Select:

    :::image type="content" source="./media/import-function-app-as-api/add-04.png" alt-text="Screenshot that shows a function app and the Select button." lightbox="./media/import-function-app-as-api/add-04.png":::

  7. Select the functions that you want to import and click Select. You can only import functions that have an HTTP trigger and an Anonymous or Function authorization level.

    :::image type="content" source="./media/import-function-app-as-api/add-05.png" alt-text="Screenshot that shows a function and the Select button." lightbox="./media/import-function-app-as-api/add-05.png":::

  8. Switch to the Full view and assign a Product to your new API.

    [!NOTE] Products are associations of one or more APIs that are offered to developers via the developer portal. First, developers must subscribe to a product to get access to the API. When they subscribe, they get a subscription key for any API in the product. If you created the API Management instance, you're an administrator and are subscribed to every product by default.

    In some pricing tiers, API Management instances come with two default sample products:

    • Starter
    • Unlimited

  9. As needed, specify other settings. You can also specify settings later via the Settings tab. These settings are explained in the Import and publish your first API tutorial.

  10. Select Create.

Append a function app to an existing API

To append a function app to an existing API:

  1. In your Azure API Management service instance, select APIs > APIs in the left pane.

  2. Choose an API that you want to import a function app to. Select the ellipsis (...) next to the API, and then select Import:

    :::image type="content" source="./media/import-function-app-as-api/append-function-api-1.png" alt-text="Screenshot that shows the Import menu option." lightbox="./media/import-function-app-as-api/append-function-api-1.png":::

  3. Select the Function App tile:

    :::image type="content" source="./media/import-function-app-as-api/append-function-api-2.png" alt-text="Screenshot that shows the Function App tile." lightbox="./media/import-function-app-as-api/append-function-api-2.png":::

  4. In the Import from Function App window, select Browse:

    :::image type="content" source="./media/import-function-app-as-api/append-function-api-3.png" alt-text="Screenshot that shows the Browse button." lightbox="./media/import-function-app-as-api/append-function-api-3.png":::

  5. Click the Select button under Configure required settings to choose from the list of available function apps:

    :::image type="content" source="./media/import-function-app-as-api/add-03.png" alt-text="Screenshot that shows the Function App section." lightbox="./media/import-function-app-as-api/add-03.png":::

  6. Find the function app you want to import functions from, select it, and then click Select:

    :::image type="content" source="./media/import-function-app-as-api/add-04.png" alt-text="Screenshot that shows the function app and the Select button." lightbox="./media/import-function-app-as-api/add-04.png":::

  7. Select the functions that you want to import, and then click Select:

    :::image type="content" source="./media/import-function-app-as-api/add-05.png" alt-text="Screenshot that shows the list of functions." lightbox="./media/import-function-app-as-api/add-05.png":::

  8. Select Import:

    :::image type="content" source="./media/import-function-app-as-api/append-function-api-4.png" alt-text="Screenshot that shows the Import button." lightbox="./media/import-function-app-as-api/append-function-api-4.png":::

Authorization

When you import an Azure function app, these items are automatically generated:

  • A host key in the function app. The key is named apim-<your API Management service instance name>.
  • A named value in the API Management instance that has the name <your Azure function app instance name>-key. This value contains the host key.

For APIs created after April 4, 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. You can change this behavior by using the PATCH Backend REST API call on the Backend entity that's associated with the function app.

Warning

Removing or changing either the Azure function app host key value or the API Management named value will disable communication between the services. The values don't automatically sync.

If you need to rotate the host key, be sure to also change the named value in API Management.

Access a function app host key

  1. Navigate to your Azure function app instance:

    :::image type="content" source="./media/import-function-app-as-api/keys-01.png" alt-text="Screenshot that shows a list of function app instances." lightbox="./media/import-function-app-as-api/keys-01.png":::

  2. In the Functions section of the left pane, select App keys:

    :::image type="content" source="./media/import-function-app-as-api/keys-02b.png" alt-text="Screenshot that shows App keys in the menu." lightbox="./media/import-function-app-as-api/keys-02b.png":::

  3. Find the keys in the Host keys section:

    :::image type="content" source="./media/import-function-app-as-api/keys-03.png" alt-text="Screenshot that shows the host keys." lightbox="./media/import-function-app-as-api/keys-03.png":::

Access the named value in API Management

Navigate to your API Management instance and select APIs > Named values in the left pane. The Azure function app key is stored there.

:::image type="content" source="./media/import-function-app-as-api/api-named-value.png" alt-text="Screenshot that shows the location of the function app key." lightbox="./media/import-function-app-as-api/api-named-value.png":::

Test the new 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.

:::image type="content" source="./media/import-function-app-as-api/test-api.png" alt-text="Screenshot that shows the steps for testing an API." lightbox="./media/import-function-app-as-api/test-api.png":::

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

  2. Select the Test tab.

  3. Select the operation that you want to test.

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

  4. Select Send.

    When the test succeeds, the backend responds with 200 OK and some data.

[!INCLUDE api-management-define-api-topics.md]