You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This quickstart describes the steps for creating a new API Management instance using the Azure portal. After creating an instance, you can use the Azure portal for common management tasks such as importing APIs in your API Management instance.
20
+
This quickstart describes the steps for creating a new API Management instance by using the Azure portal. After creating an instance, you can use the Azure portal for common management tasks such as importing APIs in your API Management instance.
1. From the Azure portal menu, select **Create a resource**. You can also select **Create a resource** on the Azure **Home** page.
33
-
34
-
:::image type="content" source="media/get-started-create-service-instance/create-resource.png" alt-text="Select Create a resource.":::
30
+
1. Sign in to the [Azure portal](https://portal.azure.com).
35
31
32
+
1. Select **Create a resource**. You can also select **Create a resource** on the Azure **Home** page.
36
33
34
+
:::image type="content" source="media/get-started-create-service-instance/create-resource.png" alt-text="Screenshot showing the Azure portal.":::
35
+
37
36
1. On the **Create a resource** page, select **Integration** > **API Management**.
38
37
39
-
:::image type="content" source="media/get-started-create-service-instance/create-resource-page.png" alt-text="Screenshot of creating a new Azure API Management instance.":::
38
+
:::image type="content" source="media/get-started-create-service-instance/create-resource-page.png" alt-text="Screenshot showing the Create a resource screen with API Management highlighted.":::
40
39
41
40
1. On the **Create API Management** page, on the **Basics** tab, enter settings.
42
41
43
-
:::image type="content" source="media/get-started-create-service-instance/create-api-management-instance-1.png" alt-text="Create API Management instance.":::
42
+
:::image type="content" source="media/get-started-create-service-instance/create-api-management-instance-1.png" alt-text="Screenshot showing the basic settings to create an API Management instance.":::
|**Subscription**| The subscription under which this new service instance will be created. |
48
-
|**Resource group**|Select a new or existing resource group. A resource group is a logical container into which Azure resources are deployed and managed. |
49
-
|**Region**| Select a geographic region near you from the available API Management service locations. |
50
-
|**Resource name**| A unique name for your API Management instance. The name can't be changed later. The service name refers to both the service and the corresponding Azure resource. <br/><br/> The service name is used to generate a default domain name: *\<name\>.azure-api.net.* If you would like to configure a custom domain name later, see [Configure a custom domain](configure-custom-domain.md). |
46
+
|**Subscription**| The subscription under which this new service instance will be created. |
47
+
|**Resource group**| Select a new or existing resource group. A resource group is a logical container into which Azure resources are deployed and managed. |
48
+
|**Region**| Select a geographic region near you from the available API Management service locations. |
49
+
|**Resource name**| A unique name for your API Management instance. The name can't be changed later. The service name refers to both the service and the corresponding Azure resource. <br/><br/> The service name is used to generate a default domain name: *\<name\>.azure-api.net.* If you would like to configure a custom domain name later, see [Configure a custom domain](configure-custom-domain.md). |
51
50
|**Organization name**| The name of your organization. This name is used in many places, including the title of the developer portal and sender of notification emails. |
52
-
|**Administrator email**| The email address to which all system notifications from **API Management**will be sent. |
51
+
|**Administrator email**| The email address to which all system notifications from **API Management**are sent. |
53
52
|**Pricing tier**| Select a [tier](api-management-features.md) with the features you need. The **Basic v2** tier is an economical choice for development and testing scenarios and is deployed in a few minutes. |
54
-
|**Units**| The number of units of capacity for the selected pricing tier. For evaluating API Management, you can accept the default value of 1 unit. |
53
+
|**Units**| The number of units of capacity for the selected pricing tier. For evaluating API Management, you can accept the default value of *1* unit. |
55
54
56
55
1. On the **Monitor + secure** tab, optionally select one or more recommended add-in services to use with API Management. These services incur extra costs. For example, select **Log Analytics** to define a Log Analytics workspace you can target for API Management logs.
57
56
58
-
> [!TIP]
59
-
> It can take 30 to 40 minutes or more to create and activate an API Management service in this tier. To quickly find a newly created service, select **Pin to dashboard**.
57
+
1. On the **Networking** tab, optionally select one or more networking options that are supported in your service tier to secure inbound or outbound traffic to API Management.
58
+
59
+
1. On the **Managed identity** tab, optionally enable a system-assigned managed identity for your instance. This is recommended for many scenarios to connect API Management to other Azure services.
60
+
61
+
1. On the **Tags** tab, optionally add one or more name-value pairs to help you categorize your Azure resources.
60
62
63
+
1. Select **Review + create**. After validation completes, select **Create**.
64
+
65
+
> [!TIP]
66
+
> The time to create and activate an API Management service depends on the service tier. To quickly find a newly created service, select **Pin to dashboard**.
:::image type="content" source="media/get-started-create-service-instance/get-started-create-service-instance-created-1.png" alt-text="Screenshot showing the overview section of your API Management instance.":::
67
73
68
74
When your API Management service instance is online, you're ready to use it. Start with the tutorial to [import and publish your first API](import-and-publish.md).
69
75
@@ -73,19 +79,19 @@ When no longer needed, you can remove the resource group and all the related res
73
79
74
80
1. In the Azure portal, search for and select **Resource groups**. You can also select **Resource groups** on the **Home** page.
75
81
76
-
:::image type="content" source="media/get-started-create-service-instance/resource-groups.png" alt-text="Resource group navigation.":::
82
+
:::image type="content" source="media/get-started-create-service-instance/resource-groups.png" alt-text="Screenshot showing Resource groups in the portal search bar.":::
77
83
78
84
1. On the **Resource groups** page, select your resource group.
79
85
80
-
:::image type="content" source="media/get-started-create-service-instance/resource-group-page.png" alt-text="Select your resource group.":::
86
+
:::image type="content" source="media/get-started-create-service-instance/resource-group-page.png" alt-text="Screenshot showing your resource groups.":::
81
87
82
88
1. On the resource group page, select **Delete resource group**.
83
89
84
90
1. Type the name of your resource group, and then select **Delete**.
:::image type="content" source="media/get-started-create-service-instance/delete-resource-group.png" alt-text="Screenshot showing the button to delete your resource group.":::
87
93
88
-
## Next steps
94
+
## Next step
89
95
90
96
> [!div class="nextstepaction"]
91
97
> [Import and publish your first API](import-and-publish.md)
Copy file name to clipboardExpand all lines: articles/api-management/import-app-service-as-api.md
+22-15Lines changed: 22 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,12 @@
1
1
---
2
-
title: Import an Azure web app to Azure API Management | Microsoft Docs
2
+
title: Import an Azure Web App to Azure API Management
3
3
description: Learn how to use Azure API Management to import a web API that's hosted in Azure App Service.
4
4
services: api-management
5
5
author: dlepow
6
6
7
7
ms.service: azure-api-management
8
8
ms.topic: how-to
9
-
ms.date: 03/28/2025
9
+
ms.date: 03/10/2026
10
10
ms.author: danlep
11
11
12
12
#customer intent: As an API developer, I want to import a web app as an API to API Management so that I can take advantage of the benefits of using this environment.
@@ -34,15 +34,15 @@ Using API Management to expose a Web Apps-hosted API provides these benefits:
34
34
* Decouple managing and securing the front end that's exposed to API consumers from managing and monitoring the backend web app.
35
35
* Manage web APIs hosted as web apps in the same environment as your other APIs.
36
36
* Apply [policies](api-management-policies.md) to change API behavior, such as call-rate limiting.
37
-
* Direct API consumers to the customizable API Management [developer portal](api-management-howto-developer-portal.md) so they can discover and learn about your APIs, request access, and try APIs.
37
+
* Direct API consumers to the customizable API Management [developer portal](developer-portal-overview.md) so they can discover and learn about your APIs, request access, and try APIs.
38
38
39
-
For more information, see [About API Management](api-management-key-concepts.md).
39
+
For more information, see [What is Azure API Management?](api-management-key-concepts.md)
40
40
41
41
## OpenAPI definition vs. wildcard operations
42
42
43
-
API Management supports import of web apps hosted in App Service that include an OpenAPI definition (a Swagger definition). However, an OpenAPI definition isn't required.
43
+
API Management supports the import of web apps hosted in App Service that include an OpenAPI definition (a Swagger definition). However, an OpenAPI definition isn't required.
44
44
45
-
* If the web app is configured with an OpenAPI definition, API Management will detect that. Alternatively, you can [manually import the definition](import-api-from-oas.md) to API Management. API Management then creates API operations that map directly to the definition, including required paths, parameters, and response types.
45
+
* If the web app is configured with an OpenAPI definition, API Management detects that. Alternatively, you can [manually import the definition](import-api-from-oas.md) to API Management. API Management then creates API operations that map directly to the definition, including required paths, parameters, and response types.
46
46
47
47
Having an OpenAPI definition is recommended, because the API is imported to API Management with high fidelity, giving you the flexibility to validate, manage, secure, and update configurations for each operation separately.
48
48
@@ -53,45 +53,50 @@ API Management supports import of web apps hosted in App Service that include an
53
53
### Example
54
54
55
55
Your backend web app might support two GET operations:
You import the web app to your API Management service at a path like `https://<api>.azureapi.net/store`. The following table shows the operations that are imported to API Management, with or without an OpenAPI specification:
The wildcard operation allows the same requests to the backend service as the operations in the OpenAPI specification. However, the OpenAPI-specified operations can be managed separately in API Management.
67
67
68
68
## Prerequisites
69
69
70
-
+Complete the quickstart [Create an Azure API Management instance](get-started-create-service-instance.md).
70
+
+ Create an [Azure API Management instance](get-started-create-service-instance.md).
71
71
+ Make sure there's an app service in your subscription. For more information, see [App Service documentation](../app-service/index.yml).
72
72
73
73
For information about creating an example web API and publishing it as an Azure web app, see:
74
74
75
-
*[Tutorial: Create a web API with ASP.NET Core](/aspnet/core/tutorials/first-web-api).
76
-
*[Publish an ASP.NET Core app to Azure with Visual Studio Code](/aspnet/core/tutorials/publish-to-azure-webapp-using-vscode).
75
+
*[Tutorial: Create a web API with ASP.NET Core](/aspnet/core/tutorials/first-web-api)
76
+
*[Publish an ASP.NET Core app to Azure with Visual Studio Code](/aspnet/core/tutorials/publish-to-azure-webapp-using-vscode)
77
77
78
78
## Import and publish a backend API
79
79
80
80
> [!TIP]
81
81
> In the following steps, you start the import by using API Management in the Azure portal. You can also link to API Management directly from your web app by selecting **API Management** in the app's **API** menu.
82
82
83
83
1. Navigate to your API Management service in the [Azure portal](https://portal.azure.com).
84
-
1. In the left menu, in the **APIs section**, select **APIs**, and then select **+ Add API**.
84
+
85
+
1. In the sidebar menu, under **APIs**, select **APIs**, and then select **+ Add API**.
86
+
85
87
1. Select the **App Service** tile:
86
88
87
89
:::image type="content" source="media/import-app-service-as-api/app-service.png" alt-text="Screeenshot that shows the App Service tile.":::
88
90
89
91
1. Select **Browse** to see the list of app services in your subscription.
90
-
1. Select an app service and then click the **Select** button. If an OpenAPI definition is associated with the selected web app, API Management fetches it and imports it.
92
+
93
+
1. Select an app service and then choose the **Select** button. If an OpenAPI definition is associated with the selected web app, API Management fetches it and imports it.
91
94
92
95
If an OpenAPI definition isn't found, API Management exposes the API by generating wildcard operations for common HTTP verbs.
96
+
93
97
1. Add an **API URL suffix**. The suffix is a name that identifies the API in the API Management instance. It has to be unique in the API Management instance.
94
-
1. If you want the API to be published and available to developers, switch to the **Full** view and associate the API with a **Product**. This example uses the **Unlimited** product. (You can add your API to a product when you create it or later via the **Settings** tab.)
98
+
99
+
1. If you want the API to be published and available to developers, switch to the **Full** view, and then associate the API with a **Product**. This example uses the **Unlimited** product. You can add your API to a product when you create it or later via the **Settings** tab.
95
100
96
101
> [!NOTE]
97
102
> Products are associations of one or more APIs offered to developers via the developer portal. First, developers must subscribe to a product to get access to the API. After they subscribe, they get a subscription key for any API in the product. As creator of the API Management instance, you're an administrator and are subscribed to every product by default.
@@ -110,6 +115,7 @@ The wildcard operation allows the same requests to the backend service as the op
110
115
You can call operations directly from the Azure portal. This method provides a convenient way to view and test the operations of an API. You can also test the API in the [developer portal](api-management-howto-developer-portal.md) or by using your own REST client tools.
111
116
112
117
1. Select the API you created in the previous step.
118
+
113
119
1. On the **Test** tab, select an operation.
114
120
115
121
The page displays fields for query parameters and fields for the headers. One of the headers is `Ocp-Apim-Subscription-Key`. This header is for the subscription key of the product that's associated with the API. If you created the API Management instance, you're an administrator already, so the key is filled in automatically.
@@ -125,6 +131,7 @@ When wildcard operations are generated, the operations might not map directly to
125
131
To test the path `/api/todoItems`:
126
132
127
133
1. Select the API that you created, and then select an operation.
134
+
128
135
1. On the **Test** tab, under **Template parameters**, update the value next to the wildcard (*) name. For example, enter **api/todoItems**. This value gets appended to the path `/` for the wildcard operation.
129
136
130
137
:::image type="content" source="media/import-app-service-as-api/test-wildcard-operation.png" alt-text="Screenshot that shows the steps for testing an operation." lightbox="media/import-app-service-as-api/test-wildcard-operation.png":::
0 commit comments