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
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.
@@ -61,7 +61,7 @@ To allow import of APIs, assign your API center's managed identity the **Key Vau
61
61
scope="${kvID:1}"
62
62
63
63
az role assignment create \
64
-
--role "Key Vault Secrets User \
64
+
--role "Key Vault Secrets User" \
65
65
--assignee-object-id $apicObjID \
66
66
--assignee-principal-type ServicePrincipal \
67
67
--scope $scope
@@ -72,7 +72,7 @@ To allow import of APIs, assign your API center's managed identity the **Key Vau
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
+
To delete an integration:
22
+
23
+
1. In the [portal](https://portal.azure.com), navigate to your API center.
24
+
1. Under **Assets**, select **Environments** > **Integration (preview)**.
25
+
1. Select the integration, and then select **Delete** (trash can icon).
Copy file name to clipboardExpand all lines: articles/api-center/synchronize-api-management-apis.md
+5-17Lines changed: 5 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ description: Link an API Management instance 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: 10/30/2024
7
+
ms.date: 12/23/2024
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.
@@ -39,7 +39,7 @@ The following table shows entity properties that can be modified in Azure API Ce
39
39
| Entity | Properties configurable in API Center | Properties determined in API Management |
@@ -75,8 +75,8 @@ You can link an API Management instance using the portal.
75
75
76
76
1. In the [portal](https://portal.azure.com), navigate to your API center.
77
77
1. Under **Assets**, select **Environments**.
78
-
1. Select **Links (preview)** > **+ New link**.
79
-
1. In the **Link your Azure API Management Service** page:
78
+
1. Select **Integrations (preview)** > **+ New integration** > **From Azure API Management**.
79
+
1. In the **Integrate your Azure API Management Service** page:
80
80
1. Select the **Subscription**, **Resource group**, and **Azure API Management service** that you want to link.
81
81
1. In **Link details**, enter an identifier.
82
82
1. In **Environment details**, enter an **Environment title** (name), **Environment type**, and optional **Environment description**.
@@ -89,19 +89,7 @@ The environment is added in your API center. The API Management APIs are importe
89
89
90
90
:::image type="content" source="media/synchronize-api-management-apis/environment-link-list.png" alt-text="Screenshot of environment list in the portal.":::
91
91
92
-
93
-
## Delete a link
94
-
95
-
While an API Management instance is linked, you can't delete synchronized APIs from your API center. If you need to, you can delete the link. When you delete a link:
96
-
97
-
* The synchronized API Management APIs in your API center inventory are deleted
98
-
* The environment and deployments associated with the API Management instance are deleted
99
-
100
-
To delete an API Management link:
101
-
102
-
1. In the [portal](https://portal.azure.com), navigate to your API center.
103
-
1. Under **Assets**, select **Environments** > **Link (preview)**.
104
-
1. Select the link, and then select **Delete** (trash can icon).
Copy file name to clipboardExpand all lines: articles/api-center/synchronize-aws-gateway-apis.md
+35-59Lines changed: 35 additions & 59 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: 12/20/2024
7
+
ms.date: 12/23/2024
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.
@@ -28,18 +28,18 @@ Synchronization is one-way from Amazon API Gateway to your Azure API center, mea
28
28
29
29
> [!NOTE]
30
30
> * 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
-
> *API updates in Amazon API Gateway synchronize to your API center every hour.
31
+
> *APIs in your Amazon API Gateway synchronize to your API center once per hour.
32
32
33
33
### Entities synchronized from Amazon API Gateway
34
34
35
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
36
37
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
38
39
-
| Entity | Properties configurable in API Center | Properties determined in API Gateway |
39
+
| Entity | Properties configurable in API Center | Properties determined in Amazon API Gateway |
To authenticate your API center with Amazon API Gateway, you need access keys for an AWS IAM user.
75
74
76
-
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).
75
+
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.
77
76
78
77
Save your access keys in a safe location. You'll store them in Azure Key Vault in the next steps.
79
78
80
79
> [!CAUTION]
81
-
> Access keys are long-term credentials and you should manage them as securely as you would a password. Learn more about [securing access keys](https://docs.aws.amazon.com/IAM/latest/UserGuide/securing_access-keys.html)
80
+
> Access keys are long-term credentials, and you should manage them as securely as you would a password. Learn more about [securing access keys](https://docs.aws.amazon.com/IAM/latest/UserGuide/securing_access-keys.html)
82
81
83
82
## Store IAM user access keys in Azure Key Vault
84
83
85
-
Manually upload and securely store the two IAM user access keys in Azure Key Vault using the configuration 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).
84
+
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).
86
85
87
86
| AWS secret | Upload options | Name | Secret value |
You can integrate an API Gateway using the portal.
105
+
You can integrate an Amazon API Gateway to your API center using the portal or the Azure CLI.
106
+
107
+
#### [Portal](#tab/portal)
134
108
135
109
1. In the [portal](https://portal.azure.com), navigate to your API center.
136
110
1. Under **Assets**, select **Environments**.
137
-
1. Select **Integrations (preview)** > **+ New integration**.
138
-
1. In the **Link your Azure API Gateway** page:
139
-
1. TBD...
111
+
1. Select **Integrations (preview)** > **+ New integration** > **From Amazon API Gateway**.
112
+
1. In the **Integrate your Amazon API Gateway service** page:
113
+
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.
114
+
1. In **Integration details**, enter an identifier.
140
115
1. In **Environment details**, enter an **Environment title** (name), **Environment type**, and optional **Environment description**.
141
116
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.
142
117
1. Select **Create**.
@@ -145,27 +120,28 @@ You can integrate an API Gateway using the portal.
145
120
:::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.":::
146
121
147
122
--->
148
-
The environment is added in your API center. The API Management APIs are imported to the API center inventory.
149
123
150
-
<!--
151
-
:::image type="content" source="media/synchronize-api-management-apis/environment-link-list.png" alt-text="Screenshot of environment list in the portal.":::
152
-
-->
124
+
#### [Azure CLI](#tab/cli)
125
+
126
+
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.
153
127
154
-
## Delete an integration
128
+
```azurecli
155
129
156
-
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:
130
+
az apic integration create aws --name <api-center-name> \
0 commit comments