You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/api-center/includes/configure-managed-identity-apim-reader.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,9 +19,9 @@ To allow import of APIs, assign your API center's managed identity the **API Man
19
19
1. In the left menu, select **Access control (IAM)**.
20
20
1. Select **+ Add role assignment**.
21
21
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**.
23
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**.
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**.
Copy file name to clipboardExpand all lines: articles/api-center/includes/configure-managed-identity-kv-secret-user.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,9 +19,9 @@ To allow import of APIs, assign your API center's managed identity the **Key Vau
19
19
1. In the left menu, select **Access control (IAM)**.
20
20
1. Select **+ Add role assignment**.
21
21
1. On the **Add role assignment** page, set the values as follows:
22
-
1. On the **Role** tab - Select**Key Vault Secrets User**.
22
+
1. On the **Role** tab, select**Key Vault Secrets User**.
23
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**.
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**.
Copy file name to clipboardExpand all lines: articles/api-center/includes/install-apic-extension.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,4 +14,4 @@ ms.custom: Include file
14
14
> [!NOTE]
15
15
> `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).
16
16
>
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 specific version of the extension.
Copy file name to clipboardExpand all lines: articles/api-center/includes/synchronized-properties-api-source.md
+4-3Lines changed: 4 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,13 +6,13 @@ author: dlepow
6
6
7
7
ms.service: azure-api-center
8
8
ms.topic: include
9
-
ms.date: 01/02/2025
9
+
ms.date: 01/08/2025
10
10
ms.author: danlep
11
11
ms.custom: Include file
12
12
---
13
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
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.
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 an integrated API source.
16
16
17
17
| Entity | Properties configurable in API Center | Properties determined in integrated API source |
Copy file name to clipboardExpand all lines: articles/api-center/synchronize-api-management-apis.md
+10-2Lines changed: 10 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -27,8 +27,10 @@ When you integrate an API Management instance as an API source, the following ha
27
27
API Management APIs automatically synchronize to the API center whenever existing APIs' settings change (for example, 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
28
29
29
> [!NOTE]
30
+
> * Integration of Azure API Management is currently in preview.
30
31
> * 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 Management instances (API sources).
31
32
> * API updates in API Management typically synchronize to your API center within minutes but synchronization can take up to 24 hours.
33
+
> * API definitions also synchronize to the API center if you select the option to include them during integration.
32
34
33
35
### Entities synchronized from API Management
34
36
@@ -76,10 +78,16 @@ You can integrate an API Management instance using the portal or the Azure CLI.
76
78
77
79
#### [Azure CLI](#tab/cli)
78
80
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.
81
+
Run the `az apic integration create apim` command to integrate an API Management instance to your API center.
82
+
83
+
* Provide the names of the resource group, API center, and integration.
84
+
85
+
* 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
86
81
87
```azurecli
82
-
az apic integration create apim --name <api-center-name> \
Copy file name to clipboardExpand all lines: articles/api-center/synchronize-aws-gateway-apis.md
+23-12Lines changed: 23 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ description: Integrate an Amazon API Gateway to Azure API Center for automatic s
4
4
author: dlepow
5
5
ms.service: azure-api-center
6
6
ms.topic: how-to
7
-
ms.date: 01/02/2025
7
+
ms.date: 01/08/2025
8
8
ms.author: danlep
9
9
ms.custom: devx-track-azurecli
10
10
# 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.
@@ -29,8 +29,8 @@ Synchronization is one-way from Amazon API Gateway to your Azure API center, mea
29
29
> [!NOTE]
30
30
> * Integration of Amazon API Gateway is currently in preview.
31
31
> * 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.
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.
32
+
> *APIs in Amazon API Gateway synchronize to your API center once per hour. Only REST APIs are synchronized.
33
+
> * API definitions also synchronize to the API center if you select the option to include them during integration. Only definitions from deployed APIs are synchronized.
34
34
35
35
### Entities synchronized from Amazon API Gateway
36
36
@@ -40,7 +40,7 @@ Synchronization is one-way from Amazon API Gateway to your Azure API center, mea
40
40
41
41
* An API center in your Azure subscription. If you haven't created one, see [Quickstart: Create your API center](set-up-api-center.md).
42
42
43
-
* An Azure key vault. If you need to create one, see [Quickstart: Create a key vault using the Azure portal](/azure/key-vault/general/quick-create-portal).
43
+
* An Azure key vault. If you need to create one, see [Quickstart: Create a key vault using the Azure portal](/azure/key-vault/general/quick-create-portal). To add or manage secrets in the key vault, at least the **Key Vault Secrets Officer** role or equivalent permissions are required.
44
44
45
45
* An [Amazon API Gateway](https://docs.aws.amazon.com/apigateway/).
46
46
@@ -69,12 +69,18 @@ Save your access keys in a safe location. You'll store them in Azure Key Vault i
69
69
70
70
Manually upload and securely store the two IAM user access keys in Azure Key Vault using the configuration recommended in the following table. For more information, see [Quickstart: Set and retrieve a secret from Azure Key Vault using the Azure portal](/azure/key-vault/secrets/quick-create-portal).
71
71
72
+
#### [Portal](#tab/portal)
73
+
72
74
| AWS secret | Upload options | Name | Secret value |
Take note of the **Secret identifier** URI of each secret. You'll use these identifiers in the next steps.
79
+
:::image type="content" source="media/synchronize-aws-gateway-apis/key-vault-secrets.png" alt-text="Screenshot of secrets list in Azure Key Vault in the portal.":::
80
+
81
+
---
82
+
83
+
Take note of the **Secret identifier** of each secret, a URI similar to `https://<key-vault-name>.vault.azure.net/secrets/<secret-nam>.`. You'll use these identifiers in the next steps.
@@ -86,8 +92,9 @@ Take note of the **Secret identifier** URI of each secret. You'll use these iden
86
92
87
93
## Integrate an Amazon API Gateway
88
94
89
-
You can integrate an Amazon API Gateway to your API center using the portal or the Azure CLI.
95
+
You can integrate an Amazon API Gateway to your API center using the Azure CLI.
90
96
97
+
<!--
91
98
#### [Portal](#tab/portal)
92
99
93
100
1. In the [portal](https://portal.azure.com), navigate to your API center.
@@ -102,20 +109,24 @@ You can integrate an Amazon API Gateway to your API center using the portal or t
102
109
1. Optionally, select whether to include API definitions.
103
110
1. Select **Create**.
104
111
105
-
<!----
106
-
Add image of integrating AWS g/w?
112
+
Add image of integrating AWS g/w in portal
107
113
--->
108
114
109
115
#### [Azure CLI](#tab/cli)
110
116
111
-
Run the `az apic integration create aws` command to integrate an Amazon API Gateway to your API center. Provide the Key Vault secret identifiers for the AWS access key and secret access key, and the AWS region where the Amazon API Gateway is deployed.
117
+
Run the `az apic integration create aws` command to integrate an Amazon API Gateway to your API center.
112
118
113
-
```azurecli
119
+
* Provide the names of the resource group, API center, and integration.
114
120
115
-
az apic integration create aws --name <api-center-name> \
121
+
* Provide the Key Vault secret identifiers for the AWS access key and secret access key, and the AWS region where the Amazon API Gateway is deployed.
0 commit comments