Skip to content

Commit 07b0d91

Browse files
authored
Merge pull request #114528 from mrcarter8/master
Updated for Private Endpoint GA and IP Whitelisting
2 parents 745860b + 51c7684 commit 07b0d91

File tree

5 files changed

+71
-32
lines changed

5 files changed

+71
-32
lines changed

articles/search/TOC.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -315,6 +315,8 @@
315315
href: search-security-overview.md
316316
- name: Create a private endpoint
317317
href: service-create-private-endpoint.md
318+
- name: Configure an IP firewall
319+
href: service-configure-firewall.md
318320
- name: Service key management
319321
href: search-security-api-keys.md
320322
- name: Role-based admin access
242 KB
Loading
225 KB
Loading
Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
---
2+
title: Configure an IP firewall for your Azure Cognitive Search service
3+
titleSuffix: Azure Cognitive Search
4+
description: Configure IP control policies to restrict access to your Azure Cognitive Search service.
5+
6+
manager: nitinme
7+
author: mrcarter8
8+
ms.author: mcarter
9+
ms.service: cognitive-search
10+
ms.topic: conceptual
11+
ms.date: 05/11/2020
12+
---
13+
14+
# Configure IP firewall for Azure Cognitive Search
15+
16+
Azure Cognitive Search supports IP rules for inbound firewall support. This model provides an additional layer of security for your search service similar to the IP rules you'll find in an Azure virtual network security group. With these IP rules, you can configure your search service to be accessible only from an approved set of machines and/or cloud services. Access to data stored in your search service from these approved sets of machines and services will still require the caller to present a valid authorization token.
17+
18+
> [!Important]
19+
> IP rules on your Azure Cognitive Search service can be configured using the Azure portal or the [Management REST API version 2020-03-13](https://docs.microsoft.com/rest/api/searchmanagement/).
20+
21+
## <a id="configure-ip-policy"></a> Configure an IP firewall using the Azure portal
22+
23+
To set the IP access control policy in the Azure portal, go to your Azure Cognitive Search service page and select **Networking** on the navigation menu. Endpoint networking connectivity must be **Public**. If your connectivity is set to **Private**, you can only access your search service via a Private Endpoint.
24+
25+
![Screenshot showing how to configure the IP firewall in the Azure portal](./media/service-configure-firewall/azure-portal-firewall.png)
26+
27+
The Azure portal provides the ability to specify IP addresses and IP address ranges in the CIDR format. An example of CIDR notation is 8.8.8.0/24, which represents the IPs that range from 8.8.8.0 to 8.8.8.255.
28+
29+
> [!NOTE]
30+
> After you enable the IP access control policy for your Azure Cognitive Search service, all requests to the data plane from machines outside the allowed list of IP address ranges are rejected. When IP rules are configured, some features of the Azure portal 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.
31+
32+
### Requests from your current IP
33+
34+
To simplify development, the Azure portal helps you identify and add the IP of your client machine to the allowed list. Apps running on your machine can then access your Azure Cognitive Search service.
35+
36+
The portal automatically detects your client IP address. It might be the client IP address of your machine or network gateway. Make sure to remove this IP address before you take your workload to production.
37+
38+
To add your current IP to the list of IPs, check **Add your client IP address**. Then select **Save**.
39+
40+
![Screenshot showing a how to configure IP firewall settings to allow the current IP](./media/service-configure-firewall/enable-current-ip.png)
41+
42+
## <a id="troubleshoot-ip-firewall"></a>Troubleshoot issues with an IP access control policy
43+
44+
You can troubleshoot issues with an IP access control policy by using the following options:
45+
46+
### Azure portal
47+
48+
Enabling an IP access control policy for your Azure Cognitive Search service blocks all requests from machines outside the allowed list of IP address ranges, including the Azure portal. 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.
49+
50+
### SDKs
51+
52+
When you access Azure Cognitive Search service using the SDK from machines that are not in the allowed list, a generic **403 Forbidden** response is returned with no additional details. Verify the allowed IP list for your account, and make sure that the correct configuration updated for your search service.
53+
54+
## Next steps
55+
56+
For more information on accessing your search service via Private Link, see the following article:
57+
58+
* [Create a Private Endpoint for a secure connection to Azure Cognitive Search](service-create-private-endpoint.md)

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

Lines changed: 11 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -8,20 +8,17 @@ author: mrcarter8
88
ms.author: mcarter
99
ms.service: cognitive-search
1010
ms.topic: conceptual
11-
ms.date: 01/13/2020
11+
ms.date: 05/11/2020
1212
---
1313

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

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.
16+
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.
1717

1818
> [!Important]
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/).
20-
>
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/).
22-
>
19+
> Private Endpoint support for Azure Cognitive Search can be configured using the Azure portal or the [Management REST API version 2020-03-13](https://docs.microsoft.com/rest/api/searchmanagement/). 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.
2320
24-
## Why use Private Endpoint for secure access?
21+
## Why use a Private Endpoint for secure access?
2522

2623
[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.
2724

@@ -31,20 +28,6 @@ Private endpoints for your search service enables you to:
3128
- Increase security for the virtual network, by enabling you to block exfiltration of data from the virtual network.
3229
- 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.
3330

34-
> [!NOTE]
35-
> There are currently some limitations in the preview that you should be aware of:
36-
> * Available only for search services on the **Basic** tier.
37-
> * Available in the West US 2, West Central US, East US, South Central US, Australia East, and Australia Southeast regions.
38-
> * 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.
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.
40-
> * You must use the following link to see the private endpoint support option in the Azure portal: https://portal.azure.com/?feature.enablePrivateEndpoints=true
41-
42-
43-
44-
## Request access
45-
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-
4831
## Create the virtual network
4932

5033
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.
@@ -55,17 +38,13 @@ In this section, you will create a virtual network and subnet to host the VM tha
5538

5639
| Setting | Value |
5740
| ------- | ----- |
58-
| Name | Enter *MyVirtualNetwork* |
59-
| Address space | Enter *10.1.0.0/16* |
6041
| Subscription | Select your subscription|
6142
| Resource group | Select **Create new**, enter *myResourceGroup*, then select **OK** |
62-
| Location | Select **West US** or whatever region you are using|
63-
| Subnet - Name | Enter *mySubnet* |
64-
| Subnet - Address range | Enter *10.1.0.0/24* |
43+
| Name | Enter *MyVirtualNetwork* |
44+
| Region | Select your desired region |
6545
|||
6646

67-
1. Leave the rest as default and select **Create**.
68-
47+
1. Leave the defaults for the rest of the settings. Click **Review + create** and then **Create**
6948

7049
## Create a search service with a private endpoint
7150

@@ -82,8 +61,8 @@ In this section, you will create a new Azure Cognitive Search service with a Pri
8261
| Resource group | Select **myResourceGroup**. You created this in the previous section.|
8362
| **INSTANCE DETAILS** | |
8463
| URL | Enter a unique name. |
85-
| Location | Select the region that you specified when requesting access to this preview feature. |
86-
| Pricing tier | Select **Change Pricing Tier** and choose **Basic**. This tier is required for the preview. |
64+
| Location | Select your desired region. |
65+
| Pricing tier | Select **Change Pricing Tier** and choose your desired service tier. (Not support on **Free** tier. Must be **Basic** or higher.) |
8766
|||
8867

8968
1. Select **Next: Scale**.
@@ -202,7 +181,7 @@ Download and then connect to the VM *myVm* as follows:
202181

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

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.
184+
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.
206185

207186
1. In the Remote Desktop of *myVM*, open PowerShell.
208187

0 commit comments

Comments
 (0)