Discover Azure API Management APIs in Catalog with the Konnect API
Install the Azure API Management integration in Konnect and authorize access with OAuth, then link an Azure API to your Catalog service.
Prerequisites
Kong Konnect
If you don’t have a Konnect account, you can get started quickly with our onboarding wizard.
- 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.
-
Set the personal access token as an environment variable:
export KONNECT_TOKEN='YOUR KONNECT TOKEN'Copied!
Konnect roles
You need the Integration Admin role in Konnect to install and authorize Catalog integrations.
Azure API Management
- An API in Azure API Management and the subscription ID for the API.
- An Azure email account is associated with an Azure organization. Personal Azure accounts aren’t supported for this integration.
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.
- In the Konnect sidebar, click Catalog.
- In the Catalog sidebar, click Integrations.
- Click Azure API Management.
- Click Add Azure API Management instance.
- In the Subscription ID field, enter your Azure API subscription ID.
- Click Submit configuration.
- In the Add authorization section, click Authorize in Azure API Management.
- Click Authorize to authenticate with Azure using OAuth.
- In the Azure authorization window, click Accept.
- In the Display name field, enter
azure-api-management-test. - In the Instance name field, enter
azure-api-management-test. - Click Save.
Create a service in Catalog
Create a service that you’ll map to your Azure API Management resources:
curl -X POST "https://us.api.konghq.com/v1/catalog-services" \
--no-progress-meter --fail-with-body \
-H "Authorization: Bearer $KONNECT_TOKEN" \
--json '{
"name": "billing",
"display_name": "Billing Service"
}'
Export the service ID:
export AZURE_SERVICE_ID='YOUR-SERVICE-ID'
List Azure API Management resources
Before you can map your Azure API Management resources to a service in Catalog, you first need to find the resources that are pulled in from Azure API Management:
curl -X GET "https://us.api.konghq.com/v1/resources?filter%5Bintegration.name%5D=azure-api-management" \
--no-progress-meter --fail-with-body \
-H "Authorization: Bearer $KONNECT_TOKEN"
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.
Export the resource ID you want to map to the service:
export AZURE_RESOURCE_ID='YOUR-RESOURCE-ID'
Map resources to a service
Now, you can map the Azure API Management resource to the service:
curl -X POST "https://us.api.konghq.com/v1/resource-mappings" \
--no-progress-meter --fail-with-body \
-H "Authorization: Bearer $KONNECT_TOKEN" \
--json '{
"service": "billing",
"resource": "'$AZURE_RESOURCE_ID'"
}'
Validate the mapping
To confirm that the Azure API Management resource is now mapped to the intended service, list the service’s mapped resources:
curl -X GET "https://us.api.konghq.com/v1/catalog-services/$AZURE_SERVICE_ID/resources" \
--no-progress-meter --fail-with-body \
-H "Authorization: Bearer $KONNECT_TOKEN"