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-api-center-portal-vscode-extension.md
+18-18Lines changed: 18 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,18 +1,18 @@
1
1
---
2
-
title: Enable platform API Center Portal - Azure API Center - VS Code extension
2
+
title: Enable platform API Center portal - Azure API Center - VS Code extension
3
3
description: Enable enterprise developers to view the enterprise's platform API catalog including API definitions using the Visual Studio Code Extension for Azure API Center.
4
4
author: dlepow
5
5
ms.service: azure-api-center
6
6
ms.topic: how-to
7
-
ms.date: 09/27/2024
7
+
ms.date: 03/20/2025
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 and view Azure API Center Portal
13
+
# Enable and view Azure API Center portal
14
14
15
-
This article shows how to provide enterprise developers access to the Azure API Center Portal 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 API Center Portal is managed using Microsoft Entra ID and Azure role-based access control.
15
+
This article shows how to provide enterprise developers access to the Azure API Center portal 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 API Center portal is managed using Microsoft Entra ID and Azure role-based access control.
16
16
17
17
> [!TIP]
18
18
> The Visual Studio Code extension provides more features for API developers who have permissions to manage an Azure API center. For example, API developers can register APIs in the API center directly or using CI/CD pipelines. [Learn more](build-register-apis-vscode-extension.md)
@@ -32,22 +32,22 @@ The following Visual Studio Code extension is optional:
32
32
33
33
*[Microsoft Kiota extension](https://marketplace.visualstudio.com/items?itemName=ms-graph.kiota) - to generate API clients
34
34
35
-
## Steps for API center administrators to enable access to API Center Portal
35
+
## Steps for API center administrators to enable access to API Center portal
36
36
37
-
The following sections provide steps for API center administrators to enable enterprise developers to access the API Center Portal.
37
+
The following sections provide steps for API center administrators to enable enterprise developers to access the API Center portal.
### Enable sign-in to API Center Portal by Microsoft Entra users and groups
42
+
### Enable sign-in to API Center portal by Microsoft Entra users and groups
43
43
44
-
Enterprise developers must sign in with a Microsoft account to see the API Center Portal for your API center. If needed, [add or invite developers](/entra/external-id/b2b-quickstart-add-guest-users-portal) to your Microsoft Entra tenant.
44
+
Enterprise developers must sign in with a Microsoft account to see the API Center portal for your API center. If needed, [add or invite developers](/entra/external-id/b2b-quickstart-add-guest-users-portal) to your Microsoft Entra tenant.
## Steps for enterprise developers to access the API Center Portal
48
+
## Steps for enterprise developers to access the API Center portal
49
49
50
-
Developers can follow these steps to connect and sign in to view a API Center Portal using the Visual Studio Code extension. Settings to connect to the API center need to be provided by the API center administrator.
50
+
Developers can follow these steps to connect and sign in to view a API Center portal using the Visual Studio Code extension. Settings to connect to the API center need to be provided by the API center administrator.
51
51
52
52
### Connect to an API center
53
53
@@ -67,21 +67,21 @@ Developers can follow these steps to connect and sign in to view a API Center Po
67
67
> 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 name of the API center appears in the API Center Portal.
70
+
After you connect to the API center, the name of the API center appears in the API Center portal.
71
71
72
72
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.
73
73
74
-
:::image type="content" source="media/enable-platform-api-catalog-vscode-extension/api-center-pane-initial.png" alt-text="Screenshot of API Center Portal in VS Code extension." :::
74
+
:::image type="content" source="media/enable-platform-api-catalog-vscode-extension/api-center-pane-initial.png" alt-text="Screenshot of API Center portal in VS Code extension." :::
75
75
76
76
1. After signing in, select **APIs** to list the APIs in the API center. Expand an API to explore its versions and definitions.
77
77
78
-
:::image type="content" source="media/enable-platform-api-catalog-vscode-extension/api-center-pane-apis.png" alt-text="Screenshot of API Center Portal with APIs in VS Code extension." :::
78
+
:::image type="content" source="media/enable-platform-api-catalog-vscode-extension/api-center-pane-apis.png" alt-text="Screenshot of API Center portal with APIs in VS Code extension." :::
79
79
80
80
1. Repeat the preceding steps to connect to more API centers, if access is configured.
81
81
82
-
### Discover and consume APIs in the API Center Portal
82
+
### Discover and consume APIs in the API Center portal
83
83
84
-
The API Center Portal 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 API Center Portal:
84
+
The API Center portal 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 API Center portal:
85
85
86
86
***Export API specification document** - Export an API specification from a definition and then download it as a file
87
87
***Generate API client** - Use the Microsoft Kiota extension to generate an API client for their favorite language
@@ -93,15 +93,15 @@ The API Center Portal helps enterprise developers discover API details and start
93
93
94
94
### Error: Cannot read properties of undefined (reading 'nextLink')
95
95
96
-
Under certain conditions, a user might encounter the following error message after signing into the API Center Portal and expanding the APIs list for an API center:
96
+
Under certain conditions, a user might encounter the following error message after signing into the API Center portal and expanding the APIs list for an API center:
97
97
98
98
`Error: Cannot read properties of undefined (reading 'nextLink')`
99
99
100
-
Check that the user is assigned the **Azure API Center Data Reader** role in the API center. If necessary, reassign the role to the user. Then, refresh the API Center Portal in the Visual Studio Code extension.
100
+
Check that the user is assigned the **Azure API Center Data Reader** role in the API center. If necessary, reassign the role to the user. Then, refresh the API Center portal in the Visual Studio Code extension.
101
101
102
102
### Unable to sign in to Azure
103
103
104
-
If users who have been assigned the **Azure API Center Data Reader** role can't complete the sign-in flow after selecting **Sign in to Azure** in the API Center Portal, there might be a problem with the configuration of the connection.
104
+
If users who have been assigned the **Azure API Center Data Reader** role can't complete the sign-in flow after selecting **Sign in to Azure** in the API Center portal, there might be a problem with the configuration of the connection.
105
105
106
106
Check the settings in the app registration you configured in Microsoft Entra ID. Confirm the values of the application (client) ID and the directory (tenant) ID in the app registration and the runtime URL of the API center. Then, set up the connection to the API center again.
0 commit comments