Skip to content

Commit bc9eae0

Browse files
committed
[APIM] Merged experimental content into Overview article
1 parent 82371df commit bc9eae0

File tree

1 file changed

+36
-23
lines changed

1 file changed

+36
-23
lines changed

articles/api-management/api-management-key-concepts.md

Lines changed: 36 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,36 @@
11
---
2-
title: Azure API Management overview and key concepts | Microsoft Docs
3-
description: Learn about key scenarios, capabilities, and concepts of the Azure API Management service.
2+
title: Azure API Management - Overview and key concepts | Microsoft Docs
3+
description: Introduction to key scenarios, capabilities, and concepts of the Azure API Management service. API Management supports the full API lifecycle.
44
services: api-management
55
documentationcenter: ''
66
author: dlepow
77
editor: ''
88

99
ms.service: api-management
1010
ms.topic: overview
11-
ms.date: 01/07/2022
11+
ms.date: 09/23/2022
1212
ms.author: danlep
1313
ms.custom: mvc
14-
15-
adobe-target: true
16-
adobe-target-activity: DocsExp–458741–A/B–Docs/APIManagement–Content–FY23Q1
17-
adobe-target-experience: Experience B
18-
adobe-target-content: ./api-management-key-concepts-experiment
1914
---
2015

21-
# About API Management
16+
# What is Azure API Management?
17+
18+
This article provides an overview of common scenarios and key components of Azure API Management. Azure API Management is a hybrid, multicloud management platform for APIs across all environments. As a platform-as-a-service, API Management supports the complete API lifecycle.
2219

23-
Azure API Management is a hybrid, multicloud management platform for APIs across all environments. This article provides an overview of common scenarios and key components of API Management.
20+
> [!TIP]
21+
> If you're already familiar with API Management and ready to start, see these resources:
22+
> * [Features and service tiers](api-management-features.md)
23+
> * [Create an API Management instance](get-started-create-service-instance.md)
24+
> * [Import and publish an API](import-and-publish.md)
25+
> * [API Management policies](api-management-howto-policies.md)
2426
2527
## Scenarios
2628

2729
APIs enable digital experiences, simplify application integration, underpin new digital products, and make data and services reusable and universally accessible. ​With the proliferation and increasing dependency on APIs, organizations need to manage them as first-class assets throughout their lifecycle.​
2830

31+
:::image type="content" source="media/api-management-key-concepts-experiment/apis-connected-experiences.png" alt-text="Diagram showing role of APIs in connected experiences.":::
32+
33+
2934
Azure API Management helps customers meet these challenges:
3035

3136
* Abstract backend architecture diversity and complexity from API consumers
@@ -44,22 +49,23 @@ Common scenarios include:
4449

4550
Azure API Management is made up of an API *gateway*, a *management plane*, and a *developer portal*. These components are Azure-hosted and fully managed by default. API Management is available in various [tiers](api-management-features.md) differing in capacity and features.
4651

47-
:::image type="content" source="media/api-management-key-concepts/api-management-components.png" alt-text="Key components of Azure API Management":::
52+
:::image type="content" source="media/api-management-key-concepts-experiment/api-management-components.png" alt-text="Diagram showing key components of Azure API Management.":::
4853

49-
### API gateway
54+
## API gateway
5055

5156
All requests from client applications first reach the API gateway, which then forwards them to respective backend services. The API gateway acts as a facade to the backend services, allowing API providers to abstract API implementations and evolve backend architecture without impacting API consumers. The gateway enables consistent configuration of routing, security, throttling, caching, and observability.
5257

5358
[!INCLUDE [api-management-gateway-role](../../includes/api-management-gateway-role.md)]
5459

60+
### Self-hosted gateway
5561
With the [self-hosted gateway](self-hosted-gateway-overview.md), customers can deploy the API gateway to the same environments where they host their APIs, to optimize API traffic and ensure compliance with local regulations and guidelines. The self-hosted gateway enables customers with hybrid IT infrastructure to manage APIs hosted on-premises and across clouds from a single API Management service in Azure.
5662

57-
The self-hosted gateway is packaged as a Linux-based Docker container and is commonly deployed to Kubernetes, including to Azure Kubernetes Service and [Azure Arc-enabled Kubernetes](how-to-deploy-self-hosted-gateway-azure-arc.md).
63+
The self-hosted gateway is packaged as a Linux-based Docker container and is commonly deployed to Kubernetes, including to Azure Kubernetes Service and [Azure Arc-enabled Kubernetes](how-to-deploy-self-hosted-gateway-azure-arc.md).
5864

5965
More information:
6066
* [API gateway in Azure API Management](api-management-gateways-overview.md)
6167

62-
### Management plane
68+
## Management plane
6369

6470
API providers interact with the service through the management plane, which provides full access to the API Management service capabilities.
6571

@@ -75,10 +81,12 @@ Use the management plane to:
7581
* Manage users
7682

7783

78-
### Developer portal
84+
## Developer portal
7985

8086
The open-source [developer portal][Developer portal] is an automatically generated, fully customizable website with the documentation of your APIs.
8187

88+
:::image type="content" source="media/api-management-key-concepts-experiment/cover.png" alt-text="Screenshot of API Management developer portal - administrator mode." border="false":::
89+
8290
API providers can customize the look and feel of the developer portal by adding custom content, customizing styles, and adding their branding. Extend the developer portal further by [self-hosting](developer-portal-self-host.md).
8391

8492
App developers use the open-source developer portal to discover the APIs, onboard to use them, and learn how to consume them in applications. (APIs can also be exported to the [Power Platform](export-api-power-platform.md) for discovery and use by citizen developers.)
@@ -94,16 +102,21 @@ Using the developer portal, developers can:
94102

95103
## Integration with Azure services
96104

97-
API Management integrates with many complementary Azure services, including:
105+
API Management integrates with many complementary Azure services to create enterprise solutions, including:
98106

99107
* [Azure Key Vault](../key-vault/general/overview.md) for secure safekeeping and management of [client certificates](api-management-howto-mutual-certificates.md) and [secrets​](api-management-howto-properties.md)
100108
* [Azure Monitor](api-management-howto-use-azure-monitor.md) for logging, reporting, and alerting on management operations, systems events, and API requests​
101109
* [Application Insights](api-management-howto-app-insights.md) for live metrics, end-to-end tracing, and troubleshooting
102-
* [Virtual networks](virtual-network-concepts.md) and [Application Gateway](api-management-howto-integrate-internal-vnet-appgateway.md) for network-level protection​
110+
* [Virtual networks](virtual-network-concepts.md), [private endpoints](private-endpoint.md), and [Application Gateway](api-management-howto-integrate-internal-vnet-appgateway.md) for network-level protection​
103111
* Azure Active Directory for [developer authentication](api-management-howto-aad.md) and [request authorization](api-management-howto-protect-backend-with-aad.md)
104112
* [Event Hubs](api-management-howto-log-event-hubs.md) for streaming events​
105113
* Several Azure compute offerings commonly used to build and host APIs on Azure, including [Functions](import-function-app-as-api.md), [Logic Apps](import-logic-app-as-api.md), [Web Apps](import-app-service-as-api.md), [Service Fabric](how-to-configure-service-fabric-backend.md), and others.​
106114

115+
**More information**:
116+
* [Basic enterprise integration](/azure/architecture/reference-architectures/enterprise-integration/basic-enterprise-integration?toc=%2Fazure%2Fapi-management%2Ftoc.json&bc=/azure/api-management/breadcrumb/toc.json)
117+
* [Landing zone accelerator](/azure/cloud-adoption-framework/scenarios/app-platform/api-management/landing-zone-accelerator?toc=%2Fazure%2Fapi-management%2Ftoc.json&bc=/azure/api-management/breadcrumb/toc.json)
118+
119+
107120
## Key concepts
108121

109122
### APIs
@@ -112,7 +125,7 @@ APIs are the foundation of an API Management service instance. Each API represen
112125

113126
Operations in API Management are highly configurable, with control over URL mapping, query and path parameters, request and response content, and operation response caching.
114127

115-
More information:
128+
**More information**:
116129
* [Import and publish your first API][How to create APIs]
117130
* [Mock API responses][How to add operations to an API]
118131

@@ -122,7 +135,7 @@ Products are how APIs are surfaced to developers. Products in API Management hav
122135

123136
When a product is ready for use by developers, it can be published. Once published, it can be viewed or subscribed to by developers. Subscription approval is configured at the product level and can either require an administrator's approval or be automatic.
124137

125-
More information:
138+
**More information**:
126139
* [Create and publish a product][How to create and publish a product]
127140
* [Subscriptions in API Management](api-management-subscriptions.md)
128141

@@ -140,16 +153,16 @@ Groups are used to manage the visibility of products to developers. API Manageme
140153

141154
Administrators can also create custom groups or use external groups in an [associated Azure Active Directory tenant](api-management-howto-aad.md) to give developers visibility and access to API products. For example, create a custom group for developers in a partner organization to access a specific subset of APIs in a product. A user can belong to more than one group.
142155

143-
More information:
156+
**More information**:
144157
* [How to create and use groups][How to create and use groups]
145158

146159
### Developers
147160

148161
Developers represent the user accounts in an API Management service instance. Developers can be created or invited to join by administrators, or they can sign up from the [developer portal][Developer portal]. Each developer is a member of one or more groups, and can subscribe to the products that grant visibility to those groups.
149162

150-
When developers subscribe to a product, they are granted the primary and secondary key for the product for use when calling the product's APIs.
163+
When developers subscribe to a product, they're granted the primary and secondary key for the product for use when calling the product's APIs.
151164

152-
More information:
165+
**More information**:
153166
* [How to manage user accounts][How to create or invite developers]
154167

155168
### Policies
@@ -160,7 +173,7 @@ Policy expressions can be used as attribute values or text values in any of the
160173

161174
Policies can be applied at different scopes, depending on your needs: global (all APIs), a product, a specific API, or an API operation.
162175

163-
More information:
176+
**More information**:
164177

165178
* [Transform and protect your API][How to create and configure advanced product settings].
166179
* [Policy expressions](./api-management-policy-expressions.md)

0 commit comments

Comments
 (0)