azure-samples / serverless-apis

Guidance for building serverless APIs with Azure Functions and API Management.

Workshop: Serverless APIs in Azure

This repository contains a set of entry-level exercises, which cover the basics of building and managing serverless APIs in Microsoft Azure - with Azure Functions, Azure API Management, and Azure Application Insights.

After completing the workshop, you will be able to:

• Understand and articulate benefits of using API management and API gateway solutions in serverless architectures
• Expose serverless services as APIs
• Protect, accelerate, and transform APIs with runtime policies
• Observe the API traffic and identify problems across all layers of the stack
• Evolve your APIs with versions, without breaking client applications
• ... and more!

The image above illustrates the overall solution that will be created during the workshop.

What are serverless APIs?

Serverless computing enables developers to build applications faster by eliminating the need for them to manage infrastructure. With serverless applications, the cloud service provider automatically provisions, scales, and manages the infrastructure required to run the code.

Microsoft Azure offers a portfolio of serverless technologies, which can be used for building APIs. In this workshop, we will implement APIs end-to-end with Azure Functions and Azure API Management, realizing the benefits of serverless solutions:

• Automated scaling up and down, based on API traffic, to serve bursty payloads and handle explosive growth of services
• Architectural simplicity without no infrastructure management overhead, to spend resources on innovating and solving business problems rather than managing infrastructure
• Pay-per-consumption pricing model, to reduce the barrier of entry to the market

Repository contents

This repository contains source code of a sample serverless API implemented with Azure Functions as well as six exercises:

1. Setting up the Azure environment
2. Exposing Functions as APIs in API Management
3. Packaging APIs with Products
4. Applying API runtime policies
5. Monitoring APIs with Application Insights
6. Versioning APIs

The exercises require minimal knowledge of programming. Each exercise contains references to additional resources, such as documentation, blog posts, or conference session recordings.

Getting started

Get started with Exercise 1: Provisioning Azure Resources.

Related resources

• Benefits of API Management in microservices-based architectures
• Azure Functions: product overview, documentation
• Azure API Management: product overview, documentation
• Azure Serverless overview
• Serverless APIs module on Microsoft Learn

serverless-apis's Issues

Exercise 0: Local env setup + provision Azure resources

Add screenshots throughout the exercises

Validate workshop end-to-end

Validate exercise 1

Script: Add optional parameter for Azure subscription ID

Script:

• Add optional parameter for Azure subscription ID

Errors to deploy a C# function to Function App resource

Ran up against this when trying to get the workshop started for the first time via ./serverless-apim-setup.sh:

Output results will be saved to serverles-apim-setup.log file ...

• Creating serverless-sample7728 Resource Group ...
• Creating serverlesssample7728 Storage Account ...
• Creating serverless-sample7728 Application Insights Service ...
• Application Insights Instrumentation Key: "7dce2b6f-4ab7-41bb-981f-8ae1e3f8ab4e"
• Creating serverless-sample-products7728 Function App ...
• Creating serverless-sample-reviews7728 Function App ...
• Creating serverless-api7728 API Management [Consuption Plan] ...
  This command group is in preview. It may be changed/removed in a future release.
• Deploying serverless-sample-products7728 to serverless-sample-products7728 Function App ...
  Can't determine project language from files. Please use one of [--csharp, --javascript, --typescript, --java, --python, --powershell]
  You're trying to publish to a non-v2 function app from v2 tooling.
  You can pass --force to force update the app to v2, or switch to v1 or v3 tooling for publishing
• Deploying serverless-sample-reviews7728 to serverless-sample-reviews7728 Function App ...
  You're trying to publish to a non-v2 function app from v2 tooling.
  You can pass --force to force update the app to v2, or switch to v1 or v3 tooling for publishing
• Attaching App Insights to Aplication Management Instance ...
  % Total % Received % Xferd Average Speed Time Time Time Current
  Dload Upload Total Spent Left Speed
  100 724 100 554 100 170 636 195 --:--:-- --:--:-- --:--:-- 832
  ==============================================================

Done! Check your log information on serverless-apim-setup.log.

==============================================================

Add links to blog posts in readme

Add Azure B2C authentication workflow/process for mobile apps

Please provide us with the following information:

This issue is for a: (mark with an x)

- [ ] bug report -> please search issues before submitting
- [x ] feature request
- [ ] documentation issue or request
- [ ] regression (a behavior that used to work and stopped in a new release)

Minimal steps to reproduce

Thank you for a great write up - this is probably the clearest API Management documentation I've found to date. My request below is a long reach and I won't be offended if it's out of scope of this content. If I've got these concepts mixed up, please let me know as I am new to this area.

Current workshop notes allow protection of the API via subscription key which is great for a service/developer to consume.
Existing documentation (below) on trying to add an auth layer to an API via Azure B2C is piecemeal, scattered across different versions of state of the Azure Portal interface, and very opaque as to how to troubleshoot any of the steps. There are many many many 'quick start' tutorials of setting up the API in an unprotected state but none I've been able to use successfully to get B2C set up so as to allow a user of an app to call the API.

https://docs.microsoft.com/en-us/azure/active-directory-b2c/tutorial-register-spa
https://docs.microsoft.com/en-us/azure/active-directory-b2c/add-web-api-application?tabs=app-reg-ga
https://docs.microsoft.com/en-us/azure/active-directory-b2c/tutorial-single-page-app?tabs=app-reg-ga
https://docs.microsoft.com/en-us/azure/active-directory-b2c/tutorial-create-user-flows

Any log messages given by the failure

Expected/desired behavior

OS and Version?

Windows 7, 8 or 10. Linux (which distribution). macOS (Yosemite? El Capitan? Sierra?)

Versions

Mention any other details that might be useful

---

Thanks! We'll be in touch soon.

Repo-level readme

• Mention possibility to update to another tier

Exercise 6: API versioning

• Change the contracts in the Functions runtime
• Create a new API version for the new Functions

Revise Products exercise

Products:

• No dev portal (mention it applies to dedicated tiers only)
• No access control (groups) (mention it applies to dedicated tiers only)
• Modify exercise 2 to not mention Products
• Provision Products in exercise 3
• Assign APIs to Products in exercise 3

Research / implement Functions to use

Create template for exercise

Introduction + benefit to the customer (why would they want to do it? Value prop) 

Screenshot 

Precise walkthrough 

Recap of the benefit 

Next exercise – navigation to the exercise+1 

Related content (for example links to docs, external sites etc.) 

Attach App Insights to Functions

script:

• Attach App Insights to Functions

Fill the next action links in exercises

ARM Templates / automated setup

• Create Application Insights
• Create API Management (Consumption tier, with App Insights plugged in)
• Create and deploy multiple Function app with APIs

Local environment setup

• Install VS Code extensions (rest client, azure, etc.)

Exercise 3: Add API revision

Exercise 1: Import APIs

Expand the monitoring exercise

1. Mention about "Application map"
2. Include Azure Friday demo in the related resources: https://youtu.be/82q67x769XE?t=438

Exercise 2: Products

Describe Products, but use the built-in ones (Starter, Unlimited)

Exercise 4: Add policies

• Add rate limiting policy at the product level and test it
• Add CORS policy on all APIs level
• (optionally) Add transformation policies (headers, payload)

Describe main flow via Azure portal and introduce VS Code extension as an alternative flow

Readme file architecture diagram

Exercise 5: Monitoring

• Application insights with basic queries, Application Map, failed requests (because of throttling) etc.
• Mention Azure Monitor and Diagnostic Logs

'ECHO: command not found' Error

Please provide us with the following information:

This issue is for a: (mark with an x)

- [ ] bug report -> please search issues before submitting
- [ ] feature request
- [ X] documentation issue or request
- [ ] regression (a behavior that used to work and stopped in a new release)

Minimal steps to reproduce

Any log messages given by the failure

During 'Exercise 1: Provisioning Azure Resources',
Following your instructions, I entered the command './serverless-apim-setup.sh -s ' in Cloud Shell in Azure Portal.

But, The error './serverless-apim-setup.sh: line 6: ECHO: command not found' is output.
So, After I changed all the 'ECHO' statements to 'echo' in the vim editor, the command succeeded.

Expected/desired behavior

Code commit

OS and Version?

Windows 7, 8 or 10. Linux (which distribution). macOS (Yosemite? El Capitan? Sierra?)

Windows 10,
I did it in Cloud Shell in Azure portal.

Versions

Mention any other details that might be useful

---

Thanks! We'll be in touch soon.