Private Link Resources - List Supported
Gets a list of all supported private link resource types for the given service.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/privateLinkResources?api-version=2024-03-01-preview
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
resource
|
path | True |
string |
The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. |
search
|
path | True |
string |
The name of the Azure AI Search service associated with the specified resource group. Regex pattern: |
subscription
|
path | True |
string |
The unique identifier for a Microsoft Azure subscription. You can obtain this value from the Azure Resource Manager API or the portal. |
api-version
|
query | True |
string |
The API version to use for each request. |
Request Header
Name | Required | Type | Description |
---|---|---|---|
x-ms-client-request-id |
string uuid |
A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
The operation succeeded. The response contains the list of all supported private link resource types for the given service. |
|
Other Status Codes |
An unexpected error occurred during the operation. |
Security
azure_auth
Specifies an implicit grant flow, as supported on the Microsoft Identity platform.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | impersonate your user account |
Examples
ListSupportedPrivateLinkResources
Sample request
GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/privateLinkResources?api-version=2024-03-01-preview
Sample response
{
"value": [
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/privateLinkResources/searchService",
"name": "searchService",
"type": "Microsoft.Search/searchServices/privateLinkResources",
"properties": {
"groupId": "searchService",
"requiredMembers": [
"searchService"
],
"requiredZoneNames": [
"privatelink.search.windows.net"
],
"shareablePrivateLinkResourceTypes": [
{
"name": "blob",
"properties": {
"type": "Microsoft.Storage/storageAccounts",
"groupId": "blob",
"description": "Azure AI Search indexers can connect to blobs in Azure Storage for reading data from an indexer data source, for writing intermediate results of indexer execution or for storing any knowledge store projections."
}
},
{
"name": "table",
"properties": {
"type": "Microsoft.Storage/storageAccounts",
"groupId": "table",
"description": "Azure AI Search indexers can connect to tables in Azure Storage for reading data from an indexer data source, for writing intermediate results of indexer execution or for storing any knowledge store projections."
}
},
{
"name": "Sql",
"properties": {
"type": "Microsoft.DocumentDB/databaseAccounts",
"groupId": "Sql",
"description": "Azure AI Search indexers can connect to Azure Cosmos DB API for NoSQL for reading data from an indexer data source."
}
},
{
"name": "plr",
"properties": {
"type": "Microsoft.Sql/servers",
"groupId": "sqlServer",
"description": "Azure AI Search indexers can connect to Azure SQL database on a server for reading data from an indexer data source."
}
},
{
"name": "vault",
"properties": {
"type": "Microsoft.KeyVault/vaults",
"groupId": "vault",
"description": "Azure AI Search can access keys in Azure Key Vault to encrypt sensitive data in a search index and synonym map data."
}
},
{
"name": "plr",
"properties": {
"type": "Microsoft.DBforMySQL/servers",
"groupId": "mysqlServer",
"description": "Azure AI Search indexers can connect to MySQL databases for reading data from an indexer data source."
}
},
{
"name": "site",
"properties": {
"type": "Microsoft.Web/sites",
"groupId": "sites",
"description": "For custom skills that connect to an app service, you can specify sites as the group ID."
}
}
]
}
}
]
}
Definitions
Name | Description |
---|---|
Cloud |
Contains information about an API error. |
Cloud |
Describes a particular API error with an error code and a message. |
Private |
Describes a supported private link resource for the Azure AI Search service. |
Private |
Describes the properties of a supported private link resource for the Azure AI Search service. For a given API version, this represents the 'supported' groupIds when creating a shared private link resource. |
Private |
Response containing a list of supported Private Link Resources. |
Shareable |
Describes the properties of a resource type that has been onboarded to private link service, supported by Azure AI Search. |
Shareable |
Describes an resource type that has been onboarded to private link service, supported by Azure AI Search. |
CloudError
Contains information about an API error.
Name | Type | Description |
---|---|---|
error |
Describes a particular API error with an error code and a message. |
|
message |
string |
A brief description of the error that hints at what went wrong (for details/debugging information refer to the 'error.message' property). |
CloudErrorBody
Describes a particular API error with an error code and a message.
Name | Type | Description |
---|---|---|
code |
string |
An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. |
details |
Contains nested errors that are related to this error. |
|
message |
string |
A message that describes the error in detail and provides debugging information. |
target |
string |
The target of the particular error (for example, the name of the property in error). |
PrivateLinkResource
Describes a supported private link resource for the Azure AI Search service.
Name | Type | Description |
---|---|---|
id |
string |
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
The name of the resource |
properties |
Describes the properties of a supported private link resource for the Azure AI Search service. |
|
type |
string |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
PrivateLinkResourceProperties
Describes the properties of a supported private link resource for the Azure AI Search service. For a given API version, this represents the 'supported' groupIds when creating a shared private link resource.
Name | Type | Description |
---|---|---|
groupId |
string |
The group ID of the private link resource. |
requiredMembers |
string[] |
The list of required members of the private link resource. |
requiredZoneNames |
string[] |
The list of required DNS zone names of the private link resource. |
shareablePrivateLinkResourceTypes |
The list of resources that are onboarded to private link service, that are supported by Azure AI Search. |
PrivateLinkResourcesResult
Response containing a list of supported Private Link Resources.
Name | Type | Description |
---|---|---|
value |
The list of supported Private Link Resources. |
ShareablePrivateLinkResourceProperties
Describes the properties of a resource type that has been onboarded to private link service, supported by Azure AI Search.
Name | Type | Description |
---|---|---|
description |
string |
The description of the resource type that has been onboarded to private link service, supported by Azure AI Search. |
groupId |
string |
The resource provider group id for the resource that has been onboarded to private link service, supported by Azure AI Search. |
type |
string |
The resource provider type for the resource that has been onboarded to private link service, supported by Azure AI Search. |
ShareablePrivateLinkResourceType
Describes an resource type that has been onboarded to private link service, supported by Azure AI Search.
Name | Type | Description |
---|---|---|
name |
string |
The name of the resource type that has been onboarded to private link service, supported by Azure AI Search. |
properties |
Describes the properties of a resource type that has been onboarded to private link service, supported by Azure AI Search. |