Skip to content

Commit 11e1da2

Browse files
TaojunshenTaojunshen
authored
Merge pull request #289524 from MicrosoftDocs/main
10/30/2024 PM Publish
2 parents b23dd9e + 2dbc33e commit 11e1da2

File tree

111 files changed

+2203
-3092
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

111 files changed

+2203
-3092
lines changed

‎articles/api-center/TOC.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,8 @@
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
4143
- name: Build and register APIs - VS Code extension
4244
href: build-register-apis-vscode-extension.md
4345
- name: Register APIs - GitHub Actions

‎articles/api-center/import-api-management-apis.md

Lines changed: 10 additions & 90 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,9 @@ This article shows two options for using the Azure CLI to add APIs to your API c
2626

2727
After importing API definitions or APIs from API Management, you can add metadata and documentation in your API center to help stakeholders discover, understand, and consume the API.
2828

29+
> [!TIP]
30+
> You can also set up automatic synchronization of APIS from API Management to your API center. For more information, see [Link an API Management instance to synchronize APIs to your API center](synchronize-api-management-apis.md).
31+
2932
## Prerequisites
3033

3134
* An API center in your Azure subscription. If you haven't created one, see [Quickstart: Create your API center](set-up-api-center.md).
@@ -58,7 +61,7 @@ az apim api export --api-id my-api --resource-group myResourceGroup \
5861
```
5962

6063
```azurecli
61-
#! PowerShell syntax
64+
# Formatted for PowerShell
6265
az apim api export --api-id my-api --resource-group myResourceGroup `
6366
--service-name myAPIManagement --export-format OpenApiJsonFile `
6467
--file-path '/path/to/folder'
@@ -76,7 +79,7 @@ link=$(az apim api export --api-id my-api --resource-group myResourceGroup \
7679
```
7780

7881
```azurecli
79-
# PowerShell syntax
82+
# Formatted for PowerShell
8083
$link=$(az apim api export --api-id my-api --resource-group myResourceGroup `
8184
--service-name myAPIManagement --export-format OpenApiJsonUrl --query properties.value.link `
8285
--output tsv)
@@ -107,7 +110,7 @@ az apic api definition import-specification \
107110
```
108111

109112
```azurecli
110-
# PowerShell syntax
113+
# Formatted for PowerShell
111114
az apic api definition import-specification `
112115
--resource-group myResourceGroup --service-name myAPICenter `
113116
--api-id my-api --version-id v1-0-0 `
@@ -128,94 +131,11 @@ When you add APIs from an API Management instance to your API center using `az a
128131

129132
### Add a managed identity in your API center
130133

131-
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.
132-
133-
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.
134-
135-
#### [Portal](#tab/portal)
136-
137-
1. In the [portal](https://azure.microsoft.com), navigate to your API center.
138-
1. In the left menu, under **Security**, select **Managed identities**.
139-
1. Select **System assigned**, and set the status to **On**.
140-
1. Select **Save**.
141-
142-
#### [Azure CLI](#tab/cli)
143-
144-
Set the system-assigned identity in your API center using the following [az apic update](/cli/azure/apic#az-apic-update) command. Substitute the names of your API center and resource group:
145-
146-
```azurecli
147-
az apic update --name <api-center-name> --resource-group <resource-group-name> --identity '{"type": "SystemAssigned"}'
148-
```
149-
---
134+
[!INCLUDE [enable-managed-identity](includes/enable-managed-identity.md)]
150135

151136
### Assign the managed identity the API Management Service Reader role
152137

153-
To allow import of APIs, assign your API center's managed identity the **API Management Service Reader** role in your API Management instance. You can use the [portal](../role-based-access-control/role-assignments-portal-managed-identity.yml) or the Azure CLI.
154-
155-
#### [Portal](#tab/portal)
156-
157-
1. In the [portal](https://azure.microsoft.com), navigate to your API Management instance.
158-
1. In the left menu, select **Access control (IAM)**.
159-
1. Select **+ Add role assignment**.
160-
1. On the **Add role assignment** page, set the values as follows:
161-
1. On the **Role** tab - Select **API Management Service Reader**.
162-
1. On the **Members** tab, in **Assign access to** - Select **Managed identity** > **+ Select members**.
163-
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**.
164-
1. Select **Review + assign**.
165-
166-
#### [Azure CLI](#tab/cli)
167-
168-
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.
169-
170-
```azurecli
171-
#! /bin/bash
172-
apicObjID=$(az apic show --name <api-center-name> \
173-
--resource-group <resource-group-name> \
174-
--query "identity.principalId" --output tsv)
175-
```
176-
177-
```azurecli
178-
# PowerShell syntax
179-
$apicObjID=$(az apic show --name <api-center-name> `
180-
--resource-group <resource-group-name> `
181-
--query "identity.principalId" --output tsv)
182-
```
183-
184-
1. Get the resource ID of your API Management instance using the [az apim show](/cli/azure/apim#az-apim-show) command.
185-
186-
```azurecli
187-
#! /bin/bash
188-
apimID=$(az apim show --name <apim-name> --resource-group <resource-group-name> --query "id" --output tsv)
189-
```
190-
191-
```azurecli
192-
# PowerShell syntax
193-
$apimID=$(az apim show --name <apim-name> --resource-group <resource-group-name> --query "id" --output tsv)
194-
```
195-
196-
1. Assign the managed identity the **API Management Service Reader** role in your API Management instance using the [az role assignment create](/cli/azure/role/assignment#az-role-assignment-create) command.
197-
198-
```azurecli
199-
#! /bin/bash
200-
scope="${apimID:1}"
201-
202-
az role assignment create \
203-
--role "API Management Service Reader Role" \
204-
--assignee-object-id $apicObjID \
205-
--assignee-principal-type ServicePrincipal \
206-
--scope $scope
207-
```
208-
209-
```azurecli
210-
#! PowerShell syntax
211-
$scope=$apimID.substring(1)
212-
213-
az role assignment create `
214-
--role "API Management Service Reader Role" `
215-
--assignee-object-id $apicObjID `
216-
--assignee-principal-type ServicePrincipal `
217-
--scope $scope
218-
---
138+
[!INCLUDE [configure-managed-identity-apim-reader](includes/configure-managed-identity-apim-reader.md)]
219139

220140
### Import APIs from API Management
221141

@@ -238,7 +158,7 @@ az apic import-from-apim --service-name <api-center-name> --resource-group <reso
238158
```
239159

240160
```azurecli
241-
# PowerShell syntax
161+
# Formatted for PowerShell
242162
az apic import-from-apim --service-name <api-center-name> --resource-group <resource-group-name> `
243163
--apim-name <api-management-name> --apim-resource-group <api-management-resource-group-name> `
244164
--apim-apis '*'
@@ -262,7 +182,7 @@ az apic import-from-apim --service-name <api-center-name> --resource-group <reso
262182

263183

264184
```azurecli
265-
# PowerShell syntax
185+
# Formatted for PowerShell
266186
az apic import-from-apim --service-name <api-center-name> --resource-group <resource-group-name> `
267187
--apim-name <api-management-name> --apim-resource-group <api-management-resource-group-name> `
268188
--apim-apis 'petstore-api'

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

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,24 +7,27 @@ author: dlepow
77

88
ms.service: azure-api-center
99
ms.topic: include
10-
ms.date: 05/14/2024
10+
ms.date: 10/18/2024
1111
ms.author: danlep
1212
ms.custom: Include file
1313
---
1414

15-
| Resource | Free plan | Standard plan<sup>1</sup> |
15+
| Resource | Free plan<sup>1</sup> | Standard plan<sup>2</sup> |
1616
| ---------------------------------------------------------------------- | -------------------------- |-------------|
17-
| Maximum number of APIs | 200<sup>2</sup> | 10,000 |
17+
| Maximum number of APIs | 200<sup>3</sup> | 10,000 |
1818
| Maximum number of versions per API | 5 | 100 |
1919
| Maximum number of definitions per version | 5 | 5 |
2020
| Maximum number of deployments per API | 10 | 10 |
2121
| Maximum number of environments | 20 | 20 |
2222
| Maximum number of workspaces | 1 (Default) | 1 (Default) |
23-
| Maximum number of custom metadata properties per entity<sup>3</sup> | 10 | 20 |
23+
| Maximum number of custom metadata properties per entity<sup>4</sup> | 10 | 20 |
2424
| Maximum number of child properties in custom metadata property of type "object" | 10 |10 |
2525
| Maximum requests per minute (data plane) | 3,000 | 6,000 |
2626
| Maximum number of API definitions [linted](../enable-managed-api-analysis-linting.md) per 4 hours | 10 | 100 |
27+
| Maximum number of linked API sources<sup>5</sup> | 1 | 3 |
2728

28-
<sup>1</sup> To increase a limit in the Standard plan, contact [support](https://azure.microsoft.com/support/options/).<br/>
29-
<sup>2</sup> In the Free plan, use of full service features including API analysis and access through the data plane API is limited to 5 APIs.<br/>
30-
<sup>3</sup> Custom metadata properties assigned to APIs, deployments, and environments.
29+
<sup>1</sup> Free plan provided for 90 days, then service is soft-deleted.<br/>
30+
<sup>2</sup> To increase a limit in the Standard plan, contact [support](https://azure.microsoft.com/support/options/).<br/>
31+
<sup>3</sup> In the Free plan, use of full service features including API analysis and access through the data plane API is limited to 5 APIs.<br/>
32+
<sup>4</sup> Custom metadata properties assigned to APIs, deployments, and environments.<br/>
33+
<sup>5</sup> Sources such as linked API Management instances. In the Free plan, synchronization from a linked API source is limited to 200 APIs and 5 API definitions.

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

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: 10/18/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 **API Management Service Reader** role in your API Management instance. 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 API Management instance.
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 **API Management Service Reader**.
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 API Management instance using the [az apim show](/cli/azure/apim#az-apim-show) command.
46+
47+
```azurecli
48+
#! /bin/bash
49+
apimID=$(az apim show --name <apim-name> --resource-group <resource-group-name> --query "id" --output tsv)
50+
```
51+
52+
```azurecli
53+
# Formatted for PowerShell
54+
$apimID=$(az apim show --name <apim-name> --resource-group <resource-group-name> --query "id" --output tsv)
55+
```
56+
57+
1. Assign the managed identity the **API Management Service Reader** role in your API Management instance using the [az role assignment create](/cli/azure/role/assignment#az-role-assignment-create) command.
58+
59+
```azurecli
60+
#! /bin/bash
61+
scope="${apimID:1}"
62+
63+
az role assignment create \
64+
--role "API Management Service Reader Role" \
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 "API Management Service Reader Role" `
76+
--assignee-object-id $apicObjID `
77+
--assignee-principal-type ServicePrincipal `
78+
--scope $scope
79+
---

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

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
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: 10/18/2024
10+
ms.author: danlep
11+
ms.custom: Include file
12+
---
13+
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.
15+
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.
17+
18+
#### [Portal](#tab/portal)
19+
20+
1. In the [portal](https://azure.microsoft.com), navigate to your API center.
21+
1. In the left menu, under **Security**, select **Managed identities**.
22+
1. Select **System assigned**, and set the status to **On**.
23+
1. Select **Save**.
24+
25+
#### [Azure CLI](#tab/cli)
26+
27+
Set the system-assigned identity in your API center using the following [az apic update](/cli/azure/apic#az-apic-update) command. Substitute the names of your API center and resource group:
28+
29+
```azurecli
30+
az apic update --name <api-center-name> --resource-group <resource-group-name> --identity '{"type": "SystemAssigned"}'
31+
```
32+
---
33+

‎articles/api-center/media/synchronize-api-management-apis/environment-link-list.png

50.5 KB
Loading

‎articles/api-center/media/synchronize-api-management-apis/link-api-management-service.png

49.5 KB
Loading

0 commit comments

Comments
 (0)