Picture

This article serves as help document for the BUs to onboard their APIs once their APIM products have been recorded in the Global Shared APIM and a confirmation about the same has been sent by the team. BU DevOps team can refer to this document for any help on the various tasks that needs to be performed by them to onboard their APIs and some other tasks such as create users, create subscriptions, add policies etc. by using the custom DevOps tasks (published by Global Shared APIM team. 

Create BU Service Connection 

Create a service connection in your Azure DevOps project with Service principal authentication. Service principal will be the one you sent in onboarding request. Below are the fields to be setup to create this: 

Product Management 

Task Name (in Azure DevOps): CCOE APIM Product 

Service Connection: BU Managers 

As a BU Manager this task will allow BU Managers to: 

  • Create a product 

  • API Onboarding 

  • Create/Update users and groups 

  • Create/Update subscription 

  • Create/Update a product policy 

  • Create/Update a product tag 

  • Update a product.

Prerequisites

  • Onboarding stage must have been done. 

  • You should own an Azure AD Service Principal with: 

    • Microsoft Graph 

      • Directory.Read.All 

  • Azure Active Directory Graph 

    • Azure Active Directory Graph 

      • Directory.Read.All     

  • Read access to Azure AD.

Azure DevOps Pipeline (BU Managers)

Azure DevOps Pipeline (BU Developers) 

This task is used to create the API for the API definition (created previously) with the help of an open specification file. It can be also used to upload a policy for the API