Skip to content

Commit 251f07c

Browse files
author
gitName
committed
edits/review
1 parent cdf91b2 commit 251f07c

File tree

2 files changed

+32
-34
lines changed

2 files changed

+32
-34
lines changed

articles/api-center/includes/api-center-service-limits.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,9 @@ ms.custom: Include file
2424
| Maximum number of child properties in custom metadata property of type "object" | 10 |10 |
2525
| Maximum requests per minute (data plane) | 3,000 | 6,000 |
2626
| Maximum number of API definitions [linted](../enable-managed-api-analysis-linting.md) per 4 hours | 10 | 100 |
27-
| Maximum number of integrated API sources<sup>4</sup> | 1 | 3 |
27+
| Maximum number of linked API sources<sup>4</sup> | 1 | 3 |
2828

2929
<sup>1</sup> To increase a limit in the Standard plan, contact [support](https://azure.microsoft.com/support/options/).<br/>
3030
<sup>2</sup> In the Free plan, use of full service features including API analysis and access through the data plane API is limited to 5 APIs.<br/>
3131
<sup>3</sup> Custom metadata properties assigned to APIs, deployments, and environments.<br/>
32-
<sup>4</sup> Sources such as integrated API Management instances. In the Free plan, synchronization from an integrated API source is limited to 200 APIs and 5 API definitions.
32+
<sup>4</sup> Sources such as linked API Management instances. In the Free plan, synchronization from a linked API source is limited to 200 APIs and 5 API definitions.

articles/api-center/synchronize-api-management-apis.md

Lines changed: 30 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,24 @@
11
---
22
title: Synchronize APIs from Azure API Management instance
3-
description: Integrate an API Management instance to Azure API Center for automatic synchronization of APIs from API Management to the inventory.
3+
description: Link an API Management instance to Azure API Center for automatic synchronization of APIs to the inventory.
44
author: dlepow
55
ms.service: azure-api-center
66
ms.topic: how-to
7-
ms.date: 10/22/2024
7+
ms.date: 10/29/2024
88
ms.author: danlep
99
ms.custom: devx-track-azurecli
1010
# Customer intent: As an API program manager, I want to integrate my Azure API Management instance to my API center and synchronize API Management APIs to my inventory.
1111
---
1212

13-
# Integrate an API Management instance to synchronize APIs to your API center
13+
# Synchronize APIs from an API Management instance
1414

15-
This article shows how to create an integration (preview) to an API Management instance so that the instances's APIs are synchronized in your [API center](overview.md).
15+
This article shows how to create a link (preview) to an API Management instance so that the instances's APIs are synchronized in your [API center](overview.md).APIs in a linked API Management instance are continuously kept up to date in your API center inventory.
1616

17-
APIs in an integrated API Management instance are continuously kept up to date in your API center inventory. This synchronization makes all of the API Management APIs available to stakeholders to be discovered, reused, and governed like your other APIs.
17+
## About linking API Management
1818

19-
## About integrating an API Management instance
19+
Although you can use the Azure CLI to [import](import-api-management-apis.md) APIs on demand from Azure API Management to Azure API Center, linking an API Management instance enables continuous synchronization so that the API inventory stays up to date.
2020

21-
Although you can use the Azure CLI to [import](import-api-management-apis.md) APIs on demand from Azure API Management to Azure API Center, integrating an API Management instance enables continuous synchronization so that the API inventory stays up to date.
22-
23-
When you integrate an API Management instance, the following happens:
21+
When you link an API Management instance, the following happens:
2422

2523
* All APIs, and optionally API definitions, from the API Management instance are added to the API center inventory.
2624
* You configure an [environment](key-concepts.md#environment) of type *Azure API Management* in the API center. An associated [deployment](key-concepts.md#deployment) is created for each synchronized API definition from API Management.
@@ -29,23 +27,23 @@ API Management APIs automatically synchronize to the API center whenever existin
2927

3028
> [!NOTE]
3129
> * API updates in API Management can take a few minutes to synchronize to your API center.
32-
> * There are [limits](../azure-resource-manager/management/azure-subscription-service-limits.md?toc=/azure/api-center/toc.json&bc=/azure/api-center/breadcrumb/toc.json#api-center-limits) for the number of integrate API Management instances.
30+
> * There are [limits](../azure-resource-manager/management/azure-subscription-service-limits.md?toc=/azure/api-center/toc.json&bc=/azure/api-center/breadcrumb/toc.json#api-center-limits) for the number of linked API Management instances.
3331
3432

3533
### Entities synchronized from API Management
3634

37-
You can add or update API metadata and documentation in your API center to help stakeholders discover, understand, and consume the synchronized APIs. Learn more about Azure API Center's [built-in and custom metadata properties](add-metadata-properties.md).
35+
You can add or update metadata properties and documentation in your API center to help stakeholders discover, understand, and consume the synchronized APIs. Learn more about Azure API Center's [built-in and custom metadata properties](add-metadata-properties.md).
3836

39-
Certain properties of synchronized APIs and other entities are configured automatically in the API center and are read-only, as shown in the following table:
37+
The following table shows entity properties that can be modified in Azure API Center and those that are determined based on their values in a linked Azure API Management instance. Also, entities' resource or system identifiers in Azure API Center are generated automatically and can't be modified.
4038

41-
| Entity | Read-only properties in API center |
42-
|--------------|--------------------------------------------------------|
43-
| API | title<br/>description<br/>kind |
44-
| API version | title |
45-
| Environment | server.type
46-
| Deployment | server.runtimeUri<br/>environmentId<br/>definitionId |
39+
| Entity | API Center | API Management |
40+
|--------------|-----------------------------------------|-----------------|
41+
| API | summary<br/>lifecycleStage<br/>termsOfService<br/>license<br/>externalDocumentation<br/>customProperties | title<br/>description<br/>kind |
42+
| API version | lifecycleStage | title |
43+
| Environment | title<br/>description<br/>kind</br>server.managementPortalUri<br/>onboarding<br/>customProperties | server.type
44+
| Deployment | title<br/>description<br/>server<br/>state<br/>customProperties | server.runtimeUri<br/>environmentId<br/>definitionId |
4745

48-
For property details, see the [API Center REST API reference](/rest/api/apicenter).
46+
For property details, see the [Azure API Center REST API reference](/rest/api/apicenter).
4947

5048

5149
## Prerequisites
@@ -71,41 +69,41 @@ Select
7169

7270
[!INCLUDE [configure-managed-identity-apim-reader](includes/configure-managed-identity-apim-reader.md)]
7371

74-
## Integrate an API Management instance
72+
## Link an API Management instance
7573

76-
You can create an integration to an API Management instance using the portal.
74+
You can link an API Management instance using the portal.
7775

7876
#### [Portal](#tab/portal)
7977

8078
1. In the [portal](https://portal.azure.com), navigate to your API center.
8179
1. Under **Assets**, select **Environments**.
82-
1. Select **Integrations (preview)** > **+ New integration**.
83-
1. In the **Integrate your Azure API Management Service** page:
84-
1. Select the **Subscription**, **Resource group**, and **Azure API Management service** that you want to integrate.
85-
1. In **Integration details**, enter an identifier.
80+
1. Select **Links (preview)** > **+ New link**.
81+
1. In the **Link your Azure API Management Service** page:
82+
1. Select the **Subscription**, **Resource group**, and **Azure API Management service** that you want to link.
83+
1. In **Link details**, enter an identifier.
8684
1. In **Environment details**, enter an **Environment title** (name), **Environment type**, and optional **Environment description**.
8785
1. In **API details**, select a **Lifecycle stage** for the synchronized APIs. (You can update this value for your APIs after they're added to your API center.) Also, select whether to synchronize API definitions.
8886
1. Select **Create**.
8987

90-
:::image type="content" source="media/synchronize-api-management-apis/link-api-management-service.png" alt-text="Screenshot of integrated an Azure API Management Service in the portal.":::
88+
:::image type="content" source="media/synchronize-api-management-apis/link-api-management-service.png" alt-text="Screenshot of linking an Azure API Management Service in the portal.":::
9189

9290
The environment is added in your API center. The API Management APIs are imported to the API center inventory.
9391

9492
:::image type="content" source="media/synchronize-api-management-apis/environment-link-list.png" alt-text="Screenshot of environment list in the portal.":::
9593
---
9694

97-
## Delete an integration
95+
## Delete a link
9896

99-
While an API Management instance is integrated, you can't delete synchronized APIs from your API center. If you need to, you can delete the integration. When you delete an integration:
97+
While an API Management instance is linked, you can't delete synchronized APIs from your API center. If you need to, you can delete the link. When you delete a link:
10098

101-
* All the synchronized API Management APIs in your API center inventory are deleted
99+
* The synchronized API Management APIs in your API center inventory are deleted
102100
* The environment and deployments associated with the API Management instance are deleted
103101

104-
To delete an API Management integration:
102+
To delete an API Management link:
105103

106104
1. In the [portal](https://portal.azure.com), navigate to your API center.
107-
1. Under **Assets**, select **Environments** > **Integrations (preview)**.
108-
1. Select the integration, and then select **Delete** (trash can icon).
105+
1. Under **Assets**, select **Environments** > **Link (preview)**.
106+
1. Select the link, and then select **Delete** (trash can icon).
109107

110108
## Related content
111109

0 commit comments

Comments
 (0)