Skip to content

Commit 1f09e5f

Browse files
Merge pull request #235157 from dlepow/subs
[APIM] Update to subscription concepts
2 parents ca04fef + fc639c3 commit 1f09e5f

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

articles/api-management/api-management-subscriptions.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,17 @@ author: dlepow
77

88
ms.service: api-management
99
ms.topic: conceptual
10-
ms.date: 12/16/2022
10+
ms.date: 04/19/2023
1111
ms.author: danlep
1212
ms.custom: engagement-fy23
1313
---
1414
# Subscriptions in Azure API Management
1515

1616
In Azure API Management, *subscriptions* are the most common way for API consumers to access APIs published through an API Management instance. This article provides an overview of the concept.
1717

18+
> [!NOTE]
19+
> An API Management subscription is used specifically to call APIs through API Management. It's not the same as an Azure subscription.
20+
1821
## What are subscriptions?
1922

2023
By publishing APIs through API Management, you can easily secure API access using subscription keys. Developers who need to consume the published APIs must include a valid subscription key in HTTP requests when calling those APIs. Without a valid subscription key, the calls are:
@@ -76,7 +79,7 @@ Each API Management instance comes with an immutable, all-APIs subscription (als
7679
7780
### Standalone subscriptions
7881

79-
API Management also allows *standalone* subscriptions, which are not associated with a developer account. This feature proves useful in scenarios similar to several developers or teams sharing a subscription.
82+
API Management also allows *standalone* subscriptions, which aren't associated with a developer account. This feature proves useful in scenarios similar to several developers or teams sharing a subscription.
8083

8184
Creating a subscription without assigning an owner makes it a standalone subscription. To grant developers and the rest of your team access to the standalone subscription key, either:
8285
* Manually share the subscription key.
@@ -88,6 +91,17 @@ API publishers can [create subscriptions](api-management-howto-create-subscripti
8891

8992
When created in the portal, a subscription is in the **Active** state, meaning a subscriber can call an associated API using a valid subscription key. You can change the state of the subscription as needed - for example, you can suspend, cancel, or delete the subscription to prevent API access.
9093

94+
## Use a subscription key
95+
96+
A subscriber can use an API Management subscription key in one of two ways:
97+
98+
* Add the **Ocp-Apim-Subscription-Key** HTTP header to the request, passing the value of a valid subscription key.
99+
100+
* Include the **subscription-key** query parameter and a valid value in the URL. The query parameter is checked only if the header isn't present.
101+
102+
> [!TIP]
103+
> **Ocp-Apim-Subscription-Key** is the default name of the subscription key header, and **subscription-key** is the default name of the query parameter. If desired, you may modify these names in the settings for each API. For example, in the portal, update these names on the **Settings** tab of an API.
104+
91105
## Enable or disable subscription requirement for API or product access
92106

93107
By default when you create an API, a subscription key is required for API access. Similarly, when you create a product, by default a subscription key is required to access any API that's added to the product. Under certain scenarios, an API publisher might want to publish a product or a particular API to the public without the requirement of subscriptions. While a publisher could choose to enable unsecured (anonymous) access to certain APIs, configuring another mechanism to secure client access is recommended.

0 commit comments

Comments
 (0)