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/cosmos-db/mongodb/vcore/how-to-private-link.md
+46-54Lines changed: 46 additions & 54 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,8 +2,8 @@
2
2
title: Use Azure Private Link
3
3
titleSuffix: Azure Cosmos DB for MongoDB vCore
4
4
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
7
7
ms.reviewer: sidandrews
8
8
ms.service: cosmos-db
9
9
ms.subservice: mongodb-vcore
@@ -13,7 +13,7 @@ ms.date: 11/01/2023
13
13
# 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.
14
14
---
15
15
16
-
# Use Azure Private Link in Azure Cosmos DB for MongoDB vCore
16
+
# Enable Private access in Azure Cosmos DB for MongoDB vCore
@@ -31,78 +31,78 @@ To establish a connection, Azure Cosmos DB for MongoDB vCore with Private Link s
31
31
- An existing Azure Cosmos DB for MongoDB vCore cluster.
32
32
- If you don't have an Azure subscription, [create an account for free](https://azure.microsoft.com/free).
33
33
- 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.
38
34
39
35
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
41
37
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:
43
39
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.
45
41
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**.
47
43
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.
49
45
46
+
1. Choose the **vCore cluster** resource type.
50
47
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.
52
49
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**.
54
51
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**.
56
53
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:
60
55
61
56
| Setting | Value |
62
57
| ------- | ----- |
63
-
|**Project details**||
64
-
| Subscription | Select your subscription. |
65
58
| Resource group | Select a resource group.|
66
-
|**Instance details**||
67
59
| Name | Enter any name for your private endpoint. If this name is taken, create a unique one. |
68
60
| 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.|
70
67
71
-
1. Select **Next: Resource**.
68
+
1. Select **Ok**.
72
69
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**.
74
71
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
82
73
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.
84
76
85
-
1.In the **Create a private endpoint - Virtual Network** pane, enter or select this information:
77
+
1.Select **Add private endpoint**.
86
78
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.":::
91
80
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*.
93
83
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.
95
90
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**.
100
98
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**.
102
100
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.
104
105
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.
106
106
107
107
## Create a private endpoint by using Azure CLI
108
108
@@ -187,14 +187,6 @@ az network private-link-resource list \
187
187
--type Microsoft.DocumentDB/mongoClusters
188
188
```
189
189
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.
0 commit comments