Skip to content

Commit 622c403

Browse files
author
gitName
committed
draft complete
1 parent fe89c26 commit 622c403

File tree

5 files changed

+64
-86
lines changed

5 files changed

+64
-86
lines changed

.github/workflows/stale.yml

Lines changed: 0 additions & 37 deletions
This file was deleted.

articles/api-center/includes/enable-managed-identity.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,11 @@ ms.author: danlep
1111
ms.custom: Include file
1212
---
1313

14-
For this scenario, your API center uses a [managed identity](/entra/identity/managed-identities-azure-resources/overview) to access Azure resources. Depending on your needs, configure either a system-assigned or one or more user-assigned managed identities.
14+
## Enable a managed identity in your API center
1515

16-
The following examples show how to configure a system-assigned managed identity by using the Azure portal or the Azure CLI. At a high level, configuration steps are similar for a user-assigned managed identity.
16+
For this scenario, your API center uses a [managed identity](/entra/identity/managed-identities-azure-resources/overview) to access Azure resources. Depending on your needs, enable either a system-assigned or one or more user-assigned managed identities.
17+
18+
The following examples show how to enable a system-assigned managed identity by using the Azure portal or the Azure CLI. At a high level, configuration steps are similar for a user-assigned managed identity.
1719

1820
#### [Portal](#tab/portal)
1921

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
title: Include file
3+
description: Include file
4+
services: api-center
5+
author: dlepow
6+
7+
ms.service: azure-api-center
8+
ms.topic: include
9+
ms.date: 01/02/2025
10+
ms.author: danlep
11+
ms.custom: Include file
12+
---
13+
You can add or update metadata properties and documentation to the synchronized APIs in your API center to help stakeholders discover, understand, and consume the APIs. Learn more about Azure API Center's [built-in and custom metadata properties](add-metadata-properties.md).
14+
15+
The following table shows entity properties that can be modified in Azure API Center and properties that are determined based on their values in an integrated API source. Also, entities' resource or system identifiers in Azure API Center are generated automatically and can't be modified.
16+
17+
| Entity | Properties configurable in API Center | Properties determined in integrated API source |
18+
|--------------|-----------------------------------------|-----------------|
19+
| API | summary<br/>lifecycleStage<br/>termsOfService<br/>license<br/>externalDocumentation<br/>customProperties | title<br/>description<br/>kind |
20+
| API version | lifecycleStage | title<br/>definitions (if synchronized) |
21+
| Environment | title<br/>description<br/>kind</br>server.managementPortalUri<br/>onboarding<br/>customProperties | server.type
22+
| Deployment | title<br/>description<br/>server<br/>state<br/>customProperties | server.runtimeUri |
23+
24+
For property details, see the [Azure API Center REST API reference](/rest/api/apicenter).

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

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Integrate an API Management instance to Azure API Center for automa
44
author: dlepow
55
ms.service: azure-api-center
66
ms.topic: how-to
7-
ms.date: 12/23/2024
7+
ms.date: 01/02/2025
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 with my API center and synchronize API Management APIs to my inventory.
@@ -14,9 +14,9 @@ ms.custom: devx-track-azurecli
1414

1515
This article shows how to integrate an API Management instance so that the instances's APIs are continuously kept up to date in your [API center](overview.md) inventory.
1616

17-
## About integrate an API Management instance
17+
## About integrating an API Management instance
1818

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, integrate an API Management instance enables continuous synchronization so that the API inventory stays up to date.
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, integrate an API Management instance enables continuous synchronization so that the API inventory stays up to date. Azure API Center can also synchronize APIs from sources including [Amazon API Gateway](synchronize-aws-gateway-apis.md).
2020

2121
When you integrate an API Management instance as an API source, the following happens:
2222

@@ -32,19 +32,7 @@ API Management APIs automatically synchronize to the API center whenever existin
3232
3333
### Entities synchronized from API Management
3434

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).
36-
37-
The following table shows entity properties that can be modified in Azure API Center and properties that are determined based on their values in an integrated Azure API Management instance. Also, entities' resource or system identifiers in Azure API Center are generated automatically and can't be modified.
38-
39-
| Entity | Properties configurable in API Center | Properties determined in 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<br/>definitions (if synchronized) |
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 |
45-
46-
For property details, see the [Azure API Center REST API reference](/rest/api/apicenter).
47-
35+
[!INCLUDE [synchronized-properties-api-source](includes/synchronized-properties-api-source.md)]
4836

4937
## Prerequisites
5038

@@ -60,9 +48,6 @@ For property details, see the [Azure API Center REST API reference](/rest/api/ap
6048
> [!NOTE]
6149
> 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.
6250
63-
64-
## Add a managed identity in your API center
65-
6651
[!INCLUDE [enable-managed-identity](includes/enable-managed-identity.md)]
6752

6853
## Assign the managed identity the API Management Service Reader role
@@ -71,20 +56,35 @@ For property details, see the [Azure API Center REST API reference](/rest/api/ap
7156

7257
## Integrate an API Management instance
7358

74-
You can integrate an API Management instance using the portal.
59+
You can integrate an API Management instance using the portal or the Azure CLI.
60+
61+
#### [Portal](#tab/portal)
7562

7663
1. In the [portal](https://portal.azure.com), navigate to your API center.
7764
1. Under **Assets**, select **Environments**.
7865
1. Select **Integrations (preview)** > **+ New integration** > **From Azure API Management**.
7966
1. In the **Integrate your Azure API Management Service** page:
8067
1. Select the **Subscription**, **Resource group**, and **Azure API Management service** that you want to integrate.
8168
1. In **Integration details**, enter an identifier.
82-
1. In **Environment details**, enter an **Environment title** (name), **Environment type**, and optional **Environment description**.
83-
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.
69+
1. In **Environment details**, enter an **Environment title** (name), **Environment type**, and optional **Description**.
70+
1. In **API Details**:
71+
1. Select a **Lifecycle** for the synchronized APIs. (You can update this value for the APIs after they're added to your API center.)
72+
1. Optionally, select whether to include API definitions with the synchronized APIs.
8473
1. Select **Create**.
8574

8675
:::image type="content" source="media/synchronize-api-management-apis/link-api-management-service.png" alt-text="Screenshot of integrating an Azure API Management Service in the portal.":::
8776

77+
#### [Azure CLI](#tab/cli)
78+
79+
Run the `az apic integration create apim` command to integrate an API Management instance to your API center. Provide the... If the API Management instance and the API center are in the same resource group, you can provide the API Management instance name as the value of `azure-apim`; otherwise, provide the Azure resource ID.
80+
81+
```azurecli
82+
az apic integration create apim --name <api-center-name> \
83+
--integration-name <apim-integration-name> \
84+
--azure-apim <apim-instance-name>
85+
```
86+
---
87+
8888
The environment is added in your API center. The API Management APIs are imported to the API center inventory.
8989

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

articles/api-center/synchronize-aws-gateway-apis.md

Lines changed: 14 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -4,47 +4,37 @@ description: Integrate an Amazon API Gateway to Azure API Center for automatic s
44
author: dlepow
55
ms.service: azure-api-center
66
ms.topic: how-to
7-
ms.date: 12/23/2024
7+
ms.date: 01/02/2025
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 with my API center and synchronize API Management APIs to my inventory.
1111
---
1212

1313
# Synchronize APIs from Amazon API Gateway to Azure API Center (preview)
1414

15-
This article shows how to integrate an Amazon API Gateway so that the gateway's APIs are continuously kept up to date in your [API center](overview.md) inventory.
15+
This article shows how to integrate an Amazon API Gateway so that the gateway's APIs are continuously kept up to date in your [API center](overview.md) inventory.
1616

1717
## About integrating Amazon API Gateway
1818

19-
Integrating Amazon API Gateway as an API source for your API center enables continuous synchronization so that the API inventory stays up to date.
19+
Integrating Amazon API Gateway as an API source for your API center enables continuous synchronization so that the API inventory stays up to date. Azure API Center can also synchronize APIs from sources including [Azure API Management](synchronize-api-management-apis.md).
2020

2121
When you integrate an Amazon API Gateway as an API source, the following happens:
2222

2323
1. APIs, and optionally API definitions (specs), from the API Gateway are added to the API center inventory.
2424
1. You configure an [environment](key-concepts.md#environment) of type *Amazon API Gateway* in the API center.
2525
1. An associated [deployment](key-concepts.md#deployment) is created for each synchronized API definition.
2626

27-
Synchronization is one-way from Amazon API Gateway to your Azure API center, meaning API updates in the API center aren't synchronized back to the API Gateway.
27+
Synchronization is one-way from Amazon API Gateway to your Azure API center, meaning API updates in the API center aren't synchronized back to Amazon API Gateway.
2828

2929
> [!NOTE]
30+
> * Integration of Amazon API Gateway is currently in preview.
3031
> * 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 integrated API sources.
31-
> * APIs in your Amazon API Gateway synchronize to your API center once per hour.
32+
> * API updates in Amazon API Gateway synchronize to your API center once per hour.
33+
> * API definitions are also synchronized to the API center only if you select the option to include them during integration. Only definitions from deployed APIs are synchronized.
3234
3335
### Entities synchronized from Amazon API Gateway
3436

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).
36-
37-
The following table shows entity properties that can be modified in Azure API Center and properties that are determined based on their values in Amazon API Gateway. Also, entities' resource or system identifiers in Azure API Center are generated automatically and can't be modified.
38-
39-
| Entity | Properties configurable in API Center | Properties determined in Amazon API Gateway |
40-
|--------------|-----------------------------------------|-----------------|
41-
| API | summary<br/>lifecycleStage<br/>termsOfService<br/>license<br/>externalDocumentation<br/>customProperties | title<br/>description<br/>kind |
42-
| API version | lifecycleStage | title<br/>definitions (if synchronized) |
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 |
45-
46-
For property details, see the [Azure API Center REST API reference](/rest/api/apicenter).
47-
37+
[!INCLUDE [synchronized-properties-api-source](includes/synchronized-properties-api-source.md)]
4838

4939
## Prerequisites
5040

@@ -66,7 +56,7 @@ For property details, see the [Azure API Center REST API reference](/rest/api/ap
6656
6757
## Create IAM user access keys
6858

69-
To authenticate your API center with Amazon API Gateway, you need access keys for an AWS IAM user.
59+
To authenticate your API center to Amazon API Gateway, you need access keys for an AWS IAM user.
7060

7161
To generate the required access key ID and secret key using the AWS Management Console, see [Create an access key for yourself](https://docs.aws.amazon.com/IAM/latest/UserGuide/access-key-self-managed.html#Using_CreateAccessKey) in the AWS documentation.
7262

@@ -87,8 +77,6 @@ Manually upload and securely store the two IAM user access keys in Azure Key Vau
8777
Take note of the **Secret identifier** URI of each secret. You'll use these identifiers in the next steps.
8878

8979

90-
## Add a managed identity in your API center
91-
9280
[!INCLUDE [enable-managed-identity](includes/enable-managed-identity.md)]
9381

9482
## Assign the managed identity the Key Vault Secrets User role
@@ -108,13 +96,14 @@ You can integrate an Amazon API Gateway to your API center using the portal or t
10896
1. In the **Integrate your Amazon API Gateway service** page:
10997
1. Under **Configure AWS credentials using Azure Key Vault**, enter or select the Key Vault secret identifiers for the **AWS access key** and **AWS secret access key** you stored previously. Also, select the **AWS region** where the Amazon API Gateway is deployed.
11098
1. In **Integration details**, enter an identifier.
111-
1. In **Environment details**, enter an **Environment title** (name), **Environment type**, and optional **Environment description**.
112-
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.
99+
1. In **Environment details**, enter an **Environment title** (name), **Environment type**, and optional **Description**.
100+
1. In **API Details**:
101+
1. Select a **Lifecycle** for the synchronized APIs. (You can update this value for the APIs after they're added to your API center.)
102+
1. Optionally, select whether to include API definitions.
113103
1. Select **Create**.
114104

115105
<!----
116-
:::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.":::
117-
106+
Add image of integrating AWS g/w?
118107
--->
119108

120109
#### [Azure CLI](#tab/cli)

0 commit comments

Comments
 (0)