APIIDA API Control Plane

How to connect to Azure

On this page, you will find a step-by-step guide on how to connect your AWS API Gateway to APIIDA's API Control Plane.

Prerequisites

The following is required to proceed:

 



Provide the Gateway Information

The following describes how to create the gateway configuration for an Azure Gateway Agent.

Gateway Configuration

image-20240209-160106.png

 

  • serviceName: The name of your Azure API Management service instance.

  • resourceGroupName: The name of the resource group that contains your API Management service instance.

  • subscriptionId: The ID of the Azure subscription that contains your API Management service instance.

  • tenantId/clientId/clientSecret: The credentials of an authorized application.

See our Q&A below if you want to learn more about how to get these values.

Currently, each Azure agent is specific to one API Management service.
If you want to manage multiple services, you will require an agent instance for each service.

  • Your configuration file will download automatically.

  • Confirm by clicking on the "Download and Next" button

 

You’ve completed the second step!




Q&A - ** Look here in case of agent errors

  • Go to the Overview page of your Azure API Management service

    • The serviceName is displayed at the top left (see screenshot)

    • The resourceGroupName is displayed in the overview under "Resource group”

    • The subscriptionId is displayed in the overview under “Subscription ID”

Azure API Management Service: Overview

We recommend creating an application via Azure Active Directory to access the API Management Service. Below is a description of how to do this and how to obtain the required IDs and the client secret.

Step 1 of 2: Create a new Application in Azure Active Directory

  • Now click on Add a certificate or secret (see Screenshot)

  • After that click on New client secret and add a new secret

  • The requested clientSecret will now be displayed

Important: Save the secret value, because it will no longer be displayed after you have left the page!

Note that the created application must also be assigned to the API Management Service (see Step 2), otherwise there is no link between the API Management service and the Application.


Step 2 of 2: Assign the Application to your Azure API Management Service

  • Go to the Overview page of your Azure API Management service

    • Select Access control (IAM) in the menu on the left side

    • Click on Add role assignment in the interface

    • Select the Role “API Management Service Contributor” to grant the necessary permissions

    • Click on Members (next to Role) or Next (at the bottom) to continue

    • Add your Application to the list of Role members

    • Click on Review + assign (next to Members) or Next (at the bottom) to continue

    • Confirm by clicking on the ”Review + assign”-Button (at the bottom)