Discover Azure API Management APIs in Catalog with the Konnect UI

Uses: Catalog
TL;DR

Install the Azure API Management integration in Konnect and authorize access with OAuth, then link an Azure API to your Catalog service.

Prerequisites

If you don’t have a Konnect account, you can get started quickly with our onboarding wizard.

  1. The following Konnect items are required to complete this tutorial:
    • Personal access token (PAT): Create a new personal access token by opening the Konnect PAT page and selecting Generate Token.
  2. Set the personal access token as an environment variable:

    export KONNECT_TOKEN='YOUR KONNECT TOKEN'
    

You need the Integration Admin role in Konnect to install and authorize Catalog integrations.

Configure the Azure API Management integration

Note: The Azure API Management integration uses OAuth for authentication and can only be configured through the Konnect UI.

Before you can discover APIs in Catalog, you must configure the Azure API Management integration.

  1. In the Konnect sidebar, click Catalog.
  2. In the Catalog sidebar, click Integrations.
  3. Click Azure API Management.
  4. Click Add Azure API Management instance.
  5. In the Subscription ID field, enter your Azure API subscription ID.
  6. Click Submit configuration.
  7. In the Add authorization section, click Authorize in Azure API Management.
  8. Click Authorize to authenticate with Azure using OAuth.
  9. In the Azure authorization window, click Accept.
  10. In the Display name field, enter azure-api-management-test.
  11. In the Instance name field, enter azure-api-management-test.
  12. Click Save.

Create a Catalog service and map the API resources

Now that your integration is configured, you can create a Catalog service to map the ingested APIs.

In this tutorial, we’ll refer to your ingested Azure API Management API as billing-api.

  1. In the Konnect sidebar, click Catalog.
  2. In the Catalog sidebar, click Services.
  3. Click New service.
  4. In the Display Name field, enter Billing Service.
  5. Click Create.
  6. Click Map Resources.
  7. Select billing-api.
  8. Click Map 1 Resource.

Your integration APIs are now discoverable from one Catalog service.

You might need to manually sync your Azure API Management integration for resources to appear. In the Konnect UI, by navigate to the Azure API Management integration you just installed and select Sync Now from the Actions dropdown menu.

Validate the mapping

To confirm that the Azure API Management resource is now mapped to the intended service, navigate to the service:

  1. In the Konnect sidebar, click Catalog.
  2. In the Catalog sidebar, click Services.
  3. Click the Billing Service service.
  4. Click the Resources tab.

You should see the billing-api resource listed.

Something wrong?

Help us make these docs great!

Kong Developer docs are open source. If you find these useful and want to make them better, contribute today!