Skip to content

Commit b58cc5b

Browse files
author
gitName
committed
rough draft complete
1 parent 0f4555a commit b58cc5b

File tree

4 files changed

+70
-81
lines changed

4 files changed

+70
-81
lines changed

articles/api-center/includes/configure-managed-identity-kv-secret-user.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -42,16 +42,16 @@ To allow import of APIs, assign your API center's managed identity the **Key Vau
4242
--query "identity.principalId" --output tsv)
4343
```
4444
45-
1. Get the resource ID of your key vault using the [az apim show](/cli/azure/apim#az-apim-show) command. [UPDATE THIS COMMAND]
45+
1. Get the resource ID of your key vault using the [az keyvault show](/cli/azure/keyvault#az-keyvault-show) command.
4646
4747
```azurecli
4848
#! /bin/bash
49-
kvID=$(az apim show --name <apim-name> --resource-group <resource-group-name> --query "id" --output tsv)
49+
kvID=$(az keyvault show --name <kv-name> --resource-group <resource-group-name> --query "id" --output tsv)
5050
```
5151
5252
```azurecli
5353
# Formatted for PowerShell
54-
$kvID=$(az apim show --name <apim-name> --resource-group <resource-group-name> --query "id" --output tsv)
54+
$kvID=$(az keyvault show --name <kv-name> --resource-group <resource-group-name> --query "id" --output tsv)
5555
```
5656
5757
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
6161
scope="${kvID:1}"
6262
6363
az role assignment create \
64-
--role "Key Vault Secrets User \
64+
--role "Key Vault Secrets User" \
6565
--assignee-object-id $apicObjID \
6666
--assignee-principal-type ServicePrincipal \
6767
--scope $scope
@@ -72,7 +72,7 @@ To allow import of APIs, assign your API center's managed identity the **Key Vau
7272
$scope=$apimID.substring(1)
7373
7474
az role assignment create `
75-
--role "API Management Service Reader Role" `
75+
--role "Key Vault Secrets User" `
7676
--assignee-object-id $apicObjID `
7777
--assignee-principal-type ServicePrincipal `
7878
--scope $scope
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: 12/23/2024
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+
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).

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

Lines changed: 5 additions & 17 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/30/2024
7+
ms.date: 12/23/2024
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.
@@ -39,7 +39,7 @@ The following table shows entity properties that can be modified in Azure API Ce
3939
| Entity | Properties configurable in API Center | Properties determined in API Management |
4040
|--------------|-----------------------------------------|-----------------|
4141
| API | summary<br/>lifecycleStage<br/>termsOfService<br/>license<br/>externalDocumentation<br/>customProperties | title<br/>description<br/>kind |
42-
| API version | lifecycleStage | title |
42+
| API version | lifecycleStage | title<br/>definitions (if synchronized) |
4343
| Environment | title<br/>description<br/>kind</br>server.managementPortalUri<br/>onboarding<br/>customProperties | server.type
4444
| Deployment | title<br/>description<br/>server<br/>state<br/>customProperties | server.runtimeUri |
4545

@@ -75,8 +75,8 @@ You can link an API Management instance using the portal.
7575

7676
1. In the [portal](https://portal.azure.com), navigate to your API center.
7777
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:
8080
1. Select the **Subscription**, **Resource group**, and **Azure API Management service** that you want to link.
8181
1. In **Link details**, enter an identifier.
8282
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
8989

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

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).
92+
[!INCLUDE [delete-api-integration](includes/delete-api-integration.md)]
10593

10694
## Related content
10795

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

Lines changed: 35 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ 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/20/2024
7+
ms.date: 12/23/2024
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.
@@ -28,18 +28,18 @@ Synchronization is one-way from Amazon API Gateway to your Azure API center, mea
2828

2929
> [!NOTE]
3030
> * 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.
3232
3333
### Entities synchronized from Amazon API Gateway
3434

3535
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).
3636

3737
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.
3838

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 |
4040
|--------------|-----------------------------------------|-----------------|
4141
| API | summary<br/>lifecycleStage<br/>termsOfService<br/>license<br/>externalDocumentation<br/>customProperties | title<br/>description<br/>kind |
42-
| API version | lifecycleStage | title |
42+
| API version | lifecycleStage | title<br/>definitions (if synchronized) |
4343
| Environment | title<br/>description<br/>kind</br>server.managementPortalUri<br/>onboarding<br/>customProperties | server.type
4444
| Deployment | title<br/>description<br/>server<br/>state<br/>customProperties | server.runtimeUri |
4545

@@ -68,56 +68,27 @@ For property details, see the [Azure API Center REST API reference](/rest/api/ap
6868

6969
[!INCLUDE [enable-managed-identity](includes/enable-managed-identity.md)]
7070

71-
7271
## Create IAM user access keys
7372

7473
To authenticate your API center with Amazon API Gateway, you need access keys for an AWS IAM user.
7574

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.
7776

7877
Save your access keys in a safe location. You'll store them in Azure Key Vault in the next steps.
7978

8079
> [!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)
8281
8382
## Store IAM user access keys in Azure Key Vault
8483

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).
8685

8786
| AWS secret | Upload options | Name | Secret value |
87+
|------------|----------------|------|--------------|
88+
| Access key | Manual | *aws-access-key* | Access key ID retrieved from AWS |
89+
| Secret access key | Manual | *aws-secret-access-key* | Secret access key retrieved from AWS |
8890

89-
90-
Upload option
91-
92-
Manual
93-
94-
Name
95-
96-
aws-access-key
97-
98-
Secret value
99-
100-
Access key retrieved from AWS
101-
102-
One secret for secret access key:
103-
104-
Upload option
105-
106-
Manual
107-
108-
Name
109-
110-
aws-secret-access-key
111-
112-
Secret value
113-
114-
Secret access key retrieved from AWS
115-
116-
117-
118-
119-
120-
91+
Take note of the **Secret identifier** URI of each secret. You'll use these identifiers in the next steps.
12192

12293

12394
## Add a managed identity in your API center
@@ -126,17 +97,21 @@ Secret access key retrieved from AWS
12697

12798
## Assign the managed identity the Key Vault Secrets User role
12899

129-
[!INCLUDE [configure-managed-identity-apim-reader](includes/configure-managed-identity-apim-reader.md)]
100+
[!INCLUDE [configure-managed-identity-kv-secret-user](includes/configure-managed-identity-kv-secret-user.md)]
101+
130102

131103
## Integrate an Amazon API Gateway
132104

133-
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)
134108

135109
1. In the [portal](https://portal.azure.com), navigate to your API center.
136110
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.
140115
1. In **Environment details**, enter an **Environment title** (name), **Environment type**, and optional **Environment description**.
141116
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.
142117
1. Select **Create**.
@@ -145,27 +120,28 @@ You can integrate an API Gateway using the portal.
145120
:::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.":::
146121
147122
--->
148-
The environment is added in your API center. The API Management APIs are imported to the API center inventory.
149123

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.
153127

154-
## Delete an integration
128+
```azurecli
155129
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> \
131+
--integration-name <aws-integration-name> \
132+
--aws-access-key-reference <access-key-uri> \
133+
--aws-secret-access-key-reference <secret-access-key-uri> \
134+
--aws-region-name <aws-region>
135+
```
136+
---
157137

158-
* The synchronized APIs in your API center inventory are deleted
159-
* The environment and deployments associated with the API source are deleted
160138

161-
To delete an integration:
139+
The environment is added in your API center. The Amazon API Gateway APIs are imported to the API center inventory.
162140

163-
1. In the [portal](https://portal.azure.com), navigate to your API center.
164-
1. Under **Assets**, select **Environments** > **Integration (preview)**.
165-
1. Select the integration, and then select **Delete** (trash can icon).
141+
142+
[!INCLUDE [delete-api-integration](includes/delete-api-integration.md)]
166143

167144
## Related content
168145

169146
* [Manage API inventory with Azure CLI commands](manage-apis-azure-cli.md)
170-
* [Import APIs from API Management to your Azure API center](import-api-management-apis.md)
171-
* [Azure API Management documentation](../api-management/index.yml)
147+
* [Synchronize APIs from API Management to your Azure API center](synchronize-api-management-apis.md)

0 commit comments

Comments
 (0)