Skip to content

Commit d7bf1d2

Browse files
author
gitName
committed
wip
1 parent 4df5788 commit d7bf1d2

File tree

3 files changed

+40
-15
lines changed

3 files changed

+40
-15
lines changed
-1.53 KB
Loading
49.5 KB
Loading

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

Lines changed: 40 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Link an API Management instance to Azure API Center for automatic s
44
author: dlepow
55
ms.service: azure-api-center
66
ms.topic: how-to
7-
ms.date: 10/18/2024
7+
ms.date: 10/22/2024
88
ms.author: danlep
99
ms.custom: devx-track-azurecli
1010
# 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.
@@ -14,23 +14,40 @@ ms.custom: devx-track-azurecli
1414

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

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

1919
## About linking an API Management instance
2020

21-
While you can use the Azure CLI to [import](import-api-management-apis.md) APIs from Azure API Management to Azure API Center, linking an API Management instance enables automatic 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, linking an API Management instance enables continuous synchronization so that the API inventory stays up to date.
2222

2323
When you create a link to an API Management instance, the following happens:
2424

25-
* All APIs and related API definitions from the API Management instance are added to the API center inventory.
26-
* An [environment](key-concepts.md#environment) is created in the API center.
27-
* You can add API metadata and documentation in your API center to help stakeholders discover, understand, and consume the APIs.
25+
* All APIs, and optionally API definitions, from the API Management instance are added to the API center inventory.
26+
* 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.
2827

29-
After that, API Management APIs automatically synchronize to the API center whenever there are changes detected to existing API properties, 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.
28+
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.
3029

3130
> [!NOTE]
32-
> * Certain properties of API Management APIs such as the name, description, and API definition can't be edited in the API center, and synchronized APIs can't be deleted from your API center.
33-
> * Links to API Management instances are subject to [certain 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 frequency of synchronization.
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.
33+
34+
35+
### Entities synchronized from API Management
36+
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).
38+
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:
40+
41+
| Entity | Read-only properties in API center |
42+
|--------------|--------------------------------------------------------|
43+
| API | • title<br/>• description<br/>• kind |
44+
| API version | • title |
45+
| API definition | N/A |
46+
| Deployment | • server.runtimeUri<br/>• environmentId<br/>• definitionId |
47+
| Environment | • server.type
48+
49+
For property details, see the [API Center REST API reference](/rest/api/resource-manager/apicenter).
50+
3451

3552
## Prerequisites
3653

@@ -44,7 +61,7 @@ After that, API Management APIs automatically synchronize to the API center when
4461
[!INCLUDE [include](~/reusable-content/azure-cli/azure-cli-prepare-your-environment-no-header.md)]
4562

4663
[!INCLUDE [install-apic-extension](includes/install-apic-extension.md)]
47-
64+
Select
4865
> [!NOTE]
4966
> Azure CLI command examples in this article can run in PowerShell or a bash shell. Where needed because of different variable syntax, separate command examples are provided for the two shells.
5067

@@ -59,27 +76,35 @@ After that, API Management APIs automatically synchronize to the API center when
5976

6077
## Link an API Management instance
6178

62-
You can create a link to an API Management in the portal.
79+
You can create a link to an API Management instance using the portal.
6380

6481
#### [Portal](#tab/portal)
6582

6683
1. In the [portal](https://portal.azure.com), navigate to your API center.
6784
1. Under **Assets**, select **Environments**.
6885
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.
89+
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.
91+
1. Select **Create**.
92+
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.":::
6994

70-
A link is added in the list of links. The API Management APIs are imported to the API center inventory and an environment is created.
95+
A linked environment is added in your API center. The API Management APIs are imported to the API center inventory.
7196

7297
:::image type="content" source="media/synchronize-api-management-apis/environment-link-list.png" alt-text="Screenshot of link to API Management in the portal.":::
7398
---
7499

75100
## Unlink an API Management instance
76101

77-
You can delete a link to an API Management instance. When you unlink an API Management instance from your API center:
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:
78103

79-
* All the APIs in the inventory from API Management are deleted
104+
* All the API Management APIs in your API center inventory are deleted
80105
* The environment associated with the API Management instance is deleted
81106

82-
To delete a link:
107+
To unlink an API Management instance:
83108

84109
1. In the [portal](https://portal.azure.com), navigate to your API center.
85110
1. Under **Assets**, select **Environments** > **Links (preview)**.

0 commit comments

Comments
 (0)