Skip to content

Commit 608f277

Browse files
Merge pull request #224943 from mattmsft/mattmsft/add-sql-mi-pe-docs
Add documentation on how to create a shared private link for SQL Managed Instance
2 parents 005a513 + d7cc2a5 commit 608f277

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

articles/search/search-indexer-howto-access-private.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,13 +59,16 @@ When setting up a shared private link resource, make sure the group ID value is
5959
| Azure Database for MySQL (preview) | `mysqlServer`|
6060
| Azure Key Vault for [customer-managed keys](search-security-manage-encryption-keys.md) | `vault` |
6161
| Azure Functions (preview) <sup>3</sup> | `sites` |
62+
| Azure SQL Managed Instance (preview) <sup>4</sup> | `managedInstance` |
6263

6364
<sup>1</sup> If you enabled [enrichment caching](cognitive-search-incremental-indexing-conceptual.md) and the connection to Azure Blob Storage is through a private endpoint, make sure there is a shared private link of type `blob`.
6465

6566
<sup>2</sup> If you're projecting data to a [knowledge store](knowledge-store-concept-intro.md) and the connection to Azure Blob Storage and Azure Table Storage is through a private endpoint, make sure there are two shared private links of type `blob` and `table`, respectively.
6667

6768
<sup>3</sup> Azure Functions (preview) refers to Functions under a Consumption, Premium and Dedicated [App Service plan](../app-service/overview-hosting-plans.md). The [App Service Environment (ASE)](../app-service/environment/overview.md) and [Azure Kubernetes Service (AKS)](../aks/intro-kubernetes.md) are not supported at this time.
6869

70+
<sup>4</sup> Creating a shared private link to Azure SQL Managed Instance (preview) requires using the Azure CLI.
71+
6972
> [!TIP]
7073
> You can query for the list of supported resources and group IDs by using the [list of supported APIs](/rest/api/searchmanagement/2021-04-01-preview/private-link-resources/list-supported).
7174
@@ -116,6 +119,20 @@ The definition of a shared private link is provided in a JSON file. The followin
116119
}
117120
```
118121

122+
When creating a shared private link to SQL Managed Instance, the `resourceRegion` parameter is required. This parameter comes from the [DNS Zone](/azure/azure-sql/managed-instance/connectivity-architecture-overview#virtual-cluster-connectivity-architecture) of the [Fully Qualified Domain Name (FQDN)](/azure-sql/managed-instance/instance-create-quickstart#retrieve-connection-details-to-sql-managed-instance) of the SQL Managed Instance. For example, if the FQDN of the SQL Managed Instance is `my-sql-managed-instance.a1b22c333d44.database.windows.net`, the `resourceRegion` should be `a1b22c333d44`.
123+
124+
```json
125+
{
126+
"name": "sql-mi-pe",
127+
"properties": {
128+
"privateLinkResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Sql/managedInstances/contoso-sql-mi",
129+
"resourceRegion": "f1a3eb11c964",
130+
"groupId": "managedInstance",
131+
"requestMessage": "please approve",
132+
}
133+
}
134+
```
135+
119136
A `202 Accepted` response is returned on success. The process of creating an outbound private endpoint is a long-running (asynchronous) operation. It involves deploying the following resources:
120137

121138
+ A private endpoint, allocated with a private IP address in a `"Pending"` state. The private IP address is obtained from the address space that's allocated to the virtual network of the execution environment for the search service-specific private indexer. Upon approval of the private endpoint, any communication from Azure Cognitive Search to the Azure resource originates from the private IP address and a secure private link channel.

0 commit comments

Comments
 (0)