你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Private Link Resources - List Supported
获取给定服务的所有受支持的专用链接资源类型的列表。
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/privateLinkResources?api-version=2023-11-01
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
resource
|
path | True |
string |
当前订阅中资源组的名称。 可以从 Azure 资源管理器 API 或门户获取此值。 |
search
|
path | True |
string |
与指定资源组关联的搜索服务的名称。 |
subscription
|
path | True |
string |
Microsoft Azure 订阅的唯一标识符。 可以从 Azure 资源管理器 API、命令行工具或门户获取此值。 |
api-version
|
query | True |
string |
要用于每个请求的 API 版本。 |
请求头
名称 | 必需 | 类型 | 说明 |
---|---|---|---|
x-ms-client-request-id |
string uuid |
客户端生成的用于标识此请求的 GUID 值。 如果指定,则会将其包含在响应信息中,作为跟踪请求的一种方式。 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
操作成功。 响应包含给定服务支持的所有专用链接资源类型的列表。 |
|
Other Status Codes |
操作期间出现意外错误。 |
安全性
azure_auth
Microsoft Entra ID OAuth2 授权流。
类型:
oauth2
流向:
implicit
授权 URL:
https://login.microsoftonline.com/common/oauth2/authorize
作用域
名称 | 说明 |
---|---|
user_impersonation | 模拟用户帐户 |
示例
ListSupportedPrivateLinkResources
示例请求
示例响应
{
"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 Cognitive Search indexers can connect to blobs in Azure Storage for reading data (data source), for writing intermediate results of indexer execution (annotation cache, preview) or for storing any knowledge store projections (preview)"
}
},
{
"name": "table",
"properties": {
"type": "Microsoft.Storage/storageAccounts",
"groupId": "table",
"description": "Azure Cognitive Search indexers can connect to tables in Azure Storage for reading data (data source), for writing book-keeping information about intermediate results of indexer execution (annotation cache, preview) or for storing any knowledge store projections (preview)"
}
},
{
"name": "Sql",
"properties": {
"type": "Microsoft.DocumentDB/databaseAccounts",
"groupId": "Sql",
"description": "Azure Cognitive Search indexers can connect to CosmosDB using the SQL head for reading data (data source)."
}
},
{
"name": "plr",
"properties": {
"type": "Microsoft.Sql/servers",
"groupId": "sqlServer",
"description": "Azure Cognitive Search indexers can connect to AzureSQL databases in a SQL server for reading data (data source)."
}
},
{
"name": "vault",
"properties": {
"type": "Microsoft.KeyVault/vaults",
"groupId": "vault",
"description": "Azure Cognitive Search can access keys in Azure Key Vault to encrypt search index and synonym map data"
}
},
{
"name": "plr",
"properties": {
"type": "Microsoft.DBforMySQL/servers",
"groupId": "mysqlServer",
"description": "Azure Cognitive Search indexers can connect to MySQL databases for reading data (data source, preview)."
}
},
{
"name": "site",
"properties": {
"type": "Microsoft.Web/sites",
"groupId": "sites",
"description": "Azure Cognitive Search indexers can connect to App Services when executing custom web api skills that can be present in a skillset (optional) attached to the indexer."
}
}
]
}
}
]
}
定义
名称 | 说明 |
---|---|
Cloud |
包含有关 API 错误的信息。 |
Cloud |
使用错误代码和消息描述特定的 API 错误。 |
Private |
描述搜索服务支持的专用链接资源。 |
Private |
描述搜索服务支持的专用链接资源的属性。 对于给定的 API 版本,它表示创建共享专用链接资源时的“supported”groupIds。 |
Private |
包含支持的专用链接资源列表的响应。 |
Shareable |
描述已载入专用链接服务且受搜索支持的资源类型的属性。 |
Shareable |
描述已加入专用链接服务且受搜索支持的资源类型。 |
CloudError
包含有关 API 错误的信息。
名称 | 类型 | 说明 |
---|---|---|
error |
使用错误代码和消息描述特定的 API 错误。 |
CloudErrorBody
使用错误代码和消息描述特定的 API 错误。
名称 | 类型 | 说明 |
---|---|---|
code |
string |
描述错误条件的错误代码比 HTTP 状态代码更精确。 可用于以编程方式处理特定错误情况。 |
details |
包含与此错误相关的嵌套错误。 |
|
message |
string |
详细描述错误并提供调试信息的消息。 |
target |
string |
特定错误的目标 (例如,错误) 中属性的名称。 |
PrivateLinkResource
描述搜索服务支持的专用链接资源。
名称 | 类型 | 说明 |
---|---|---|
id |
string |
资源的完全限定的资源 ID。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
资源的名称 |
properties |
描述搜索服务支持的专用链接资源的属性。 |
|
type |
string |
资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts” |
PrivateLinkResourceProperties
描述搜索服务支持的专用链接资源的属性。 对于给定的 API 版本,它表示创建共享专用链接资源时的“supported”groupIds。
名称 | 类型 | 说明 |
---|---|---|
groupId |
string |
专用链接资源的组 ID。 |
requiredMembers |
string[] |
专用链接资源的必需成员列表。 |
requiredZoneNames |
string[] |
专用链接资源的所需 DNS 区域名称的列表。 |
shareablePrivateLinkResourceTypes |
加入专用链接服务并受搜索支持的资源列表。 |
PrivateLinkResourcesResult
包含支持的专用链接资源列表的响应。
名称 | 类型 | 说明 |
---|---|---|
value |
支持的专用链接资源列表。 |
ShareablePrivateLinkResourceProperties
描述已载入专用链接服务且受搜索支持的资源类型的属性。
名称 | 类型 | 说明 |
---|---|---|
description |
string |
已加入专用链接服务且受搜索支持的资源类型的说明。 |
groupId |
string |
已加入专用链接服务且受搜索支持的资源的资源提供程序组 ID。 |
type |
string |
已加入专用链接服务且受搜索支持的资源的资源提供程序类型。 |
ShareablePrivateLinkResourceType
描述已加入专用链接服务且受搜索支持的资源类型。
名称 | 类型 | 说明 |
---|---|---|
name |
string |
已载入专用链接服务且受搜索支持的资源类型的名称。 |
properties |
描述已载入专用链接服务且受搜索支持的资源类型的属性。 |