Azure Integration Services Quickstart

An azd template (Bicep) for quickly deploying Azure Integration Services such as Azure API Management, Function App and Logic App, along with supporting resources like Application Insights, Key Vault and Storage Account. This template is ideal for demos, testing or getting started with Azure Integration Services.

Overview

This template deploys the following resources:

This template is designed to simplify and accelerate the deployment of Azure Integration Services for:

• Demonstrations
• Testing configurations
• Quick setups for experimentation
• CI scenarios in your pipeline

To minimize cost and reduce deployment time, the cheapest possible SKUs are used for each service. Virtual networks, application gateways and other security measures typically implemented in production scenarios are not included. Keep in mind that some resources may still incur costs, so it's a good idea to clean up when you're finished to avoid unexpected charges.

A sample application is included in the template to demonstrate how the services can be used together. It consists of an API with which a message can be published on a service bus topic. A function and workflow trigger on the message. The function will store the message in table storage and the workflow will store the message in blob storage. Using the API, the stored messages can be retrieved. See the following diagram for an overview:

Getting Started

If you haven't installed the Azure Developer CLI (azd) yet, follow the instructions on Install or update the Azure Developer CLI.

Deployment

Ones azd is installed on your machine, you can deploy this template using the following steps:

1. Run the azd init command in an empty directory with the --template parameter to clone this template into the current directory.

   azd init --template ronaldbosma/azure-integration-services-quickstart
   

2. Run the azd auth login command to authenticate to your Azure subscription (if you haven't already).

   azd auth login
   

3. Run the azd up command to provision the resources in your Azure subscription. This will deploy both the infrastructure and the sample application. (Use azd provision to only deploy the infrastructure.)

   azd up
   

   You'll be asked to select the Azure Integration Services you want to include in the deployment. Per service, use the arrow keys to select True to include it or False to skip it, and press Enter to continue.

   The includeApplicationInfraResources parameter specifies whether the application infrastructure resources defined in Bicep should be deployed. These resources are used by the sample application and include the Sample API in API Management, topics & subscriptions in Azure Service Bus, as well as tables & containers in Azure Storage.

   

   See Troubleshooting if you encounter any issues during deployment.

4. Once the deployment is complete, you can locally modify the application or infrastructure and run azd up again to update the resources in Azure.

Clean up

Once you're done and want to clean up, run the azd down command. By including the --purge parameter, you make sure that the API Management service doesn't remain in a soft-deleted state that could block future deployments of the same environment.

azd down --purge

Changing which resources to deploy

There are a couple of ways to change which Azure Integration Services are deployed and if the application infra resources should be deployed.

1. Remove your environment folder from the .azure folder. After deletion, use azd init to reinitialize the environment (with the same name). You'll be asked again which services to deploy when running azd up.

2. If the environment is currently deployed, locate the file .azure/<environment-name/.env and change the values of the INCLUDE_* variables to true or false.

   For example, to deploy API Management and the Function App, but not the Logic App and Service Bus, use the following settings:

   ...TRUNCATED...
   INCLUDE_API_MANAGEMENT="true"
   INCLUDE_FUNCTION_APP="true"
   INCLUDE_LOGIC_APP="false"
   INCLUDE_SERVICE_BUS="false"
   INCLUDE_APPLICATION_INFRA_RESOURCES="false"
   

3. If the environment has been taken down, most variables in the .env file are removed. Instead, locate the .azure/<environment-name/config.json file and change the values of the parameters to true or false.

   For example, to deploy API Management and the Function App, but not the Logic App and Service Bus, use the following settings:

   {
     "infra": {
       "parameters": {
         "includeApiManagement": true,
         "includeFunctionApp": true,
         "includeLogicApp": false,
         "includeServiceBus": false,
         "includeApplicationInfraResources": false
       }
     }
   }

   The environment variables take precedence over the parameters in the config.json file. If both are present, the environment variables are used.

When disabling an already deployed service, it will not be removed when running azd up or azd provision again. You'll need to manually remove the resources from the Azure portal or use azd down to remove the entire environment.

Features

• Integration Services:
  • Azure API Management (APIM)
  • Azure Function App
  • Azure Logic App (Standard)
• Shared Resources:
  • Application Insights for centralized logging and monitoring
  • Azure Key Vault for secure storage of secrets
  • Azure Storage Account for persistent storage
• Managed Identities:
  • Each integration service has a system-assigned managed identity.
  • These identities are assigned the following roles:
    • Azure Service Bus Data Receiver
    • Azure Service Bus Data Sender
    • Key Vault Secrets User
    • Storage Blob Data Contributor
    • Storage File Data SMB Share Contributor
    • Storage Queue Data Contributor
    • Storage Table Data Contributor
• Naming Convention:
  • All resources are deployed using a naming convention based on the Azure Resource Naming Best Practices.
  • The naming convention is implemented using user-defined functions in Bicep, which I blogged about in Apply Azure naming convention using Bicep functions.

The following image displays an example of the resources that are deployed with this template:

Troubleshooting

API Management deployment failed because service already exists in soft-deleted state

If you've previously deployed this template and deleted the resources, you may encounter the following error when redeploying the template. This error occurs because the API Management service is in a soft-deleted state and needs to be purged before you can create a new service with the same name.

{
    "code": "DeploymentFailed",
    "target": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-aisquick-dev-nwe-00001/providers/Microsoft.Resources/deployments/apiManagement",
    "message": "At least one resource deployment operation failed. Please list deployment operations for details. Please see https://aka.ms/arm-deployment-operations for usage details.",
    "details": [
        {
            "code": "ServiceAlreadyExistsInSoftDeletedState",
            "message": "Api service apim-aisquick-sdc-5spzh was soft-deleted. In order to create the new service with the same name, you have to either undelete the service or purge it. See https://aka.ms/apimsoftdelete."
        }
    ]
}

Use the az apim deletedservice list Azure CLI command to list all deleted API Management services in your subscription. Locate the service that is in a soft-deleted state and purge it using the purge command. See the following example:

az apim deletedservice purge --location "swedencentral" --service-name "apim-aisquick-sdc-5spzh"

Function App deployment failed because of quota limitations

If you already have a Consumption tier (SKU=Y1) Function App deployed in the same region, you may encounter the following error when deploying the template. This error occurs because you have reached the region's quota for your subscription.

{
  "code": "InvalidTemplateDeployment",
  "message": "The template deployment 'functionApp' is not valid according to the validation procedure. The tracking id is 'fffc2e2d-7c4c-4675-a211-b24cc7795ccf'. See inner errors for details.",
  "details": [
    {
      "code": "ValidationForResourceFailed",
      "message": "Validation failed for a resource. Check 'Error.Details[0]' for more information.",
      "details": [
        {
          "code": "SubscriptionIsOverQuotaForSku",
          "message": "This region has quota of 1 instances for your subscription. Try selecting different region or SKU."
        }
      ]
    }
  ]
}

Use the azd down --purge command to delete the resources and then deploy the template in a different region.

Logic App deployment failed because of quota limitations

If you already have a Workflow Standard WS1 tier (SKU=WS1) Logic App deployed in the same region, you may encounter the following error when deploying the template. This error occurs because you have reached the region's quota for your subscription.

{
  "code": "InvalidTemplateDeployment",
  "message": "The template deployment 'logicApp' is not valid according to the validation procedure. The tracking id is '00000000-0000-0000-0000-000000000000'. See inner errors for details.",
  "details": [
    {
      "code": "ValidationForResourceFailed",
      "message": "Validation failed for a resource. Check 'Error.Details[0]' for more information.",
      "details": [
        {
          "code": "SubscriptionIsOverQuotaForSku",
          "message": "This region has quota of 1 instances for your subscription. Try selecting different region or SKU."
        }
      ]
    }
  ]
}

Use the azd down --purge command to delete the resources and then deploy the template in a different region.