Skip to content

Commit bbe8b05

Browse files
authored
Merge pull request #298562 from MicrosoftDocs/main
4/21/2025 AM Publish
2 parents 57fe601 + b5de55a commit bbe8b05

File tree

81 files changed

+353
-329
lines changed

Some content is hidden

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

81 files changed

+353
-329
lines changed
Lines changed: 23 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: Enable API Center portal - Azure API Center - VS Code extension
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.
2+
title: Enable API Center portal view - Azure API Center - VS Code extension
3+
description: Enable enterprise developers to view the enterprise's API Center portal view 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,9 @@ 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 - VS Code extension
13+
# Enable and view Azure API Center portal view - 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 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.
15+
This article shows how to provide enterprise developers access to the Azure API Center portal view in the Visual Studio Code extension for [Azure API Center](overview.md). Using the portal view, 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 view 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,23 +32,23 @@ 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 view
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 view.
3838

3939
### Create Microsoft Entra app registration
4040

4141
[!INCLUDE [api-center-portal-app-registration](includes/api-center-portal-app-registration.md)]
4242

43-
### Enable sign-in to API Center portal by Microsoft Entra users and groups
43+
### Enable sign-in to API Center portal view by Microsoft Entra users and groups
4444

45-
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.
45+
Enterprise developers must sign in with a Microsoft account to see the API Center portal view for your API center. If needed, [add or invite developers](/entra/external-id/b2b-quickstart-add-guest-users-portal) to your Microsoft Entra tenant.
4646

4747
[!INCLUDE [api-center-portal-user-sign-in](includes/api-center-portal-user-sign-in.md)]
4848

49-
## Steps for enterprise developers to access the API Center portal
49+
## Steps for enterprise developers to access the API Center portal view
5050

51-
Developers can follow these steps to connect and sign in to view an 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+
Developers can follow these steps to connect and sign in to view an API Center portal view using the Visual Studio Code extension. Settings to connect to the API center need to be provided by the API center administrator.
5252

5353
### Connect to an API center
5454

@@ -60,29 +60,30 @@ Developers can follow these steps to connect and sign in to view an API Center p
6060

6161
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**.
6262
1. Answer the prompts to input the following information:
63-
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.
63+
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 view.
64+
6465
1. The application (client) ID from the app registration configured by the administrator in the previous section.
6566
1. The directory (tenant) ID from the app registration configured by the administrator in the previous section.
6667

6768
> [!TIP]
6869
> An API center administrator needs to provide these connection details to developers, or provide a direct link in the following format:
6970
> `vscode://apidev.azure-api-center?clientId=<Client ID>&tenantId=<tenant ID>&runtimeUrl=<service-name>.data.<region>.azure-apicenter.ms`
7071
71-
After you connect to the API center, the name of the API center appears in the API Center portal.
72-
72+
After you connect to the API center, the name of the API center appears in the API Center portal view.
73+
7374
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.
7475

75-
:::image type="content" source="media/enable-api-center-portal-vs-code-extension/api-center-pane-initial.png" alt-text="Screenshot of API Center portal in VS Code extension." :::
76-
76+
:::image type="content" source="media/enable-api-center-portal-vs-code-extension/api-center-pane-initial.png" alt-text="Screenshot of the API Center portal view in API Center extension.":::
77+
7778
1. After signing in, select **APIs** to list the APIs in the API center. Expand an API to explore its versions and definitions.
7879

79-
:::image type="content" source="media/enable-api-center-portal-vs-code-extension/api-center-pane-apis.png" alt-text="Screenshot of API Center portal with APIs in VS Code extension." :::
80-
80+
:::image type="content" source="media/enable-api-center-portal-vs-code-extension/api-center-pane-apis.png" alt-text="Screenshot of the API Center API definitions in API Center extension.":::
81+
8182
1. Repeat the preceding steps to connect to more API centers, if access is configured.
8283

83-
### Discover and consume APIs in the API Center portal
84+
### Discover and consume APIs in the API Center portal view
8485

85-
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:
86+
The API Center portal view 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 view:
8687

8788
* **Export API specification document** - Export an API specification from a definition and then download it as a file
8889
* **Generate API client** - Use the Microsoft Kiota extension to generate an API client for their favorite language
@@ -92,35 +93,16 @@ The API Center portal helps enterprise developers discover API details and start
9293

9394
## Troubleshooting
9495

95-
### Error: Cannot read properties of undefined (reading 'nextLink')
96-
97-
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:
98-
99-
`Error: Cannot read properties of undefined (reading 'nextLink')`
100-
101-
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.
102-
10396
### Unable to sign in to Azure
10497

105-
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.
98+
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 view, there might be a problem with the configuration of the connection.
10699

107100
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.
108101

109-
### Unable to select Azure API Center permissions in Microsoft Entra ID app registration
110-
111-
If you're unable to request API permissions to Azure API Center in your Microsoft Entra app registration for the API Center portal, check that you are searching for **Azure API Center** (or application ID `c3ca1a77-7a87-4dba-b8f8-eea115ae4573`).
112-
113-
If the app isn't present, there might be a problem with the registration of the **Microsoft.ApiCenter** resource provider in your subscription. You might need to re-register the resource provider. To do this, run the following command in the Azure CLI:
114-
115-
```azurecli
116-
az provider register --namespace Microsoft.ApiCenter
117-
```
118-
119-
After re-registering the resource provider, try again to request API permissions.
120-
121-
122102
## Related content
123103

124104
* [Build and register APIs with the Azure API Center extension for Visual Studio Code](build-register-apis-vscode-extension.md)
125105
* [Best practices for Azure RBAC](../role-based-access-control/best-practices.md)
106+
126107
* [Register a resource provider](../azure-resource-manager/management/resource-providers-and-types.md#register-resource-provider)
108+
6.07 KB
Loading
23.2 KB
Loading

articles/azure-vmware/native-connect-multiple-private-clouds.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@ ms.topic: how-to
55
ms.service: azure-vmware
66
author: jjaygbay1
77
ms.author: jacobjaygbay
8-
ms.date: 4/15/2025
8+
ms.date: 4/21/2025
99
ms.custom: engagement-fy25
1010
#customer intent: As a cloud administrator, I want to connect multiple Azure VMware Solution Generation 2 Private Clouds so that I can enable seamless communication between private clouds.
1111
---
1212

1313
# Connect multiple Azure VMware Solution Generation 2 Private Clouds
1414

15-
In this article, you learn how to connect a Azure VMware Solution Generation (Gen) 2 private cloud to other Gen 2 private clouds.
15+
In this article, you learn how to connect a Azure VMware Solution Generation 2 (Gen 2) private cloud to other Gen 2 private clouds.
1616

1717
## Prerequisite
1818

articles/azure-vmware/native-connect-on-premises.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@ title: Connect to on-premises environment
33
description: Learn how to connect your on-premises environment to Azure VMware Solution Gen 2 using ExpressRoute or Site-to-Site VPN for seamless integration.
44
ms.topic: how-to
55
ms.service: azure-vmware
6-
ms.date: 4/15/2025
6+
ms.date: 4/21/2025
77
ms.custom: engagement-fy25
88
#customer intent: As an IT administrator, I want to connect my on-premises environment to my Azure VMware Solution Generation 2 private cloud so that I can extend my infrastructure seamlessly.
99
---
1010

1111
# Connect to an on-premises environment
1212

13-
You require network connectivity between the your Gen 2 private cloud and other networks you deployed in an Azure Virtual Network, on-premises, other Azure VMware Solution private clouds, or on the Internet. In this article, you learn how your Gen 2 private cloud gets connectivity to your on-premises environments.
13+
You require network connectivity between the your Azure VMware Solution Generation 2 (Gen 2) private cloud and other networks you deployed in an Azure Virtual Network, on-premises, other Azure VMware Solution private clouds, or on the Internet. In this article, you learn how your Gen 2 private cloud gets connectivity to your on-premises environments.
1414

1515
## Prerequisites
1616

articles/azure-vmware/native-connect-private-cloud-previous-edition.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@ title: Connect Azure VMware Solution Generation 2 private clouds to Azure VMware
33
description: Learn about connecting Azure VMware Solution Generation 2 private clouds to Azure VMware Solution Generation 1 private clouds.
44
ms.topic: how-to
55
ms.service: azure-vmware
6-
ms.date: 4/15/2025
6+
ms.date: 4/21/2025
77
ms.author: jacobjaygbay
88
#customer intent: As a cloud administrator, I want to connect Azure VMware Solution Generation 2 private clouds to Azure VMware Solution Generation 1 private clouds so that I can enable seamless communication between private clouds.
99
---
1010

1111
# Connect Azure VMware Solution Generation 2 private clouds to Azure VMware Solution Generation 1 private clouds
1212

13-
In this article, you learn how to connect Azure VMware Solution Generation (Gen) 2 private clouds to Azure VMware Solution Gen 1 private clouds. After you deploy an Azure VMware Solution Gen 2 private cloud, you may need to have network connectivity between the private cloud and other networks you have in an Azure Virtual Network, on-premises, other Azure VMware Solution private clouds, or the internet.
13+
In this article, you learn how to connect Azure VMware Solution Generation 2 (Gen 2) private clouds to Azure VMware Solution Gen 1 private clouds. After you deploy an Azure VMware Solution Gen 2 private cloud, you may need to have network connectivity between the private cloud and other networks you have in an Azure Virtual Network, on-premises, other Azure VMware Solution private clouds, or the internet.
1414

1515
This article discusses how the Azure VMware Solution Gen 2 private cloud gets connectivity to Azure VMware Solution Gen 1 private cloud.
1616

articles/azure-vmware/native-create-azure-vmware-virtual-network-private-cloud.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@ ms.author: jacobjaygbay
55
description: Learn how to create an Azure VMware Solution Generation 2 Private Cloud to apply Azure's infrastructure and VMware expertise effectively.
66
ms.topic: how-to
77
ms.service: azure-vmware
8-
ms.date: 4/15/2025
8+
ms.date: 4/21/2025
99
ms.custom: engagement-fy25
1010
#customer intent: As a cloud administrator, I want to create an Azure VMware Solution Generation 2 Private Cloud so that I can leverage Azure's infrastructure and VMware expertise.
1111
---
1212

1313
# Create an Azure VMware Solution Generation 2 Private Cloud (preview)
1414

15-
In this tutorial, you learn how to create an Azure VMware Solution Generation (Gen) 2 Private Cloud. This solution combines the first-party Azure VMware Solution with Azure hardware and network to simplify your networking architecture, and enhance performance and security. This initial launch of this generation utilizes the AV64 SKU.
15+
In this tutorial, you learn how to create an Azure VMware Solution Generation 2 (Gen 2) private cloud. This solution combines the first-party Azure VMware Solution with Azure hardware and network to simplify your networking architecture, and enhance performance and security. This initial launch of this generation utilizes the AV64 SKU.
1616

1717
With this generation, you can directly create the private cloud using the AV64 SKU. You are no longer required to deploy a minimum of three hosts of AV36, AV36P, or AV52 to provision a cluster with AV64.
1818

articles/azure-vmware/native-dns-forward-lookup-zone.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@ title: Private and Public DNS forward lookup zone configuration
33
description: Learn about DNS forward lookup zone for Azure VMware Solution Generation 2 private clouds.
44
ms.topic: how-to
55
ms.service: azure-vmware
6-
ms.date: 4/15/2025
6+
ms.date: 4/21/2025
77
ms.custom: engagement-fy25
88
# customer intent: As a cloud administrator, I want to configure DNS forward lookup zone for Azure VMware Solution Generation 2 private clouds so that I can manage domain name resolution for private cloud appliances.
99
---
1010

1111
# Private and Public DNS forward lookup zone configuration
1212

13-
In this article, you learn how to configure a Domain Name System (DNS) forward lookup zones for Azure VMware Solution Generation (Gen) 2 private cloud appliances. It explains the options and behaviors for domain name resolution within an Azure Virtual Network.
13+
In this article, you learn how to configure a Domain Name System (DNS) forward lookup zones for Azure VMware Solution Generation 2 (Gen 2) private clouds. It explains the options and behaviors for domain name resolution within an Azure Virtual Network.
1414

1515
## Prerequisite
1616

articles/azure-vmware/native-first-party-principle-security.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@ title: Enable first-party application service principal for Azure VMware Solutio
33
description: Learn about enabling first-party application service principal for Azure VMware Solution Generation 2 Private Clouds.
44
ms.topic: how-to
55
ms.service: azure-vmware
6-
ms.date: 4/2/2025
6+
ms.date: 4/21/2025
77
#cusom intent: As a cloud administrator, I want to enable first-party application service principal for Azure VMware Solution Generation 2 Private Clouds so that I can manage the Azure VMware Solution experiences.
88
---
99

1010
# Enable first-party application service principal for Azure VMware Solution Generation 2 Private Clouds
1111

12-
In this article, you learn how to re-enable the Azure VMware Solution service principal. This service principal is required to be enabled to deploy the Azure VMware Solution Generation (Gen) 2 Private Clouds. If you're already familiar with how to enable service principal, re-enable the service principal for application ID '1a5e141d-70dd-4594-8442-9fc46fa48686' with name 'Avs Fleet Rp'.
12+
In this article, you learn how to re-enable the Azure VMware Solution service principal. This service principal is required to be enabled to deploy the Azure VMware Solution Generation 2 (Gen 2) private clouds. If you're already familiar with how to enable service principal, re-enable the service principal for application ID '1a5e141d-70dd-4594-8442-9fc46fa48686' with name 'Avs Fleet Rp'.
1313

1414
## Prerequisite
1515

articles/azure-vmware/native-internet-connectivity-design-considerations.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@ title: Internet Configuration for Azure VMware Solution Generation 2 Private Clo
33
description: Learn about Azure VMware Solution in an Azure Virtual Network Internet connectivity configuration.
44
ms.topic: how-to
55
ms.service: azure-vmware
6-
ms.date: 4/15/2025
6+
ms.date: 4/21/2025
77
ms.custom: engagement-fy25
88
---
99

1010
# Connect to Internet
1111

12-
After you deploy an Azure VMware Solution Generation (Gen) 2 private cloud, you may require network connectivity between the private cloud and other networks you have in an Azure Virtual Network, on-premises, other Azure VMware Solution private clouds, or the internet. In this article, you learn to connect Azure VMware Solution on an Azure Virtual Network private cloud to the internet.
12+
After you deploy an Azure VMware Solution Generation 2 (Gen 2) private cloud, you may require network connectivity between the private cloud and other networks you have in an Azure Virtual Network, on-premises, other Azure VMware Solution private clouds, or the internet. In this article, you learn to connect Azure VMware Solution on an Azure Virtual Network private cloud to the internet.
1313

1414
## Prerequisites
1515
- Gen 2 private cloud deployed successfully.

0 commit comments

Comments
 (0)