Create a private endpoint for a secure connection to Azure AI Search

  • Article

In this article, learn how to configure a private connection to Azure AI Search so that it admits requests from clients in a virtual network instead of over a public internet connection:

Other Azure resources that might privately connect to Azure AI Search include Azure OpenAI for "use your own data" scenarios. Azure OpenAI Studio doesn't run in a virtual network, but it can be configured on the backend to send requests over the Microsoft Azure backbone network. Configuration for this traffic pattern is enabled by Azure when your request is submitted and approved. For this scenario:

  • Follow the instructions in this article to set up the private endpoint.
  • Submit a request for Azure OpenAI Studio to connect using your private endpoint.
  • Optionally, disable public network access if connections should only originate from clients in virtual network or from Azure OpenAI over a private endpoint connection.

Key points about private endpoints

Private endpoints are provided by Azure Private Link, as a separate billable service. For more information about costs, see the pricing page.

Once a search service has a private endpoint, portal access to that service must be initiated from a browser session on a virtual machine inside the virtual network. See this step for details.

You can create a private endpoint for a search service in the Azure portal, as described in this article. Alternatively, you can use the Management REST API version, Azure PowerShell, or Azure CLI.

Why use a private endpoint?

Private Endpoints for Azure AI Search allow a client on a virtual network to securely access data in a search index over a Private Link. The private endpoint uses an IP address from the virtual network address space 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 Azure backbone network, eliminating exposure from the public internet. For a list of other PaaS services that support Private Link, check the availability section in the product documentation.

Private endpoints for your search service enable you to:

  • Block all connections on the public endpoint for your search service.
  • Increase security for the virtual network, by enabling you to block exfiltration of data from the virtual network.
  • Securely connect to your search service from on-premises networks that connect to the virtual network using VPN or ExpressRoutes with private-peering.

Create the virtual network

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.

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

  2. In Create virtual network, enter or select the following values:

    Setting Value
    Subscription Select your subscription.
    Resource group Select Create new, enter a name, such as "myResourceGroup", then select OK.
    Name Enter a name, such as "MyVirtualNetwork".
    Region Select a region.

  3. Accept the defaults for the rest of the settings. Select Review + create and then Create.

Create a search service with a private endpoint

In this section, you'll create a new Azure AI Search service with a Private Endpoint.

  1. On the upper-left side of the screen in the Azure portal, select Create a resource > Web > Azure AI Search.

  2. In New Search Service - Basics, enter or select the following values:

    Setting Value
    PROJECT DETAILS
    Subscription Select your subscription.
    Resource group Use the resource group that you created in the previous step.
    INSTANCE DETAILS
    URL Enter a unique name.
    Location Select your region.
    Pricing tier Select Change Pricing Tier and choose your desired service tier. Private endpoints aren't supported on the Free tier. You must select Basic or higher.

  3. Select Next: Scale.

  4. Accept the defaults and select Next: Networking.

  5. In New Search Service - Networking, select Private for Endpoint connectivity(data).

  6. Select + Add under Private endpoint.

  7. In Create Private Endpoint, enter or select values that associate your search service with the virtual network you created:

    Setting Value
    Subscription Select your subscription.
    Resource group Use the resource group that you created in the previous step.
    Location Select a region.
    Name Enter a name, such as "myPrivateEndpoint".
    Target subresource Accept the default searchService.
    NETWORKING
    Virtual network Select the virtual network you created in the previous step.
    Subnet Select the default.
    PRIVATE DNS INTEGRATION
    Integrate with private DNS zone Accept the default "Yes".
    Private DNS zone Accept the default (New) privatelink.search.azure.cn.

  8. Select OK.

  9. Select Review + create. You're taken to the Review + create page where Azure validates your configuration.

  10. When you see the Validation passed message, select Create.

  11. Once provisioning of your new service is complete, browse to the resource that you created.

  12. Select Keys from the left content menu.

  13. Copy the Primary admin key for later, when connecting to the service.

Create a virtual machine

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

  2. In Create a virtual machine - Basics, enter or select the following values:

    Setting Value
    PROJECT DETAILS
    Subscription Select your subscription.
    Resource group Use the resource group that you created in the previous section.
    INSTANCE DETAILS
    Virtual machine name Enter a name, such as "my-vm".
    Region Select your region.
    Availability options You can choose No infrastructure redundancy required, or select another option if you need the functionality.
    Image Select Windows Server 2022 Datacenter: Azure Edition - Gen2.
    VM architecture Accept the default x64.
    Size Accept the default Standard D2S v3.
    ADMINISTRATOR ACCOUNT
    Username Enter the user name of the administrator. Use an account that's valid for your Azure subscription. You'll want to sign in to the Azure portal from the VM so that you can manage your search service.
    Password Enter the account password. The password must be at least 12 characters long and meet the defined complexity requirements.
    Confirm Password Reenter password.
    INBOUND PORT RULES
    Public inbound ports Accept the default Allow selected ports.
    Select inbound ports Accept the default RDP (3389).

  3. Select Next: Disks.

  4. In Create a virtual machine - Disks, accept the defaults and select Next: Networking.

  5. In Create a virtual machine - Networking, provide the following values:

    Setting Value
    Virtual network Select the virtual network you created in a previous step.
    Subnet Accept the default (10.1.0.0/24).
    NIC network security group Accept the default "Basic"
    Public IP Accept the default "(new) myVm-ip".
    Public inbound ports Select the default "Allow selected ports".
    Select inbound ports Select "HTTP 80", "HTTPS (443)" and "RDP (3389)".

    Note

    IPv4 addresses can be expressed in CIDR format. Remember to avoid the IP range reserved for private networking, as described in RFC 1918:

    • 10.0.0.0 - 10.255.255.255 (10/8 prefix)
    • 172.16.0.0 - 172.31.255.255 (172.16/12 prefix)
    • 192.168.0.0 - 192.168.255.255 (192.168/16 prefix)

  6. Select Review + create for a validation check.

  7. When you see the Validation passed message, select Create.

Connect to the VM

Download and then connect to the virtual machine as follows:

  1. In the portal's search bar, search for the virtual machine created in the previous step.

  2. Select Connect. After selecting the Connect button, Connect to virtual machine opens.

  3. Select Download RDP File. Azure creates a Remote Desktop Protocol (.rdp) file and downloads it to your computer.

  4. Open the downloaded .rdp file.

    1. If prompted, select Connect.

    2. Enter the username and password you specified when creating the VM.

      Note

      You may need to select More choices > Use a different account, to specify the credentials you entered when you created the VM.

  5. Select OK.

  6. You may receive a certificate warning during the sign-in process. If you receive a certificate warning, select Yes or Continue.

  7. Once the VM desktop appears, minimize it to go back to your local desktop.

Test connections

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

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.

  1. In the Remote Desktop of myVM, open PowerShell.

  2. Enter nslookup [search service name].search.azure.cn.

    You'll receive a message similar to this:

    Server:  UnKnown
Address:  168.63.129.16
Non-authoritative answer:
Name:    [search service name].privatelink.search.azure.cn
Address:  10.0.0.5
Aliases:  [search service name].search.azure.cn

  3. From the VM, connect to the search service and create an index. You can follow this quickstart to create a new search index in your service using the REST API. Setting up requests from a Web API test tool requires the search service endpoint (https://[search service name].search.azure.cn) and the admin api-key you copied in a previous step.

  4. Completing the quickstart from the VM is your confirmation that the service is fully operational.

  5. Close the remote desktop connection to myVM.

  6. To verify that your service isn't accessible on a public endpoint, open a REST client 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.

Use the Azure portal to access a private search service

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 are 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.

  1. Follow the steps to provision a VM that can access the search service through a private endpoint.

  2. On a virtual machine in your virtual network, open a browser and sign in to the Azure portal. The portal will use the private endpoint attached to the virtual machine to connect to your search service.

Disable public network access

You can lock down a search service to prevent it from admitting any request from the public internet. You can use the Azure portal for this step.

  1. In the Azure portal, on the leftmost pane of your search service page, select Networking.

  2. Select Disabled on the Firewalls and virtual networks tab.

You can also use the Azure CLI, Azure PowerShell, or the Management REST API, setting public-access or public-network-access to disabled.

Clean up resources

When you're working in your own subscription, it's a good idea at the end of a project to identify whether you still need the resources you created. Resources left running can cost you money.

You can delete individual resources or the resource group to delete everything you created in this exercise. Select the resource group on any resource's overview page, and then select Delete.

Next steps

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?.