Skip to content

Commit 06a4945

Browse files
authored
Merge pull request #292296 from dlepow/awsc
[APIC] AWS API sync
2 parents cc8993b + 949da43 commit 06a4945

12 files changed

+326
-87
lines changed

.github/workflows/stale.yml

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

articles/api-center/TOC.yml

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,12 @@
3838
href: manage-apis-azure-cli.md
3939
- name: Import APIs from API Management
4040
href: import-api-management-apis.md
41-
- name: Synchronize APIs from API Management
42-
href: synchronize-api-management-apis.md
41+
- name: Integrate API sources
42+
items:
43+
- name: Synchronize APIs from API Management
44+
href: synchronize-api-management-apis.md
45+
- name: Synchronize APIs from Amazon API Gateway
46+
href: synchronize-aws-gateway-apis.md
4347
- name: Build and register APIs - VS Code extension
4448
href: build-register-apis-vscode-extension.md
4549
- name: Register APIs - GitHub Actions

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ author: dlepow
77

88
ms.service: azure-api-center
99
ms.topic: include
10-
ms.date: 11/07/2024
10+
ms.date: 01/09/2025
1111
ms.author: danlep
1212
ms.custom: Include file
1313
---

articles/api-center/includes/configure-managed-identity-apim-reader.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ To allow import of APIs, assign your API center's managed identity the **API Man
1919
1. In the left menu, select **Access control (IAM)**.
2020
1. Select **+ Add role assignment**.
2121
1. On the **Add role assignment** page, set the values as follows:
22-
1. On the **Role** tab - Select **API Management Service Reader**.
22+
1. On the **Role** tab, select **API Management Service Reader**.
2323
1. On the **Members** tab, in **Assign access to** - Select **Managed identity** > **+ Select members**.
24-
1. On the **Select managed identities** page - Select the system-assigned managed identity of your API center that you added in the previous section. Click **Select**.
24+
1. On the **Select managed identities** page, select the system-assigned managed identity of your API center that you added in the previous section. Click **Select**.
2525
1. Select **Review + assign**.
2626

2727
#### [Azure CLI](#tab/cli)
Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
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: 12/20/2024
10+
ms.author: danlep
11+
ms.custom: Include file
12+
---
13+
14+
To allow import of APIs, assign your API center's managed identity the **Key Vault Secrets User** role in your Azure key vault. You can use the [portal](../../role-based-access-control/role-assignments-portal-managed-identity.yml) or the Azure CLI.
15+
16+
#### [Portal](#tab/portal)
17+
18+
1. In the [portal](https://azure.microsoft.com), navigate to your key vault.
19+
1. In the left menu, select **Access control (IAM)**.
20+
1. Select **+ Add role assignment**.
21+
1. On the **Add role assignment** page, set the values as follows:
22+
1. On the **Role** tab, select **Key Vault Secrets User**.
23+
1. On the **Members** tab, in **Assign access to** - Select **Managed identity** > **+ Select members**.
24+
1. On the **Select managed identities** page, select the system-assigned managed identity of your API center that you added in the previous section. Click **Select**.
25+
1. Select **Review + assign**.
26+
27+
#### [Azure CLI](#tab/cli)
28+
29+
1. Get the principal ID of the identity. For a system-assigned identity, use the [az apic show](/cli/azure/apic#az-apic-show) command.
30+
31+
```azurecli
32+
#! /bin/bash
33+
apicObjID=$(az apic show --name <api-center-name> \
34+
--resource-group <resource-group-name> \
35+
--query "identity.principalId" --output tsv)
36+
```
37+
38+
```azurecli
39+
# Formatted for PowerShell
40+
$apicObjID=$(az apic show --name <api-center-name> `
41+
--resource-group <resource-group-name> `
42+
--query "identity.principalId" --output tsv)
43+
```
44+
45+
1. Get the resource ID of your key vault using the [az keyvault show](/cli/azure/keyvault#az-keyvault-show) command.
46+
47+
```azurecli
48+
#! /bin/bash
49+
kvID=$(az keyvault show --name <kv-name> --resource-group <resource-group-name> --query "id" --output tsv)
50+
```
51+
52+
```azurecli
53+
# Formatted for PowerShell
54+
$kvID=$(az keyvault show --name <kv-name> --resource-group <resource-group-name> --query "id" --output tsv)
55+
```
56+
57+
1. Assign the managed identity the **Key Vault Secrets User** role in your key vault the [az role assignment create](/cli/azure/role/assignment#az-role-assignment-create) command.
58+
59+
```azurecli
60+
#! /bin/bash
61+
scope="${kvID:1}"
62+
63+
az role assignment create \
64+
--role "Key Vault Secrets User" \
65+
--assignee-object-id $apicObjID \
66+
--assignee-principal-type ServicePrincipal \
67+
--scope $scope
68+
```
69+
70+
```azurecli
71+
# Formatted for PowerShell
72+
$scope=$apimID.substring(1)
73+
74+
az role assignment create `
75+
--role "Key Vault Secrets User" `
76+
--assignee-object-id $apicObjID `
77+
--assignee-principal-type ServicePrincipal `
78+
--scope $scope
79+
---
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
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/21/2025
10+
ms.author: danlep
11+
ms.custom: Include file
12+
---
13+
14+
## Delete an integration
15+
16+
While an API source 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:
17+
18+
* The synchronized APIs in your API center inventory are deleted
19+
* The environment and deployments associated with the API source are deleted
20+
21+
You can delete an integration using the portal or the Azure CLI.
22+
23+
#### [Portal](#tab/portal)
24+
25+
1. In the [portal](https://portal.azure.com), navigate to your API center.
26+
1. Under **Assets**, select **Environments** > **Links (preview)**.
27+
1. Select the link, and then select **Delete** (trash can icon).
28+
29+
#### [Azure CLI](#tab/cli)
30+
31+
Run the [az apic integration delete](/cli/azure/apic/integration#az-apic-integration-delete) (preview) command to delete an integration. Provide the names of the resource group, API center, and integration.
32+
33+
```azurecli
34+
az apic integration delete \
35+
--resource-group <resource-group-name> \
36+
--service-name <api-center-name> \
37+
--integration-name <integration-name> \
38+
```
39+
---

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

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,16 @@ author: dlepow
66

77
ms.service: azure-api-center
88
ms.topic: include
9-
ms.date: 10/18/2024
9+
ms.date: 12/20/2024
1010
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 APIs in your API Management instance. 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

articles/api-center/includes/install-apic-extension.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,4 @@ ms.custom: Include file
1414
> [!NOTE]
1515
> `az apic` commands require the `apic-extension` Azure CLI extension. If you haven't used `az apic` commands, the extension can be installed dynamically when you run your first `az apic` command, or you can install the extension manually. Learn more about [Azure CLI extensions](/cli/azure/azure-cli-extensions-overview).
1616
>
17-
> See the [release notes](https://github.com/Azure/azure-cli-extensions/blob/main/src/apic-extension/HISTORY.rst) for the latest changes and updates in the `apic-extension`.
17+
> See the [release notes](https://github.com/Azure/azure-cli-extensions/blob/main/src/apic-extension/HISTORY.rst) for the latest changes and updates in the `apic-extension`. Certain features may require a preview or specific version of the extension.
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
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/08/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 set based on their values in the API source.
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+
> [!NOTE]
25+
> Resource and system IDs for entities synchronized to Azure API Center are automatically generated and can't be changed.
82.6 KB
Loading

0 commit comments

Comments
 (0)