Skip to content

Commit c7d1c30

Browse files
authored
Merge pull request #100999 from HeidiSteen/heidist-vnet
Azure Cog Search: private endpoint H2 changes, paragraph relocation
2 parents 5bcd108 + d41da5e commit c7d1c30

File tree

1 file changed

+25
-17
lines changed

1 file changed

+25
-17
lines changed

articles/search/service-create-private-endpoint.md

Lines changed: 25 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,18 @@ ms.date: 01/13/2020
1313

1414
# Create a Private Endpoint for a secure connection to Azure Cognitive Search (Preview)
1515

16-
[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/virtual-network-ip-addresses-overview-arm.md#private-ip-addresses) 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.
16+
In this article, use the portal to create a new Azure Cognitive Search service instance that can't be accessed via a public IP address. Next, configure an Azure virtual machine in the same virtual network, and use it to access the search service via a private endpoint.
1717

1818
> [!Important]
19-
> Private Endpoint support for Azure Cognitive Search is available as a limited-access preview and not currently intended for production use. Please fill out and submit the [access request form](https://aka.ms/SearchPrivateLinkRequestAccess) if you would like to access the preview. The form requests information about you, your company, and general application architecture. Once we review your request, you'll receive a confirmation email with additional instructions.
19+
> Private Endpoint support for Azure Cognitive Search is available [upon request](https://aka.ms/SearchPrivateLinkRequestAccess) as a limited-access preview. Preview features are provided without a service level agreement, and are not recommended for production workloads. For more information, see [Supplemental Terms of Use for Microsoft Azure Previews](https://azure.microsoft.com/support/legal/preview-supplemental-terms/).
2020
>
21-
> Once you are granted access to the preview, you'll be able to configure Private Endpoints for your service using the Azure portal and REST API version [2019-10-06-Preview](search-api-preview.md).
21+
> Once you are granted access to the preview, you'll be able to configure Private Endpoints for your service using the Azure portal or the [Management REST API version 2019-10-06-Preview](https://docs.microsoft.com/rest/api/searchmanagement/).
2222
>
2323
24+
## Why use Private Endpoint for secure access?
25+
26+
[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/virtual-network-ip-addresses-overview-arm.md#private-ip-addresses) 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+
2428
Private endpoints for your search service enables you to:
2529

2630
- Block all connections on the public endpoint for your search service.
@@ -32,16 +36,18 @@ Private endpoints for your search service enables you to:
3236
> * Available only for search services on the **Basic** tier.
3337
> * Available in the West US 2, West Central US, East US, South Central US, Australia East, and Australia Southeast regions.
3438
> * When the service endpoint is private, some portal features are disabled. You'll be able to view and manage service level information, but portal access to index data and the various components in the service, such as the index, indexer, and skillset definitions, is restricted for security reasons.
35-
> * When the service endpoint is private, you must use the search API to upload documents to the index.
39+
> * When the service endpoint is private, you must use the [Search REST API](https://docs.microsoft.com/rest/api/searchservice/) to upload documents to the index.
3640
> * You must use the following link to see the private endpoint support option in the Azure portal: https://portal.azure.com/?feature.enablePrivateEndpoints=true
3741
38-
In this article, you'll learn how to use the portal to create a new Azure Cognitive Search service instance that can't be accessed via a public IP address, configure an Azure virtual machine in the same virtual network, and use it to access the search service via a private endpoint.
3942

4043

41-
## Create a VM
42-
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.
44+
## Request access
4345

44-
### Create the virtual network
46+
Click [request access](https://aka.ms/SearchPrivateLinkRequestAccess) to sign up for this preview feature. The form requests information about you, your company, and general network topology. Once we review your request, you'll receive a confirmation email with additional instructions.
47+
48+
## Create the virtual network
49+
50+
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.
4551

4652
1. From the Azure portal home tab, select **Create a resource** > **Networking** > **Virtual network**.
4753

@@ -61,7 +67,7 @@ In this section, you will create a virtual network and subnet to host the VM tha
6167
1. Leave the rest as default and select **Create**.
6268

6369

64-
## Create your search service with a private endpoint
70+
## Create a search service with a private endpoint
6571

6672
In this section, you will create a new Azure Cognitive Search service with a Private Endpoint.
6773

@@ -115,9 +121,9 @@ In this section, you will create a new Azure Cognitive Search service with a Pri
115121

116122
1. Select **Keys** from the left content menu.
117123

118-
1. Copy the **Primary admin key** for later.
124+
1. Copy the **Primary admin key** for later, when connecting to the service.
119125

120-
### Create a virtual machine
126+
## Create a virtual machine
121127

122128
1. On the upper-left side of the screen in the Azure portal, select **Create a resource** > **Compute** > **Virtual machine**.
123129

@@ -166,9 +172,9 @@ In this section, you will create a new Azure Cognitive Search service with a Pri
166172
1. When you see the **Validation passed** message, select **Create**.
167173

168174

169-
## Connect to a VM from the internet
175+
## Connect to the VM
170176

171-
Connect to the VM *myVm* from the internet as follows:
177+
Download and then connect to the VM *myVm* as follows:
172178

173179
1. In the portal's search bar, enter *myVm*.
174180

@@ -192,10 +198,12 @@ Connect to the VM *myVm* from the internet as follows:
192198
1. Once the VM desktop appears, minimize it to go back to your local desktop.
193199

194200

195-
## Access the search service privately from the VM
201+
## Test connections
196202

197203
In this section, you will verify private network access to the search service and connect privately to the using the Private Endpoint.
198204

205+
Recall from the introduction that all interactions with the search service require the [Search REST API](https://docs.microsoft.com/rest/api/searchservice/). The portal and .NET SDK are not supported in this preview.
206+
199207
1. In the Remote Desktop of *myVM*, open PowerShell.
200208

201209
1. Enter 'nslookup [search service name].search.windows.net'
@@ -209,14 +217,14 @@ In this section, you will verify private network access to the search service an
209217
Address: 10.0.0.5
210218
Aliases: [search service name].search.windows.net
211219
```
212-
1. Follow this [Quickstart](search-get-started-postman.md) from the VM to create a new search index in your service in Postman using the REST API. Use the key you copied in a previous step to authenticate to the service.
213220
214-
1. Try several of these same requests in Postman on your local workstation.
221+
1. From the VM, connect to the search service and create an index. You can follow this [quickstart](search-get-started-postman.md) to create a new search index in your service in Postman using the REST API. Setting up requests from Postman requires the search service endpoint (https://[search service name].search.windows.net) and the admin api-key you copied in a previous step.
215222
216-
1. If you are able to complete the Quickstart from the VM, but receive an error that the remote server does not exist on your local workstation, you have successfully configured a private endpoint for your search service.
223+
1. Completing the quickstart from the VM is your confirmation that the service is fully operational.
217224
218225
1. Close the remote desktop connection to *myVM*.
219226
227+
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.
220228
221229
## Clean up resources
222230
When you're done using the Private Endpoint, search service, and the VM, delete the resource group and all of the resources it contains:

0 commit comments

Comments
 (0)