Skip to content

Commit a94bc79

Browse files
author
gitName
committed
[APIC] Update PR from Wenyu Tang
1 parent 79af088 commit a94bc79

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

articles/api-center/enable-api-center-portal-vscode-extension.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
---
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
33
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.
44
author: dlepow
55
ms.service: azure-api-center
66
ms.topic: how-to
7-
ms.date: 09/27/2024
7+
ms.date: 03/20/2025
88
ms.author: danlep
99
ms.custom:
1010
# 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.
1111
---
1212

13-
# Enable and view Azure API Center Portal
13+
# Enable and view Azure API Center portal
1414

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

1717
> [!TIP]
1818
> 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:
3232

3333
* [Microsoft Kiota extension](https://marketplace.visualstudio.com/items?itemName=ms-graph.kiota) - to generate API clients
3434

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
3636

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

3939
### Create Microsoft Entra app registration
4040
[!INCLUDE [api-center-portal-app-registration](includes/api-center-portal-app-registration.md)]
4141

42-
### 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
4343

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

4646
[!INCLUDE [api-center-portal-user-sign-in](includes/api-center-portal-user-sign-in.md)]
4747
### For API center administrators
48-
## Steps for enterprise developers to access the API Center Portal
48+
## Steps for enterprise developers to access the API Center portal
4949

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

5252
### Connect to an API center
5353

@@ -67,21 +67,21 @@ Developers can follow these steps to connect and sign in to view a API Center Po
6767
> An API center administrator needs to provide these connection details to developers, or provide a direct link in the following format:
6868
> `vscode://apidev.azure-api-center?clientId=<Client ID>&tenantId=<tenant ID>&runtimeUrl=<service-name>.data.<region>.azure-apicenter.ms`
6969
70-
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.
7171

7272
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.
7373

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." :::
7575

7676
1. After signing in, select **APIs** to list the APIs in the API center. Expand an API to explore its versions and definitions.
7777

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." :::
7979

8080
1. Repeat the preceding steps to connect to more API centers, if access is configured.
8181

82-
### Discover and consume APIs in the API Center Portal
82+
### Discover and consume APIs in the API Center portal
8383

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:
8585

8686
* **Export API specification document** - Export an API specification from a definition and then download it as a file
8787
* **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
9393

9494
### Error: Cannot read properties of undefined (reading 'nextLink')
9595

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:
9797

9898
`Error: Cannot read properties of undefined (reading 'nextLink')`
9999

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

102102
### Unable to sign in to Azure
103103

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

106106
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.
107107

0 commit comments

Comments
 (0)