Serverless REST APIs using Azure Functions
Azure Functions is an essential compute service that you use to build serverless REST-based APIs. HTTP triggers expose REST endpoints that can be called by your clients, like browsers, mobile apps, and other backend services. With native support for routes, a single HTTP triggered function can expose a highly functional REST API. Functions also provides its own basic key-based authorization scheme to help limit access only to specific clients. For more information, see Azure Functions HTTP trigger
In some scenarios, you may need your API to support a more complex set of REST behaviors. For example, you may need to combine multiple HTTP function endpoints into a single API. You might also want to pass requests through to one or more backend REST-based services. Finally, your APIs might require a higher-degree of security that lets you monetize its use.
Today, the recommended approach to build more complex and robust APIs based on your functions is to use the comprehensive API services provided by Azure API Management. API Management uses a policy-based model to let you control routing, security, and OpenAPI integration. It also supports advanced policies like rate limiting monetization. Previous versions of the Functions runtime used the legacy Functions Proxies feature.
Important
Azure Functions proxies is a legacy feature for versions 1.x through 3.x of the Azure Functions runtime. Support for proxies can be re-enabled in version 4.x for you to successfully upgrade your function apps to the latest runtime version. As soon as possible, you should switch to integrating your function apps with Azure API Management. API Management lets you take advantage of a more complete set of features for defining, securing, managing, and monetizing your Functions-based APIs. For more information, see API Management integration.
To learn how to re-enable proxies support in Functions version 4.x, see Re-enable proxies in Functions v4.x.
Moving from Functions Proxies to API Management
When moving from Functions Proxies to using API Management, you must integrate your function app with an API Management instance, and then configure the API Management instance to behave like the previous proxy. The following section provides links to the relevant articles that help you succeed in using API Management with Azure Functions.
If you have challenges moving from proxies or if Azure API Management doesn't address your specific scenarios, post a request in the API Management feedback forum.
API Management integration
API Management lets you import an existing function app. After import, each HTTP triggered function endpoint becomes an API that you can modify and manage. After import, you can also use API Management to generate an OpenAPI definition file for your APIs. During import, any endpoints with an admin authorization level are ignored. For more information about using API Management with Functions, see the following articles:
| Article | Description |
|---|---|
| Expose serverless APIs from HTTP endpoints using Azure API Management | Shows how to create a new API Management instance from an existing function app in the Azure portal. Supports all languages. |
| Create serverless APIs in Visual Studio using Azure Functions and API Management integration | Shows how to use Visual Studio to create a C# project that uses the OpenAPI extension. The OpenAPI extension lets you define your .NET APIs by applying attributes directly to your C# code. |
| Quickstart: Create a new Azure API Management service instance by using the Azure portal | Create a new API Management instance in the portal. After you create an API Management instance, you can connect it to your function app. Other non-portal creation methods are supported. |
| Import an Azure function app as an API in Azure API Management | Shows how to import an existing function app to expose existing HTTP trigger endpoints as a managed API. This article supports both creating a new API and adding the endpoints to an existing managed API. |
After you have your function app endpoints exposed by using API Management, the following articles provide general information about how to manage your Functions-based APIs in the API Management instance.
| Article | Description |
|---|---|
| Edit an API | Shows you how to work with an existing API hosted in API Management. |
| Policies in Azure API Management | In API Management, publishers can change API behavior through configuration using policies. Policies are a collection of statements that are run sequentially on the request or response of an API. |
| API Management policy reference | Reference that details all supported API Management policies. |
| API Management policy samples | Helpful collection of samples using API Management policies in key scenarios. |
Legacy Functions Proxies
The legacy Functions Proxies feature also provides a set of basic API functionality for version 3.x and older version of the Functions runtime.
Important
Azure Functions proxies is a legacy feature for versions 1.x through 3.x of the Azure Functions runtime. Support for proxies can be re-enabled in version 4.x for you to successfully upgrade your function apps to the latest runtime version. As soon as possible, you should switch to integrating your function apps with Azure API Management. API Management lets you take advantage of a more complete set of features for defining, securing, managing, and monetizing your Functions-based APIs. For more information, see API Management integration.
To learn how to re-enable proxies support in Functions version 4.x, see Re-enable proxies in Functions v4.x.
Some basic hints for how to perform equivalent tasks using API Management have been added to the Functions Proxies article. We don't currently have documentation or tools to help you migrate an existing Functions Proxies implementation to API Management.
Next steps
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for