Skip to content

Commit 4993019

Browse files
author
gitName
committed
integration
1 parent 01b30ca commit 4993019

File tree

2 files changed

+32
-36
lines changed

2 files changed

+32
-36
lines changed

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

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +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 linked API sources<sup>4</sup> | 1 | 3 |
28-
| Maximum number of API [synchronizations](../synchronize-api-management-apis.md)<sup>4</sup> per 4 hours | 1 | 10 |
27+
| Maximum number of integrated API sources<sup>4</sup> | 1 | 3 |
2928

3029
<sup>1</sup> To increase a limit in the Standard plan, contact [support](https://azure.microsoft.com/support/options/).<br/>
3130
<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/>
3231
<sup>3</sup> Custom metadata properties assigned to APIs, deployments, and environments.<br/>
33-
<sup>4</sup> Sources such as linked API Management instances that synchronize APIs.
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.

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

Lines changed: 30 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,35 @@
11
---
2-
title: Synchronize APIs from Azure API Management source
3-
description: Link an API Management instance to Azure API Center for automatic synchronization of APIs from API Management to the inventory.
2+
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.
44
author: dlepow
55
ms.service: azure-api-center
66
ms.topic: how-to
77
ms.date: 10/22/2024
88
ms.author: danlep
99
ms.custom: devx-track-azurecli
10-
# Customer intent: As an API program manager, I want to link my Azure API Management instance to my API center and synchronize API Management APIs to my inventory.
10+
# 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-
# Link an API Management instance to synchronize APIs to your API center
13+
# Integrate an API Management instance to synchronize APIs to your API center
1414

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).
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).
1616

17-
APIs in a linked API Management instance are continuously kept up to date in your API center inventory. This makes all of the API Management APIs easily discoverable and accessible to developers, API program managers, and other stakeholders.
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.
1818

19-
## About linking an API Management instance
19+
## About integrating an API Management instance
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, linking an API Management instance enables continuous synchronization so that the API inventory stays up to date.
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.
2222

23-
When you create a link to an API Management instance, the following happens:
23+
When you integrate an API Management instance, the following happens:
2424

2525
* All APIs, and optionally API definitions, from the API Management instance are added to the API center inventory.
2626
* 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.
2727

2828
API Management APIs automatically synchronize to the API center whenever existing APIs' settings change, new versions are added, new APIs are created, or APIs are deleted. This synchronization is one-way from API Management to your Azure API center, meaning API updates in the API center aren't synchronized back to the API Management instance.
2929

3030
> [!NOTE]
31-
> * Some API updates in API Management can take a few minutes to synchronize to your API center.
32-
> * Links to API Management instances are subject to [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) on number of linked API sources and synchronization frequency.
31+
> * 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.
3333
3434

3535
### Entities synchronized from API Management
@@ -42,9 +42,8 @@ Certain properties of synchronized APIs and other entities are configured automa
4242
|--------------|--------------------------------------------------------|
4343
| API | • title<br/>• description<br/>• kind |
4444
| API version | • title |
45-
| API definition | N/A |
46-
| Deployment | • server.runtimeUri<br/>• environmentId<br/>• definitionId |
4745
| Environment | • server.type
46+
| Deployment | • server.runtimeUri<br/>• environmentId<br/>• definitionId |
4847

4948
For property details, see the [API Center REST API reference](/rest/api/apicenter).
5049

@@ -53,9 +52,7 @@ For property details, see the [API Center REST API reference](/rest/api/apicente
5352

5453
* An API center in your Azure subscription. If you haven't created one, see [Quickstart: Create your API center](set-up-api-center.md).
5554

56-
* One or more instances of Azure API Management, in the same or a different subscription. The resources must be in the same directory.
57-
58-
* One or more APIs managed in your API Management instance that you want to synchronize to your API center.
55+
* An Azure API Management instance, in the same or a different subscription. The instance must be in the same directory.
5956

6057
* For Azure CLI:
6158
[!INCLUDE [include](~/reusable-content/azure-cli/azure-cli-prepare-your-environment-no-header.md)]
@@ -74,41 +71,41 @@ Select
7471

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

77-
## Link an API Management instance
74+
## Integrate an API Management instance
7875

79-
You can create a link to an API Management instance using the portal.
76+
You can create an integration to an API Management instance using the portal.
8077

8178
#### [Portal](#tab/portal)
8279

8380
1. In the [portal](https://portal.azure.com), navigate to your API center.
8481
1. Under **Assets**, select **Environments**.
85-
1. Select **Links (preview)** > **+ Create a link**.
86-
1. In the **Link your Azure API Management Service** page:
87-
1. Select the **Subscription**, **Resource group**, and **Azure API Management service** that you want to link.
88-
1. In **Link details**, enter a link identifier.
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.
8986
1. In **Environment details**, enter an **Environment title** (name), **Environment type**, and optional **Environment description**.
90-
1. In **API details**, select a **Lifecycle** stage for all the synchronized APIs. (You can change this value for some or all APIs after they're added to your API center.) Also, select whether to synchronize API definitions.
87+
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.
9188
1. Select **Create**.
9289

93-
:::image type="content" source="media/synchronize-api-management-apis/link-api-management-service.png" alt-text="Screenshot of the Link your API Management service page.":::
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.":::
9491

95-
A linked environment is added in your API center. The API Management APIs are imported to the API center inventory.
92+
The environment is added in your API center. The API Management APIs are imported to the API center inventory.
9693

97-
:::image type="content" source="media/synchronize-api-management-apis/environment-link-list.png" alt-text="Screenshot of link to API Management in the portal.":::
94+
:::image type="content" source="media/synchronize-api-management-apis/environment-link-list.png" alt-text="Screenshot of environment list in the portal.":::
9895
---
9996

100-
## Unlink an API Management instance
97+
## Delete an integration
10198

102-
While an API Management instance is linked, you can't deleted synchronized APIs from your API center. If you need to, you can unlink an API Management instance. When you unlink an API Management instance from your API center:
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:
103100

104-
* All the API Management APIs in your API center inventory are deleted
105-
* The environment associated with the API Management instance is deleted
101+
* All the synchronized API Management APIs in your API center inventory are deleted
102+
* The environment and deployments associated with the API Management instance are deleted
106103

107-
To unlink an API Management instance:
104+
To delete an API Management integration:
108105

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

113110
## Related content
114111

0 commit comments

Comments
 (0)