Skip to content

Commit 0fa10ff

Browse files
committed
fixed links
1 parent 259f005 commit 0fa10ff

File tree

2 files changed

+10
-9
lines changed

2 files changed

+10
-9
lines changed

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ A shared private link is:
3333
+ Approved by the Azure PaaS resource owner
3434
+ Used internally on a connection to a specific Azure resource
3535

36-
Only your search service can use the private links that it creates.
36+
Only your search service can use the private links that it creates, and there can be only one shared private link for each resource and sub-resource combination.
3737

3838
Once you set up the private link, it's used automatically whenever search connects to that PaaS resource. You don't need to modify the connection string or alter the client you're using to issue the requests, although the device used for the connection must connect using an authorized IP in the Azure PaaS resource's firewall.
3939

@@ -63,7 +63,7 @@ You can create a shared private link for the following resources.
6363
| Resource type | Sub-resource (or Group ID) |
6464
|-----------------------------------|----------------------------|
6565
| Microsoft.Storage/storageAccounts <sup>1</sup> | `blob`, `table`, `dfs`, `file` |
66-
| Microsoft.DocumentDB/databaseAccounts <sup>w</sup>| `sql` |
66+
| Microsoft.DocumentDB/databaseAccounts <sup>2</sup>| `sql` |
6767
| Microsoft.Sql/servers | `sqlServer` |
6868
| Microsoft.KeyVault/vaults | `vault` |
6969
| Microsoft.DBforMySQL/servers (preview) | `mysqlServer`|
@@ -134,13 +134,13 @@ When you complete these steps, you have a shared private link that's provisioned
134134

135135
See [Manage with REST](search-manage-rest.md) for instructions on setting up a REST client for issuing Management REST API requests.
136136

137-
First, review any existing shared private links to ensure you're not duplicating a link. There can be only one shared private link for each resource and sub-resource combination.
137+
First, use [Get](/rest/api/searchmanagement/2020-08-01/shared-private-link-resources/get) to review any existing shared private links to ensure you're not duplicating a link. There can be only one shared private link for each resource and sub-resource combination.
138138

139139
```http
140140
GET https://https://management.azure.com/subscriptions/{{subscriptionId}}/resourceGroups/{{rg-name}}/providers/Microsoft.Search/searchServices/{{service-name}}/sharedPrivateLinkResources?api-version={{api-version}}
141141
```
142142

143-
Create a shared private link, providing the name of the link on the URI, and the target resource in the body of the request. The following example is for blob storage.
143+
Use [Create or Update](/rest/api/searchmanagement/2020-08-01/shared-private-link-resources/create-or-update) for the next step, providing the name of the link name on the URI, and the target Azure resource in the body of the request. The following example is for blob storage.
144144

145145
```http
146146
PUT https://https://management.azure.com/subscriptions/{{subscriptionId}}/resourceGroups/{{rg-name}}/providers/Microsoft.Search/searchServices/{{service-name}}/sharedPrivateLinkResources/{{shared-private-link-name}}?api-version={{api-version}}
@@ -164,13 +164,13 @@ Rerun the first request to monitor the provisioning state as it transitions from
164164

165165
See [Manage with PowerShell](search-manage-powershell.md) for instructions on getting started.
166166

167-
First, review any existing shared private links to ensure you're not duplicating a link. There can be only one shared private link for each resource and sub-resource combination.
167+
First, use [Get-AzSearchSharedPrivateLinkResource](/powershell/module/az.search/get-azsearchprivatelinkresource) to review any existing shared private links to ensure you're not duplicating a link. There can be only one shared private link for each resource and sub-resource combination.
168168

169169
```azurepowershell
170170
Get-AzSearchSharedPrivateLinkResource -ResourceGroupName <search-service-resource-group-name> -ServiceName <search-service-name>
171171
```
172172

173-
Create a shared private link, substituting valid values for the placeholders. This example is for blob storage.
173+
Use [New-AzSearchSharedPrivateLinkResource](/powershell/module/az.search/new-azsearchsharedprivatelinkresource) to create a shared private link, substituting valid values for the placeholders. This example is for blob storage.
174174

175175
```azurepowershell
176176
New-AzSearchSharedPrivateLinkResource -ResourceGroupName <search-service-resource-group-name> -ServiceName <search-service-name> -Name <spl-name> -PrivateLinkResourceId /subscriptions/<alphanumeric-subscription-ID>/resourceGroups/<storage-resource-group-name>/providers/Microsoft.Storage/storageAccounts/myBlobStorage -GroupId blob -RequestMessage "Please approve"
@@ -219,7 +219,7 @@ Be sure to specify the correct group ID for the type of resource for which you'r
219219

220220
### Shared private link for Azure SQL Managed Instances
221221

222-
When you're 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) of the SQL Managed Instance. See [Create an Azure SQL Managed Instance](azure/azure-sql/managed-instance/instance-create-quickstart) for instructions on how to retrieve connection details, such as the DNS zone. If the FQDN of the SQL Managed Instance is `my-sql-managed-instance.a1b22c333d44.database.windows.net`, the `resourceRegion` should be `a1b22c333d44`.
222+
When you're 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) of the SQL Managed Instance. See [Create an Azure SQL Managed Instance](/azure/azure-sql/managed-instance/instance-create-quickstart) for instructions on how to retrieve connection details, such as the DNS zone. If the FQDN of the SQL Managed Instance is `my-sql-managed-instance.a1b22c333d44.database.windows.net`, the `resourceRegion` should be `a1b22c333d44`.
223223

224224
```json
225225
{

articles/search/troubleshoot-shared-private-link-resources.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,17 +53,18 @@ Some common errors that occur during the creation phase are listed below.
5353
| Azure Storage | `Microsoft.Storage/storageAccounts`| `2020-08-01` |
5454
| Azure Cosmos DB | `Microsoft.DocumentDb/databaseAccounts`| `2020-08-01` |
5555
| Azure SQL Database | `Microsoft.Sql/servers`| `2020-08-01` |
56-
| Azure Database for MySQL (preview) | `Microsoft.DBforMySQL/servers`| `2020-08-01-Preview` |
5756
| Azure Key Vault | `Microsoft.KeyVault/vaults` | `2020-08-01` |
57+
| Azure Database for MySQL (preview) | `Microsoft.DBforMySQL/servers`| `2020-08-01-Preview` |
5858
| Azure Functions (preview) | `Microsoft.Web/sites` | `2020-08-01-Preview` |
59+
| Azure SQL Managed Instance (preview) | `Microsoft.Sql/managedInstance` | `2020-08-01-Preview` |
5960

6061
In addition, the specified `groupId` needs to be valid for the specified resource type. For example, `groupId` "blob" is valid for type "Microsoft.Storage/storageAccounts", it can't be used with any other resource type. For a given search management API version, customers can find out the supported `groupId` and resource type details by utilizing the [List supported API](/rest/api/searchmanagement/2021-04-01-preview/private-link-resources/list-supported).
6162

6263
+ Quota limit enforcement: Search services have quotas imposed on the distinct number of shared private link resources that can be created and the number of various target resource types that are being used (based on `groupId`). These are documented in the [Shared private link resource limits section](search-limits-quotas-capacity.md#shared-private-link-resource-limits) of the Azure Cognitive Search service limits page.
6364

6465
## Deployment failures
6566

66-
A search service initiates the request to create a shared private link, but Azure Resource Manager performs the actual work. You can [check the deployment's status](search-indexer-howto-access-private.md#check-endpoint-status) in the portal or by query, and address any errors that might occur.
67+
A search service initiates the request to create a shared private link, but Azure Resource Manager performs the actual work. You can [check the deployment's status](search-indexer-howto-access-private.md#1---create-a-shared-private-link) in the portal or by query, and address any errors that might occur.
6768

6869
Shared private link resources that have failed Azure Resource Manager deployment will show up in [List](/rest/api/searchmanagement/2021-04-01-preview/shared-private-link-resources/list-by-service) and [Get](/rest/api/searchmanagement/2021-04-01-preview/shared-private-link-resources/get) API calls, but will have a "Provisioning State" of `Failed`. Once the reason of the Azure Resource Manager deployment failure has been ascertained, delete the `Failed` resource and re-create it after applying the appropriate resolution from the following table.
6970

0 commit comments

Comments
 (0)