Create subscriptions in Azure API Management
APPLIES TO: All API Management tiers
When you publish APIs through Azure API Management, it's easy and common to secure access to those APIs by using subscription keys. Client applications that need to consume the published APIs must include a valid subscription key in HTTP requests when they make calls to those APIs. To get a subscription key for accessing APIs, a subscription is required. For more information about subscriptions, see Subscriptions in Azure API Management.
This article walks through the steps for creating subscriptions in the Azure portal.
Prerequisites
To take the steps in this article, the prerequisites are as follows:
Create a new subscription
Navigate to your API Management instance in the Azure portal.
In the left menu, under APIs, select Subscriptions > Add subscription.
Provide a Name and optional Display name of the subscription.
Optionally, select Allow tracing to enable tracing for debugging and troubleshooting APIs. Learn more
Warning
- Only allow tracing on subscriptions intended for debugging purposes. Sharing subscription keys with tracing allowed with unauthorized users could lead to disclosure of sensitive information contained in tracing logs such as keys, access tokens, passwords, internal hostnames, and IP addresses.
- In the test console, API Management automatically disables tracing 1 hour after it's enabled on a subscription.
Note
Currently, API request tracing isn't supported in the Basic v2 and Standard v2 tiers.
Select a Scope of the subscription from the dropdown list. Learn more
Optionally, choose if the subscription should be associated with a User and whether to send a notification for use with the developer portal.
Select Create.
After you create the subscription, it appears in the list on the Subscriptions page. Two API keys are provided to access the APIs. One key is primary, and one is secondary.
Next steps
Get more information on API Management:
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for