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/enable-platform-api-catalog-vscode-extension.md
+23-13Lines changed: 23 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,22 +4,26 @@ description: Enable enterprise developers to view the enterprise's platform API
4
4
author: dlepow
5
5
ms.service: azure-api-center
6
6
ms.topic: how-to
7
-
ms.date: 09/23/2024
7
+
ms.date: 09/27/2024
8
8
ms.author: danlep
9
9
ms.custom:
10
10
# Customer intent: As an API program manager, I want to enable an API catalog so that app developers in my organization can discover and consume the APIs in my organization's API center without needing to manage the API inventory itself.
11
11
---
12
12
13
-
# Enable access to Azure API Center platform API catalog
13
+
# Enable and view Azure API Center platform API catalog
14
14
15
15
This article shows how to provide enterprise developers access to the Azure API Center platform API catalog (preview) in the Visual Studio Code extension for [Azure API Center](overview.md). Using the platform API catalog, developers can discover APIs in your Azure API center, view API definitions, and optionally generate API clients when they don't have access to manage the API center itself or add APIs to the inventory. Access to the platform API catalog is managed using Microsoft Entra ID and Azure role-based access control.
16
16
17
17
## Prerequisites
18
18
19
+
### For API center administrators
20
+
19
21
* An API center in your Azure subscription. If you haven't created one already, see [Quickstart: Create your API center](set-up-api-center.md).
20
22
21
23
* Permissions to create an app registration in a Microsoft Entra tenant associated with your Azure subscription, and permissions to grant access to data in your API center.
22
24
25
+
### For app developers
26
+
23
27
*[Azure API Center extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=apidev.azure-api-center)
24
28
25
29
> [!IMPORTANT]
@@ -29,7 +33,11 @@ The following Visual Studio Code extension is optional:
29
33
30
34
*[Microsoft Kiota extension](https://marketplace.visualstudio.com/items?itemName=ms-graph.kiota) - to generate API clients
31
35
32
-
## Create Microsoft Entra app registration
36
+
## Steps for API center administrators to enable access to catalog
37
+
38
+
The following sections provide steps for API center administrators to enable enterprise developers to access the platform API catalog.
39
+
40
+
### Create Microsoft Entra app registration
33
41
34
42
First, configure an app registration in your Microsoft Entra ID tenant. The app registration enables the Visual Studio Code extension for Azure API Center to access the platform API catalog on behalf of a signed-in user.
35
43
@@ -62,9 +70,9 @@ First, configure an app registration in your Microsoft Entra ID tenant. The app
62
70
63
71
:::image type="content" source="media/enable-platform-api-catalog-vscode-extension/configure-app-permissions.png" alt-text="Screenshot of required permissions in Microsoft Entra ID app registration in the portal." :::
64
72
65
-
## Enable sign-in to platform API catalog by Microsoft Entra users and groups
73
+
###Enable sign-in to platform API catalog by Microsoft Entra users and groups
66
74
67
-
Developers in the enterprise must sign in to see the platform API catalog for your API center. To enable sign-in, assign the **Azure API Center Data Reader** role to users or groups in your organization, scoped to your API center.
75
+
Enterprise developers must sign in with a Microsoft account to see the platform API catalog for your API center. If needed, add or invite developers to your Microsoft Entra tenant. Then, to enable sign-in, assign the **Azure API Center Data Reader** role to users or groups in your tenant, scoped to your API center.
68
76
69
77
> [!IMPORTANT]
70
78
> By default, you and other administrators of the API center don't have access to APIs in the API Center extension's platform API catalog. Be sure to assign the **Azure API Center Data Reader** role to yourself and other administrators.
@@ -83,9 +91,11 @@ For detailed prerequisites and steps to assign a role to users and groups, see [
83
91
> [!NOTE]
84
92
> To streamline access configuration for new users, we recommend that you assign the role to a Microsoft Entra group and configure a dynamic group membership rule. To learn more, see [Create or update a dynamic group in Microsoft Entra ID](/entra/identity/users/groups-create-rule).
85
93
86
-
## Steps to access the platform API catalog in Visual Studio Code
94
+
## Steps for enterprise developers to access the platform API catalog
95
+
96
+
Developers can follow these steps to connect and sign in to view a platform API catalog using the Visual Studio Code extension. Settings to connect to the API center need to be provided by the API center administrator.
87
97
88
-
Developers in the enterprise can follow these steps to connect and sign in to view a platform API catalog using the Visual Studio code extension.
98
+
### Connect to an API center
89
99
90
100
1. Install the pre-release version of the [Azure API Center extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=apidev.azure-api-center) for Visual Studio Code.
91
101
@@ -95,15 +105,15 @@ Developers in the enterprise can follow these steps to connect and sign in to vi
95
105
96
106
1. Use the **Ctrl+Shift+P** keyboard shortcut to open the Command Palette. Type **Azure API Center: Connect to an API Center** and hit **Enter**.
97
107
1. Answer the prompts to input the following information:
98
-
1. The runtime URL of your API center, in the format `<service name>.data.<region>.azure-apicenter.ms` (don't prefix with `https://`). Example: `contoso-apic.data.eastus.azure-apicenter.ms`.
99
-
1. The application (client) ID from the app registration configured in the previous section.
100
-
1. The directory (tenant) ID from the app registration configured in the previous section.
108
+
1. The runtime URL of your API center, in the format `<service name>.data.<region>.azure-apicenter.ms` (don't prefix with `https://`). Example: `contoso-apic.data.eastus.azure-apicenter.ms`. This runtime URL appears on the **Overview** page of the API center in the Azure portal.
109
+
1. The application (client) ID from the app registration configured by the administrator in the previous section.
110
+
1. The directory (tenant) ID from the app registration configured by the administrator in the previous section.
101
111
102
112
> [!TIP]
103
-
> An API center administrator needs to provide these connection settings to developers, or provide a direct link in the following format:
113
+
> An API center administrator needs to provide these connection details to developers, or provide a direct link in the following format:
After you connect to the API center, the API center appears in the API Center platform API catalog.
116
+
After you connect to the API center, the name of the API center appears in the API Center platform API catalog.
107
117
108
118
1. To view the APIs in the API center, under the API center name, select **Sign in to Azure**. Sign-in is allowed with a Microsoft account that is assigned the **Azure API Center Data Reader** role in the API center.
109
119
@@ -115,7 +125,7 @@ Developers in the enterprise can follow these steps to connect and sign in to vi
115
125
116
126
1. Repeat the preceding steps to connect to more API centers, if access is configured.
117
127
118
-
## Discover and consume APIs in the catalog
128
+
###Discover and consume APIs in the catalog
119
129
120
130
The platform API catalog helps enterprise developers discover API details and start API client development. Developers can access the following features by right-clicking on an API definition in the platform API catalog:
0 commit comments