Azure API Management Devops CI-CD Pipeline using ARM templates and Yaml file

Automating API Management deployment | CI-CD pipeline for API Management | ARM templates for Azure API Management

Azure API Management Devops CI-CD Pipeline using ARM templates and Yaml file
Sanjeevi Subramani's photo
Sanjeevi Subramani

Published on Aug 13, 2020

2 min read

Subscribe to my newsletter and never miss my upcoming articles

Here am going to cover how to automate Azure API management deployment using Azure Devops CI-CD Pipeline using the Creator tool from this Github repo.

Azure API Management Devops Creator tool(Open source) is an command line tool for generating ARM templates so that we can use that in the Azure Devops pipeline to deploy to Azure.

It takes an valid.yml, Swagger.json files for each api(for each version), policy.xml file for each apis, globalpolicy.xml file and Backendurls.json file for generating ARM templates with resource details of API Management.

Valid.yml file contains the api details like below:

apiVersionSets: #version sets of the apis
 - id: 1
 displayName: Api 1
 description: api 1
 versioningScheme: Query #query string will contain api-version with value of version
 versionQueryName: api-version
 apis:
 - name: api1 # this name should be unique and this field name is the key value used in backendurl parameters file for updating the api url as a parameter json file
 type: http
 displayName: API 1
 description:
 serviceUrl: #we are parameterizing this url in backendurl parameter input json file
 openApiSpec: './apis/api1/1.0/Swagger.json' #swagger file path
 policy: './apis/api1/1.0/apiServicePolicy.xml' #service level policy.xml file path
 suffix: api1
 subscriptionRequired: true
 isCurrent: true
 apiVersion: apiVersion
 Description: api 1 revision 1 apiVersionSetId: 1
 apiRevision: 1
 apiRevisionDescription:
 products: sampleproduct
 tags:
 diagnostic:

Creator tool Parameterized values are Backend urls, Appinsights, Appinsights Instrumentation key which will change for each environments.

Usage:

dotnet tool run apim-templates create — appInsightsInstrumentationKey $(VariableAppinsightsInstrumentationKey) — appInsightsName $(VariableAppinsightsName) — configFile “./valid.yml” — backendurlconfigFile “./TemplateAndParameters/BackendUrlParameters.json”

where VariableAppinsightsInstrumentationKey, VariableAppinsightsName are variables we can pass in pipeline variables and the valid.yml file with api definition and description details, the Backendulrparameters.json file with urls of all the apis.

Sample valid.yml file

Sample BackendUrl.json file

Below is the sample solution structure i have used for this pipeline input :

Below is the sample yaml file used in Azure Devops pipeline.

You can refer the files in this github repo:

Thanks,

Sanjeevi Subramani

 
Share this