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/how-to-configure-private-endpoints.md
+13-13Lines changed: 13 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,7 @@ By using Azure Private Link, you can connect to an Azure Cosmos DB account throu
20
20
21
21
Private Link allows users to access an Azure Cosmos DB account from within the virtual network or from any peered virtual network. Resources mapped to Private Link are also accessible on-premises over private peering through VPN or Azure ExpressRoute.
22
22
23
-
You can connect to an Azure Cosmos DB account configured with Private Link by using the automatic or manual approval method. To learn more, see the [Approval workflow](../private-link/private-endpoint-overview.md#access-to-a-private-link-resource-using-approval-workflow) section of the Private Link documentation.
23
+
You can connect to an Azure Cosmos DB account configured with Private Link by using the automatic or manual approval method. To learn more, see the [approval workflow](../private-link/private-endpoint-overview.md#access-to-a-private-link-resource-using-approval-workflow) section of the Private Link documentation.
24
24
25
25
This article describes how to set up private endpoints for Azure Cosmos DB transactional store. It assumes that you're using the automatic approval method. If you're using the analytical store, see [Configure private endpoints for the analytical store](analytical-store-private-endpoints.md).
26
26
@@ -47,7 +47,7 @@ Follow these steps to create a private endpoint for an existing Azure Cosmos DB
47
47
48
48
1. Select **Next: Resource**.
49
49
50
-
1. In **Create a private endpoint - Resource**, enter or select this information:
50
+
1. In the **Create a private endpoint - Resource** pane, enter or select this information:
51
51
52
52
| Setting | Value |
53
53
| ------- | ----- |
@@ -59,7 +59,7 @@ Follow these steps to create a private endpoint for an existing Azure Cosmos DB
59
59
60
60
1. Select **Next: Virtual Network**.
61
61
62
-
1. In **Create a private endpoint - Virtual Network**, enter or select this information:
62
+
1. In the **Create a private endpoint - Virtual Network** pane, enter or select this information:
63
63
64
64
| Setting | Value |
65
65
| ------- | ----- |
@@ -68,7 +68,7 @@ Follow these steps to create a private endpoint for an existing Azure Cosmos DB
68
68
69
69
1. Select **Next: DNS**.
70
70
71
-
1. In **Create a private endpoint - DNS**, enter or select this information:
71
+
1. In the **Create a private endpoint - DNS** pane, enter or select this information:
72
72
73
73
| Setting | Value |
74
74
| ------- | ----- |
@@ -85,7 +85,7 @@ When you have an approved Private Link for an Azure Cosmos DB account, in the Az
85
85
86
86
The following table shows the mapping between different Azure Cosmos DB account API types, supported subresources, and the corresponding private zone names. You can also access the Gremlin and API for Table accounts through the API for NoSQL, so there are two entries for these APIs. There's also an extra entry for the API for NoSQL for accounts using the [dedicated gateway](./dedicated-gateway.md).
87
87
88
-
|Azure Cosmos DB account API type |Supported subresources (or group IDs)|Private zone name |
88
+
|Azure Cosmos DB account API type |Supported subresources or group IDs |Private zone name |
@@ -107,8 +107,8 @@ After the private endpoint is provisioned, you can query the IP addresses. To vi
107
107
108
108
Multiple IP addresses are created per private endpoint:
109
109
110
-
* One for the global (region-agnostic) endpoint of the Azure Cosmos DB account
111
-
* One for each region where the Azure Cosmos DB account is deployed
110
+
* One for the global region-agnostic endpoint of the Azure Cosmos DB account.
111
+
* One for each region where the Azure Cosmos DB account is deployed.
112
112
113
113
## Create a private endpoint by using Azure PowerShell
114
114
@@ -422,7 +422,7 @@ After the template is deployed successfully, you can see an output similar to wh
422
422
423
423
After the template is deployed, the private IP addresses are reserved within the subnet. The firewall rule of the Azure Cosmos DB account is configured to accept connections from the private endpoint only.
424
424
425
-
### Integrate the private endpoint with a Private DNS zone
425
+
### Integrate the private endpoint with a private DNS zone
426
426
427
427
Use the following code to create a Resource Manager template named *PrivateZone_template.json*. This template creates a private DNS zone for an existing Azure Cosmos DB API for NoSQL account in an existing virtual network.
You should use a private DNS zone within the subnet where you've created the private endpoint. Configure the endpoints so that each private IP address is mapped to a DNS entry. See the `fqdns` property in the response shown earlier.
634
+
You should use a private DNS zone within the subnet where you've created the private endpoint. Configure the endpoints so that each private IP address is mapped to a DNS entry. See the *fqdns* property in the response shown earlier.
635
635
636
636
When you're creating the private endpoint, you can integrate it with a private DNS zone in Azure. If you choose to instead use a custom DNS zone, you have to configure it to add DNS records for all private IP addresses reserved for the private endpoint.
637
637
@@ -658,20 +658,20 @@ For an example showing how to use this flag, see [this Azure Resource Manager te
658
658
659
659
## Adding private endpoints to an existing Azure Cosmos DB account with no downtime
660
660
661
-
By default, adding a private endpoint to an existing account results in a short downtime of approximately 5 minutes. Follow these instructions to avoid this downtime:
661
+
By default, adding a private endpoint to an existing account results in a short downtime of approximately five minutes. Follow these instructions to avoid this downtime:
662
662
663
663
1. Add IP or virtual network rules to your firewall configuration to explicitly allow your client connections.
664
664
1. Wait for 10 minutes to ensure that the configuration update is applied.
665
665
1. Configure your new private endpoint.
666
-
1. Remove the firewall rules set at step 1.
666
+
1. Remove the firewall rules set in step 1.
667
667
668
668
## Port range when using direct mode
669
669
670
670
When you use Private Link with an Azure Cosmos DB account through a direct mode connection, you need to ensure that the full range of TCP ports (0 - 65535) is open.
671
671
672
672
## Update a private endpoint when you add or remove a region
673
673
674
-
For example, if you deploy an Azure Cosmos DB account in three regions: *West US*, *Central US*, and *West Europe*. When you create a private endpoint for your account, four private IPs are reserved in the subnet. There's one IP for each of the three regions, and there's one IP for the global/region-agnostic endpoint. Later, you might add a new region to the Azure Cosmos DB account. The private DNS zone is updated as follows:
674
+
There are three regions for Azure Cosmos DB account deployments: *West US*, *Central US*, and *West Europe*. When you create a private endpoint for your account, four private IPs are reserved in the subnet. There's one IP for each of the three regions, and there's one IP for the globalregion-agnostic endpoint. Later, you might add a new region to the Azure Cosmos DB account. The private DNS zone is updated as follows:
675
675
676
676
-**If private DNS zone group is used:**
677
677
@@ -685,7 +685,7 @@ For example, if you deploy an Azure Cosmos DB account in three regions: *West US
685
685
686
686
## Current limitations
687
687
688
-
The following limitations apply when you're using Private Link with an Azure Cosmos DB account:
688
+
The following limitations apply when you use Private Link with an Azure Cosmos DB account:
689
689
690
690
* You can't have more than 200 private endpoints on a single Azure Cosmos DB account.
0 commit comments