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/search/service-create-private-endpoint.md
+42-28Lines changed: 42 additions & 28 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,38 +2,43 @@
2
2
title: Create a Private Endpoint for a secure connection
3
3
titleSuffix: Azure Cognitive Search
4
4
description: Set up a private endpoint in a virtual network for a secure connection to an Azure Cognitive Search service.
5
-
author: nitinme
6
-
ms.author: nitinme
5
+
author: HeidiSteen
6
+
ms.author: heidist
7
7
manager: nitinme
8
8
ms.service: cognitive-search
9
9
ms.topic: conceptual
10
-
ms.date: 02/16/2021
10
+
ms.date: 09/12/2022
11
11
---
12
12
13
13
# Create a Private Endpoint for a secure connection to Azure Cognitive Search
14
14
15
-
In this article, you'll use the Azure portal to create a new Azure Cognitive Search service instance that can't be accessed via the internet. Next, you'll configure an Azure virtual machine in the same virtual network and use it to access the search service via a private endpoint.
15
+
In this article, you'll learn how to secure an Azure Cognitive Search service so that it can't be accessed over the internet:
16
16
17
-
Private endpoints are provided by [Azure Private Link](../private-link/private-link-overview.md), as a separate service. For more information about costs, see the [pricing page](https://azure.microsoft.com/pricing/details/private-link/).
17
+
+[Create an Azure virtual network](#create-the-virtual-network) or use an existing one
18
+
+[Create or update a search service to use a private endpoint](#create-a-search-service-with-a-private-endpoint)
19
+
+[Configure an Azure virtual machine in the same virtual network](#create-a-virtual-machine)
20
+
+[Connect to the search service using a browser session on the virtual machine](#connect-to-the-vm)
21
+
22
+
Private endpoints are provided by [Azure Private Link](../private-link/private-link-overview.md), as a separate billable service. For more information about costs, see the [pricing page](https://azure.microsoft.com/pricing/details/private-link/).
18
23
19
24
You can create a private endpoint in the Azure portal, as described in this article. Alternatively, you can use the [Management REST API version 2020-03-13](/rest/api/searchmanagement/), [Azure PowerShell](/powershell/module/az.search), or [Azure CLI](/cli/azure/search).
20
25
21
26
> [!NOTE]
22
-
> To access a search service using a private endpoint through the portal, [use the portal inside the virtual network](#portal-access-private-search-service)
27
+
> Once a search service is configured for private link, portal access a search service must be initiated from a browser session on a virtual machine inside the virtual network. See [this step](#portal-access-private-search-service) for details.
23
28
24
29
## Why use a Private Endpoint for secure access?
25
30
26
31
[Private Endpoints](../private-link/private-endpoint-overview.md) for Azure Cognitive Search allow a client on a virtual network to securely access data in a search index over a [Private Link](../private-link/private-link-overview.md). The private endpoint uses an IP address from the [virtual network address space](../virtual-network/ip-services/private-ip-addresses.md) for your search service. Network traffic between the client and the search service traverses over the virtual network and a private link on the Microsoft backbone network, eliminating exposure from the public internet. For a list of other PaaS services that support Private Link, check the [availability section](../private-link/private-link-overview.md#availability) in the product documentation.
27
32
28
-
Private endpoints for your search service enables you to:
33
+
Private endpoints for your search service enable you to:
29
34
30
-
- Block all connections on the public endpoint for your search service.
31
-
- Increase security for the virtual network, by enabling you to block exfiltration of data from the virtual network.
32
-
- Securely connect to your search service from on-premises networks that connect to the virtual network using [VPN](../vpn-gateway/vpn-gateway-about-vpngateways.md) or [ExpressRoutes](../expressroute/expressroute-locations.md) with private-peering.
35
+
+ Block all connections on the public endpoint for your search service.
36
+
+ Increase security for the virtual network, by enabling you to block exfiltration of data from the virtual network.
37
+
+ Securely connect to your search service from on-premises networks that connect to the virtual network using [VPN](../vpn-gateway/vpn-gateway-about-vpngateways.md) or [ExpressRoutes](../expressroute/expressroute-locations.md) with private-peering.
33
38
34
39
## Create the virtual network
35
40
36
-
In this section, you will create a virtual network and subnet to host the VM that will be used to access your search service's private endpoint.
41
+
In this section, you'll create a virtual network and subnet to host the VM that will be used to access your search service's private endpoint.
37
42
38
43
1. From the Azure portal home tab, select **Create a resource** > **Networking** > **Virtual network**.
39
44
@@ -47,11 +52,11 @@ In this section, you will create a virtual network and subnet to host the VM tha
47
52
| Region | Select your desired region |
48
53
|||
49
54
50
-
1. Leave the defaults for the rest of the settings. Click**Review + create** and then **Create**
55
+
1. Leave the defaults for the rest of the settings. Select**Review + create** and then **Create**
51
56
52
57
## Create a search service with a private endpoint
53
58
54
-
In this section, you will create a new Azure Cognitive Search service with a Private Endpoint.
59
+
In this section, you'll create a new Azure Cognitive Search service with a Private Endpoint.
55
60
56
61
1. On the upper-left side of the screen in the Azure portal, select **Create a resource** > **Web** > **Azure Cognitive Search**.
57
62
@@ -61,7 +66,7 @@ In this section, you will create a new Azure Cognitive Search service with a Pri
61
66
| ------- | ----- |
62
67
|**PROJECT DETAILS**||
63
68
| Subscription | Select your subscription. |
64
-
| Resource group | Select **myResourceGroup**. You created this in the previous section.|
69
+
| Resource group | Select **myResourceGroup**, which you created in the previous section.|
65
70
|**INSTANCE DETAILS**||
66
71
| URL | Enter a unique name. |
67
72
| Location | Select your desired region. |
@@ -76,15 +81,15 @@ In this section, you will create a new Azure Cognitive Search service with a Pri
76
81
77
82
1. In **New Search Service - Networking**, select **+ Add** under **Private endpoint**.
78
83
79
-
1. In **Create Private Endpoint**, enter or select this information:
84
+
1. In **Create Private Endpoint**, enter or select the following values:
80
85
81
86
| Setting | Value |
82
87
| ------- | ----- |
83
88
| Subscription | Select your subscription. |
84
-
| Resource group | Select **myResourceGroup**. You created this in the previous section.|
89
+
| Resource group | Select **myResourceGroup**, which you created in the previous section.|
85
90
| Location | Select **West US**.|
86
91
| Name | Enter *myPrivateEndpoint*. |
87
-
| Target sub-resource| Leave the default **searchService**. |
92
+
| Target subresource| Leave the default **searchService**. |
88
93
|**NETWORKING**||
89
94
| Virtual network | Select *MyVirtualNetwork* from resource group *myResourceGroup*. |
90
95
| Subnet | Select *mySubnet*. |
@@ -99,7 +104,7 @@ In this section, you will create a new Azure Cognitive Search service with a Pri
99
104
100
105
1. When you see the **Validation passed** message, select **Create**.
101
106
102
-
1. Once provisioning of your new service is complete, browse to the resource that you just created.
107
+
1. Once provisioning of your new service is complete, browse to the resource that you created.
103
108
104
109
1. Select **Keys** from the left content menu.
105
110
@@ -111,16 +116,16 @@ In this section, you will create a new Azure Cognitive Search service with a Pri
111
116
112
117
1. On the upper-left side of the screen in the Azure portal, select **Create a resource** > **Compute** > **Virtual machine**.
113
118
114
-
1. In **Create a virtual machine - Basics**, enter or select this information:
119
+
1. In **Create a virtual machine - Basics**, enter or select the following values:
115
120
116
121
| Setting | Value |
117
122
| ------- | ----- |
118
123
|**PROJECT DETAILS**||
119
124
| Subscription | Select your subscription. |
120
-
| Resource group | Select **myResourceGroup**. You created this in the previous section. |
125
+
| Resource group | Select **myResourceGroup**, which you created in the previous section. |
121
126
|**INSTANCE DETAILS**||
122
127
| Virtual machine name | Enter *myVm*. |
123
-
| Region | Select **West US** or whatever region you are using. |
128
+
| Region | Select **West US** or whatever region you're using. |
| Image | Select **Windows Server 2019 Datacenter**. |
126
131
| Size | Leave the default **Standard DS1 v2**. |
@@ -189,16 +194,17 @@ Download and then connect to the VM *myVm* as follows:
189
194
190
195
## Test connections
191
196
192
-
In this section, you will verify private network access to the search service and connect privately to the using the Private Endpoint.
197
+
In this section, you'll verify private network access to the search service and connect privately to the using the Private Endpoint.
193
198
194
199
When the search service endpoint is private, some portal features are disabled. You'll be able to view and manage service level settings, but portal access to index data and various other components in the service, such as the index, indexer, and skillset definitions, is restricted for security reasons.
195
200
196
201
1. In the Remote Desktop of *myVM*, open PowerShell.
197
202
198
-
1. Enter 'nslookup [search service name].search.windows.net'
203
+
1. Enter `nslookup [search service name].search.windows.net`.
199
204
200
205
You'll receive a message similar to this:
201
-
```azurepowershell
206
+
207
+
```
202
208
Server: UnKnown
203
209
Address: 168.63.129.16
204
210
Non-authoritative answer:
@@ -213,22 +219,30 @@ When the search service endpoint is private, some portal features are disabled.
213
219
214
220
1. Close the remote desktop connection to *myVM*.
215
221
216
-
1. To verify that your service is not accessible on a public endpoint, open Postman on your local workstation and attempt the first several tasks in the quickstart. If you receive an error that the remote server does not exist, you have successfully configured a private endpoint for your search service.
222
+
1. To verify that your service isn't accessible on a public endpoint, open Postman on your local workstation and attempt the first several tasks in the quickstart. If you receive an error that the remote server doesn't exist, you've successfully configured a private endpoint for your search service.
217
223
218
224
<a id="portal-access-private-search-service"></a>
219
225
220
226
## Use the Azure portal to access a private search service
221
227
222
-
When the search service endpoint is private, some portal features are disabled. You can view and manage service level information, but index, indexer, and skillset information is hidden for security reasons. To work around this restriction, connect to Azure portal from a browser on a virtual machine inside the virtual network. The portal uses the private endpoint on the connection and gives you visibility into content and operations.
228
+
When the search service endpoint is private, some portal features are disabled. You can view and manage service level information, but index, indexer, and skillset information is hidden for security reasons.
229
+
230
+
To work around this restriction, connect to Azure portal from a browser on a virtual machine inside the virtual network. The portal uses the private endpoint on the connection and gives you visibility into content and operations.
223
231
224
232
1. Follow the [steps to provision a VM that can access the search service through a private endpoint](#create-virtual-machine-private-endpoint).
233
+
225
234
1. On a virtual machine in your virtual network, open a browser and sign into the Azure portal. The portal will use the private endpoint attached to the virtual machine to connect to your search service.
226
235
227
-
## Clean up resources
236
+
## Clean up resources
237
+
228
238
When you're done using the Private Endpoint, search service, and the VM, delete the resource group and all of the resources it contains:
229
-
1. Enter *myResourceGroup* in the **Search** box at the top of the portal and select *myResourceGroup* from the search results.
239
+
240
+
1. Enter *myResourceGroup* in the **Search** box at the top of the portal and select *myResourceGroup* from the search results.
241
+
230
242
1. Select **Delete resource group**.
243
+
231
244
1. Enter *myResourceGroup* for **TYPE THE RESOURCE GROUP NAME** and select **Delete**.
232
245
233
246
## Next steps
247
+
234
248
In this article, you created a VM on a virtual network and a search service with a Private Endpoint. You connected to the VM from the internet and securely communicated to the search service using Private Link. To learn more about Private Endpoint, see [What is Azure Private Endpoint?](../private-link/private-endpoint-overview.md).
0 commit comments