Skip to content

Commit 4d2f87f

Browse files
author
Jill Grant
authored
Merge pull request #265052 from khelanmodi/vCore-privateLinkGA
vCore Private Link GA doc update
2 parents db80502 + 4013d38 commit 4d2f87f

File tree

3 files changed

+46
-54
lines changed

3 files changed

+46
-54
lines changed
70.6 KB
Loading

articles/cosmos-db/mongodb/vcore/how-to-private-link.md

Lines changed: 46 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
title: Use Azure Private Link
33
titleSuffix: Azure Cosmos DB for MongoDB vCore
44
description: Use Azure Private Link to connect to Azure Cosmos DB for MongoDB vCore over a private endpoint in a virtual network.
5-
author: gahl-levy
6-
ms.author: gahllevy
5+
author: khelanmodi
6+
ms.author: khelanmodi
77
ms.reviewer: sidandrews
88
ms.service: cosmos-db
99
ms.subservice: mongodb-vcore
@@ -13,7 +13,7 @@ ms.date: 11/01/2023
1313
# CustomerIntent: As a security administrator, I want to use Azure Private Link so that I can ensure that database connections occur over privately-managed virtual network endpoints.
1414
---
1515

16-
# Use Azure Private Link in Azure Cosmos DB for MongoDB vCore
16+
# Enable Private access in Azure Cosmos DB for MongoDB vCore
1717

1818
[!INCLUDE[MongoDB vCore](../../includes/appliesto-mongodb-vcore.md)]
1919

@@ -31,78 +31,78 @@ To establish a connection, Azure Cosmos DB for MongoDB vCore with Private Link s
3131
- An existing Azure Cosmos DB for MongoDB vCore cluster.
3232
- If you don't have an Azure subscription, [create an account for free](https://azure.microsoft.com/free).
3333
- If you have an existing Azure subscription, [create a new Azure Cosmos DB for MongoDB vCore cluster](quickstart-portal.md).
34-
- Access to an active Virtual network and Subnet.
35-
- If you don’t have a Virtual network, [create a virtual network using the Azure portal](../../../virtual-network/quick-create-portal.md)
36-
- Verify your access to Azure Cosmos DB for MongoDB vCore Private Endpoint.
37-
- If you don’t have access, you can request it by following the steps below.
3834

3935

40-
## Requesting Access to Azure Cosmos DB for MongoDB vCore Private Endpoint via Azure Portal
36+
## Create a cluster with a private endpoint by using the Azure portal
4137

42-
To request access for a private endpoint for an existing Azure Cosmos DB for MongoDB vCore cluster, follow these steps using the Azure portal:
38+
Follow these steps to create a new Azure Cosmos DB for MongoDB vCore cluster with a private endpoint by using the Azure portal:
4339

44-
1. Sign in to the [Azure portal](https://portal.azure.com), and search for **Preview Features** in the search bar.
40+
1. Sign in to the [Azure portal](https://portal.azure.com), then select **Create a resource** in the upper left-hand corner of the Azure portal.
4541

46-
1. Choose **Azure Cosmos DB for MongoDB vCore Private Endpoint** from the available options list and click "register."
42+
1. On the **Create a resource** page, select **Databases** and then select **Azure Cosmos DB**.
4743

48-
1. You will receive a notification once access to the Private Endpoint is granted.
44+
1. On the Select API option page, on the **MongoDB** tile, select Create.
4945

46+
1. Choose the **vCore cluster** resource type.
5047

51-
## Create a private endpoint by using the Azure portal
48+
1. On the **Create an Azure Cosmos DB for MongoDB vCore** cluster page, select or create a **Resource group**, enter a **Cluster name** and Location, and enter and confirm the administrator Password.
5249

53-
Follow these steps to create a private endpoint for an existing Azure Cosmos DB for MongoDB vCore cluster by using the Azure portal:
50+
1. Select Next: **Networking**.
5451

55-
1. Sign in to the [Azure portal](https://portal.azure.com), then select an Azure Cosmos DB for MongoDB vCore cluster.
52+
1. Select **Networking** tab, for Connectivity method, select **Private access**.
5653

57-
1. Select **Networking** from the list of settings, and then select **Visit Link Center** under the **Private Endpoints** section:
58-
59-
1. In the **Create a private endpoint - Basics** pane, enter or select the following details:
54+
1. On the Create private endpoint screen, enter or select appropriate values for:
6055

6156
| Setting | Value |
6257
| ------- | ----- |
63-
| **Project details** | |
64-
| Subscription | Select your subscription. |
6558
| Resource group | Select a resource group.|
66-
| **Instance details** | |
6759
| Name | Enter any name for your private endpoint. If this name is taken, create a unique one. |
6860
| Network Interface name | Enter any name for your Network Interface. If this name is taken, create a unique one. |
69-
| Region | Select the region where you want to deploy Private Link. Create the private endpoint in the same location where your virtual network exists.|
61+
| Location | Select the region where you want to deploy Private Link. Create the private endpoint in the same location where your virtual network exists.|
62+
| Target subresource | Select the type of subresource for the resource selected previously that your private endpoint should have the ability to access. |
63+
| Virtual network | Select your virtual network. |
64+
| Subnet | Select your subnet. |
65+
| Integrate with private DNS zone | Select **Yes**. To connect privately with your private endpoint, you need a DNS record. We recommend that you integrate your private endpoint with a private DNS zone. You can also use your own DNS servers or create DNS records by using the host files on your virtual machines. When you select yes for this option, a private DNS zone group is also created. DNS zone group is a link between the private DNS zone and the private endpoint. This link helps you to auto update the private DNS zone when there's an update to the private endpoint. For example, when you add or remove regions, the private DNS zone is automatically updated. |
66+
| Configuration name |Select your subscription and resource group. The private DNS zone is determined automatically. You can't change it by using the Azure portal.|
7067

71-
1. Select **Next: Resource**.
68+
1. Select **Ok**.
7269

73-
1. In the **Create a private endpoint - Resource** pane, enter or select the following details:
70+
1. Select **Next: Tags** > **Review + create**. On the **Review + create** page, then select **Create**.
7471

75-
| Setting | Value |
76-
| ------- | ----- |
77-
| Connection Method | Choose one of your resources or connect to someone else's resource with a resource ID or alias that is shared with you. |
78-
| Subscription | Select the subscription containing the resource you're connecting to.|
79-
| Resource Type | Select the resource type you're connecting to. |
80-
| Resource | Select the resource type you're connecting to. |
81-
| Target subresource | Select the type of subresource for the resource selected previously that your private endpoint should have the ability to access. |
72+
## Enable private access on an existing cluster
8273

83-
1. Select **Next: Virtual Network**.
74+
To create a private endpoint to a node in an existing cluster, open the
75+
**Networking** page for the cluster.
8476

85-
1. In the **Create a private endpoint - Virtual Network** pane, enter or select this information:
77+
1. Select **Add private endpoint**.
8678

87-
| Setting | Value |
88-
| ------- | ----- |
89-
| Virtual network| Select your virtual network. |
90-
| Subnet | Select your subnet. |
79+
:::image type="content" source="media/howto-private-access/networking.jpg" alt-text="Screenshot of selecting Add private endpoint on the Networking screen.":::
9180

92-
1. Select **Next: DNS**.
81+
2. On the **Basics** tab of the **Create a private endpoint** screen, confirm the **Subscription**, **Resource group**, and
82+
**Region**. Enter a **Name** for the endpoint, such as *my-cluster-1*, and a **Network interface name**, such as *my-cluster-1-nic*.
9383

94-
1. In the **Create a private endpoint - DNS** pane, enter or select this information:
84+
> [!NOTE]
85+
>
86+
> Unless you have a good reason to choose otherwise, we recommend picking a
87+
> subscription and region that match those of your cluster. The
88+
> default values for the form fields might not be correct. Check them and
89+
> update if necessary.
9590
96-
| Setting | Value |
97-
| ------- | ----- |
98-
| Integrate with private DNS zone | Select **Yes**. To connect privately with your private endpoint, you need a DNS record. We recommend that you integrate your private endpoint with a private DNS zone. You can also use your own DNS servers or create DNS records by using the host files on your virtual machines. When you select yes for this option, a private DNS zone group is also created. DNS zone group is a link between the private DNS zone and the private endpoint. This link helps you to auto update the private DNS zone when there's an update to the private endpoint. For example, when you add or remove regions, the private DNS zone is automatically updated. |
99-
| Configuration name |Select your subscription and resource group. The private DNS zone is determined automatically. You can't change it by using the Azure portal.|
91+
3. Select **Next: Resource**. For **Target sub-resource**, choose the target
92+
node of the cluster. Usually **coordinator** is the desired node.
93+
94+
4. Select **Next: Virtual Network**. Choose the desired **Virtual network** and
95+
**Subnet**. Under **Private IP configuration**, select **Statically allocate IP address** or keep the default, **Dynamically allocate IP address**.
96+
97+
5. Select **Next: DNS**.
10098

101-
1. Select **Next: Tags** > **Review + create**. On the **Review + create** page, Azure validates your configuration.
99+
6. Under **Private DNS integration**, for **Integrate with private DNS zone**, keep the default **Yes** or select **No**.
102100

103-
1. When you see the **Validation passed** message, select **Create**.
101+
7. Select **Next: Tags**, and add any desired tags.
102+
103+
8. Select **Review + create**. Review the settings, and select
104+
**Create** when satisfied.
104105

105-
When you have an approved Private Endpoint for an Azure Cosmos DB account, in the Azure portal, the **All networks** option in the **Firewall and virtual networks** pane is unavailable.
106106

107107
## Create a private endpoint by using Azure CLI
108108

@@ -187,14 +187,6 @@ az network private-link-resource list \
187187
--type Microsoft.DocumentDB/mongoClusters
188188
```
189189

190-
## View private endpoints by using the Azure portal
191-
192-
Follow these steps to view a private endpoint for an existing Azure Cosmos DB account by using the Azure portal:
193-
194-
1. Sign in to the [Azure portal](https://portal.azure.com), then select Private Link under Azure Services.
195-
196-
1. Select **Private Endpoint** from the list of settings to view all Private endpoints.
197-
198190
## Next step
199191

200192
> [!div class="nextstepaction"]
205 KB
Loading

0 commit comments

Comments
 (0)