Skip to content

Commit c7ce625

Browse files
author
gitName
committed
review comments
1 parent 113216b commit c7ce625

8 files changed

+58
-24
lines changed

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)

articles/api-center/includes/configure-managed-identity-kv-secret-user.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 **Key Vau
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 **Key Vault Secrets User**.
22+
1. On the **Role** tab, select **Key Vault Secrets User**.
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)

articles/api-center/includes/delete-api-integration.md

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

77
ms.service: azure-api-center
88
ms.topic: include
9-
ms.date: 12/23/2024
9+
ms.date: 01/08/2025
1010
ms.author: danlep
1111
ms.custom: Include file
1212
---
@@ -18,8 +18,22 @@ While an API source is integrated, you can't delete synchronized APIs from your
1818
* The synchronized APIs in your API center inventory are deleted
1919
* The environment and deployments associated with the API source are deleted
2020

21-
To delete an integration:
21+
You can delete an integration using the portal or the Azure CLI.
22+
23+
#### [Portal](#tab/portal)
2224

2325
1. In the [portal](https://portal.azure.com), navigate to your API center.
2426
1. Under **Assets**, select **Environments** > **Integration (preview)**.
2527
1. Select the integration, and then select **Delete** (trash can icon).
28+
29+
#### [Azure CLI](#tab/cli)
30+
31+
Run the `az apic integration delete` 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/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 specific version of the extension.

articles/api-center/includes/synchronized-properties-api-source.md

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

77
ms.service: azure-api-center
88
ms.topic: include
9-
ms.date: 01/02/2025
9+
ms.date: 01/08/2025
1010
ms.author: danlep
1111
ms.custom: Include file
1212
---
1313
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).
1414

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

1717
| Entity | Properties configurable in API Center | Properties determined in integrated API source |
1818
|--------------|-----------------------------------------|-----------------|
@@ -21,4 +21,5 @@ The following table shows entity properties that can be modified in Azure API Ce
2121
| Environment | title<br/>description<br/>kind</br>server.managementPortalUri<br/>onboarding<br/>customProperties | server.type
2222
| Deployment | title<br/>description<br/>server<br/>state<br/>customProperties | server.runtimeUri |
2323

24-
For property details, see the [Azure API Center REST API reference](/rest/api/apicenter).
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

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

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,10 @@ When you integrate an API Management instance as an API source, the following ha
2727
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.
2828

2929
> [!NOTE]
30+
> * Integration of Azure API Management 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 Management instances (API sources).
3132
> * 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.
3234
3335
### Entities synchronized from API Management
3436

@@ -76,10 +78,16 @@ You can integrate an API Management instance using the portal or the Azure CLI.
7678

7779
#### [Azure CLI](#tab/cli)
7880

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

8187
```azurecli
82-
az apic integration create apim --name <api-center-name> \
88+
az apic integration create apim \
89+
--resource-group <resource-group-name> \
90+
--service-name <api-center-name> \
8391
--integration-name <apim-integration-name> \
8492
--azure-apim <apim-instance-name>
8593
```

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

Lines changed: 23 additions & 12 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: 01/02/2025
7+
ms.date: 01/08/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.
@@ -29,8 +29,8 @@ Synchronization is one-way from Amazon API Gateway to your Azure API center, mea
2929
> [!NOTE]
3030
> * Integration of Amazon API Gateway is currently in preview.
3131
> * 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.
3434
3535
### Entities synchronized from Amazon API Gateway
3636

@@ -40,7 +40,7 @@ Synchronization is one-way from Amazon API Gateway to your Azure API center, mea
4040

4141
* An API center in your Azure subscription. If you haven't created one, see [Quickstart: Create your API center](set-up-api-center.md).
4242

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

4545
* An [Amazon API Gateway](https://docs.aws.amazon.com/apigateway/).
4646

@@ -69,12 +69,18 @@ Save your access keys in a safe location. You'll store them in Azure Key Vault i
6969

7070
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).
7171

72+
#### [Portal](#tab/portal)
73+
7274
| AWS secret | Upload options | Name | Secret value |
7375
|------------|----------------|------|--------------|
7476
| Access key | Manual | *aws-access-key* | Access key ID retrieved from AWS |
7577
| Secret access key | Manual | *aws-secret-access-key* | Secret access key retrieved from AWS |
7678

77-
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.
7884

7985

8086
[!INCLUDE [enable-managed-identity](includes/enable-managed-identity.md)]
@@ -86,8 +92,9 @@ Take note of the **Secret identifier** URI of each secret. You'll use these iden
8692

8793
## Integrate an Amazon API Gateway
8894

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

97+
<!--
9198
#### [Portal](#tab/portal)
9299
93100
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
102109
1. Optionally, select whether to include API definitions.
103110
1. Select **Create**.
104111
105-
<!----
106-
Add image of integrating AWS g/w?
112+
Add image of integrating AWS g/w in portal
107113
--->
108114

109115
#### [Azure CLI](#tab/cli)
110116

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

113-
```azurecli
119+
* Provide the names of the resource group, API center, and integration.
114120

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.
122+
123+
```azurecli
124+
az apic integration create aws \
125+
--resource-group <resource-group-name> \
126+
--service-name-name <api-center-name> \
116127
--integration-name <aws-integration-name> \
117128
--aws-access-key-reference <access-key-uri> \
118-
--aws-secret-access-key-reference <secret-access-key-uri> \
129+
--aws-secret-access-key-reference <secret-access-key-uri>
119130
--aws-region-name <aws-region>
120131
```
121132
---

0 commit comments

Comments
 (0)