Skip to content

Commit ae9205d

Browse files
author
gitName
committed
redirects
1 parent 70a00aa commit ae9205d

11 files changed

+27
-19
lines changed

articles/api-center/TOC.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,12 +70,12 @@
7070
items:
7171
- name: Enable API Center portal
7272
href: set-up-api-center-portal.md
73+
- name: Enable API Center portal - VS Code extension
74+
href: enable-api-center-portal-vscode-extension.md
7375
- name: Self-host Azure API Center portal
7476
href: self-host-api-center-portal.md
7577
- name: Discover and consume APIs - VS Code extension
7678
href: discover-apis-vscode-extension.md
77-
- name: Enable platform API catalog - VS Code extension
78-
href: enable-platform-api-catalog-vscode-extension.md
7979
- name: Check API calls use minimal permissions with Dev Proxy
8080
href: check-minimal-api-permissions-dev-proxy.md
8181
- name: API center management and operations

articles/api-center/build-register-apis-vscode-extension.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,6 @@ After generating the OpenAPI specification file and checking for accuracy, you c
7070
* [Azure API Center - key concepts](key-concepts.md)
7171
* [Discover and consume APIs with the Azure API Center extension for Visual Studio Code](discover-apis-vscode-extension.md)
7272
* [Govern APIs with the Azure API Center extension for Visual Studio Code](govern-apis-vscode-extension.md)
73-
* [Enable and view platform API catalog in Visual Studio Code](enable-platform-api-catalog-vscode-extension.md)
73+
* [Enable and view API Center portal in Visual Studio Code](enable-api-center-portal-vscode-extension.md)
7474
* [Overview of GitHub Copilot for Azure](/azure/developer/github-copilot-azure/introduction)
7575

articles/api-center/design-api-github-copilot-azure.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,6 @@ After the API is registered, you can perform various tasks using the extension.
7878
* [Build and register APIs with the Azure API Center extension for Visual Studio Code](build-register-apis-vscode-extension.md)
7979
* [Discover and consume APIs with the Azure API Center extension for Visual Studio Code](discover-apis-vscode-extension.md)
8080
* [Govern APIs with the Azure API Center extension for Visual Studio Code](govern-apis-vscode-extension.md)
81-
* [Enable and view platform API catalog in Visual Studio Code](enable-platform-api-catalog-vscode-extension.md)
81+
* [Enable and view API Center portal in Visual Studio Code](enable-api-center-portal-vscode-extension.md)
8282
* [Overview of GitHub Copilot for Azure](/azure/developer/github-copilot-azure/introduction)
8383

articles/api-center/discover-apis-vscode-extension.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ API developers in your organization can discover and consume APIs in your [API c
2121
API developers can also take advantage of features in the extension to [register APIs](build-register-apis-vscode-extension.md) in the API center and ensure [API governance](govern-apis-vscode-extension.md).
2222

2323
> [!TIP]
24-
> If you want enterprise app developers to discover APIs in a centralized location, optionally enable a [platform API catalog](enable-platform-api-catalog-vscode-extension.md) for your API center in Visual Studio Code. The platform API catalog is a read-only view of the API inventory.
24+
> If you want enterprise app developers to discover APIs in a centralized location, optionally enable the read-only [API Center portal](enable-api-center-portal-vscode-extension.md) for your API center in Visual Studio Code.
2525
2626
[!INCLUDE [vscode-extension-basic-prerequisites](includes/vscode-extension-basic-prerequisites.md)]
2727

@@ -108,5 +108,5 @@ You can also export a specification using the Command Palette:
108108
* [Azure API Center - key concepts](key-concepts.md)
109109
* [Build and register APIs with the Azure API Center extension for Visual Studio Code](build-register-apis-vscode-extension.md)
110110
* [Govern APIs with the Azure API Center extension for Visual Studio Code](govern-apis-vscode-extension.md)
111-
* [Enable and view platform API catalog in Visual Studio Code](enable-platform-api-catalog-vscode-extension.md)
111+
* [Enable and view platform API catalog in Visual Studio Code](enable-api-center-portal-vscode-extension.md)
112112

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

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Enable platform API Center portal - Azure API Center - VS Code extension
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.
3+
description: Enable enterprise developers to view the enterprise's API Center portal 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
@@ -10,9 +10,11 @@ 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 - VS Code extension
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+
[!INCLUDE [api-center-availability-all-tiers](../includes/api-center-availability-all-tiers.md)]
16+
17+
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 portal, 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.
1618

1719
> [!TIP]
1820
> 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)
@@ -37,6 +39,7 @@ The following Visual Studio Code extension is optional:
3739
The following sections provide steps for API center administrators to enable enterprise developers to access the API Center portal.
3840

3941
### Create Microsoft Entra app registration
42+
4043
[!INCLUDE [api-center-portal-app-registration](includes/api-center-portal-app-registration.md)]
4144

4245
### Enable sign-in to API Center portal by Microsoft Entra users and groups
@@ -55,7 +58,7 @@ Developers can follow these steps to connect and sign in to view a API Center po
5558

5659
1. In Visual Studio Code, in the Activity Bar on the left, select API Center.
5760

58-
:::image type="content" source="media/enable-platform-api-catalog-vscode-extension/api-center-activity-bar.png" alt-text="Screenshot of the API Center icon in the Activity Bar.":::
61+
:::image type="content" source="media/enable-api-center-portal-vscode-extension/api-center-activity-bar.png" alt-text="Screenshot of the API Center icon in the Activity Bar.":::
5962

6063
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**.
6164
1. Answer the prompts to input the following information:
@@ -71,11 +74,11 @@ Developers can follow these steps to connect and sign in to view a API Center po
7174

7275
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.
7376

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." :::
77+
:::image type="content" source="media/enable-api-center-portal-vscode-extension/api-center-pane-initial.png" alt-text="Screenshot of API Center portal in VS Code extension." :::
7578

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

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." :::
81+
:::image type="content" source="media/enable-api-center-portal-vscode-extension/api-center-pane-apis.png" alt-text="Screenshot of API Center portal with APIs in VS Code extension." :::
7982

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

articles/api-center/frequently-asked-questions.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ sections:
3434
- question: Does Azure API Center provide a developer portal?
3535
answer: Yes, you enable the [API Center portal](set-up-api-center-portal.md), where developers can discover and filter APIs in your API center and view API details.
3636

37-
In the Azure API Center extension for Visual Studio Code, you can also provide an [API catalog](enable-platform-api-catalog-vscode-extension.md) view for app developers in your organization to discover APIs in your API center.
37+
You can also enable the API Center portal in the [Azure API Center extension for Visual Studio Code](enable-platform-api-catalog-vscode-extension.md) view for app developers in your organization to discover APIs in your API center.
3838

3939
- question: Does Azure API Center support availability zones?
4040
answer: Yes. The Azure API Center service runs in a multitenant environment on availability zone-enabled components. No further configuration is required to enable availability zones for the service.

articles/api-center/govern-apis-vscode-extension.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,5 +57,5 @@ Visual Studio Code opens a diff view between the two API specifications. Any bre
5757
* [Azure API Center - key concepts](key-concepts.md)
5858
* [Build and register APIs with the Azure API Center extension for Visual Studio Code](build-register-apis-vscode-extension.md)
5959
* [Discover and consume APIs with the Azure API Center extension for Visual Studio Code](discover-apis-vscode-extension.md)
60-
* [Enable and view platform API catalog in Visual Studio Code](enable-platform-api-catalog-vscode-extension.md)
60+
* [Enable and view API Center portal in Visual Studio Code](enable-api-center-portal-vscode-extension.md)
6161

articles/api-center/includes/api-center-portal-app-registration.md

Lines changed: 3 additions & 3 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: 03/04/2025
9+
ms.date: 03/20/2025
1010
ms.author: danlep
1111
ms.custom: Include file
1212
---
@@ -24,5 +24,5 @@ First configure an app registration in your Microsoft Entra ID tenant. The app r
2424
1. In **Redirect URI**, select **Single-page application (SPA)** and set the URI.
2525
Enter the URI of your API Center portal deployment, in the following form: `https://<service-name>.portal.<location>.azure-api-center.ms`. Replace `<service name>` and `<location>` with the name of your API center and the location where it's deployed, Example: `https://myapicenter.portal.eastus.azure-api-center.ms`.
2626
1. Select **Register**.
27-
1. Turn into **Authentication** page, click **Add a platform** and select the **Mobile and desktop applications**, add following three Redirect URIs into this section: `https://vscode.dev/redirect`, `http://localhost`, and `ms-appx-web://Microsoft.AAD.BrokerPlugin/<application-client-id>`. Replace `<application-client-id>` with this AAD App.
28-
1. On the **Overview** page, copy the **Application (client) ID**. You set this value when you publish the portal.
27+
1. On the **Manage** > **Authentication** page, Select **Add a platform** and select **Mobile and desktop applications**.
28+
1. Configure the following three custom redirect URIs: `https://vscode.dev/redirect`, `http://localhost`, and `ms-appx-web://Microsoft.AAD.BrokerPlugin/<application-client-id>`. Replace `<application-client-id>` with the application (client) ID of this app. You can find this value on the **Overview** page.

articles/api-center/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Create and use an API center for the following:
4747

4848
API developers can shift-left API design conformance checks into Visual Studio Code with integrated linting support and breaking change detection. Integrate with tools such as Dev Proxy to ensure that apps don't use unregistered [shadow APIs](discover-shadow-apis-dev-proxy.md) or APIs that don't meet organizational standards.
4949

50-
* **API discovery and reuse** - Enable enterprise developers and API program managers to discover APIs via an [API Center portal](set-up-api-center-portal.md) or an [API platform catalog](enable-platform-api-catalog-vscode-extension.md) that's accessed using the Azure API Center Visual Studio Code extension.
50+
* **API discovery and reuse** - Enable enterprise developers and API program managers to discover APIs via an [API Center portal](set-up-api-center-portal.md). You can also enable the portal using the [Azure API Center Visual Studio Code extension](enable-api-center-portal-vscode-extension.md).
5151

5252
For more about the entities you can manage and the capabilities in Azure API Center, see [Key concepts](key-concepts.md).
5353

articles/api-center/set-up-api-center-portal.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,4 +60,4 @@ To make only specific APIs visible, go to the **API visibility** tab in the API
6060

6161
## Related content
6262

63-
* [Enable and view Azure API Center platform API catalog](enable-platform-api-catalog-vscode-extension.md)
63+
* [Enable and view Azure API Center portal in the VS Code extension](enable-api-center-portal-vscode-extension.md)

0 commit comments

Comments
 (0)