Private Link Resources - List Supported

服务:

Search Management

API 版本:

2025-05-01

获取给定服务支持的所有专用链接资源类型的列表。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/privateLinkResources?api-version=2025-05-01

URI 参数

名称	在	必需	类型	说明
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。 此名称不区分大小写。
searchServiceName	path	True	string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$	与指定资源组关联的 Azure AI 搜索服务的名称。
subscriptionId	path	True	string (uuid)	目标订阅的 ID。 该值必须是 UUID。
api-version	query	True	string minLength: 1	用于此操作的 API 版本。

请求头

名称	必需	类型	说明
x-ms-client-request-id		string (uuid)	一个客户端生成的 GUID 值，用于标识此请求。 如果指定，响应信息中将包含此内容作为跟踪请求的一种方式。

响应

名称	类型	说明
200 OK	PrivateLinkResourcesResult	Azure作已成功完成。
Other Status Codes	CloudError	意外错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流程。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

ListSupportedPrivateLinkResources

示例请求

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/privateLinkResources?api-version=2025-05-01

Go

package armsearch_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/search/armsearch/v2"
)

// Generated from example definition: 2025-05-01/ListSupportedPrivateLinkResources.json
func ExamplePrivateLinkResourcesClient_NewListSupportedPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsearch.NewClientFactory("00000000-0000-0000-0000-000000000000", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewPrivateLinkResourcesClient().NewListSupportedPager("rg1", "mysearchservice", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page = armsearch.PrivateLinkResourcesClientListSupportedResponse{
		// 	PrivateLinkResourcesResult: armsearch.PrivateLinkResourcesResult{
		// 		Value: []*armsearch.PrivateLinkResource{
		// 			{
		// 				Name: to.Ptr("searchService"),
		// 				Type: to.Ptr("Microsoft.Search/searchServices/privateLinkResources"),
		// 				ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/privateLinkResources/searchService"),
		// 				Properties: &armsearch.PrivateLinkResourceProperties{
		// 					GroupID: to.Ptr("searchService"),
		// 					RequiredMembers: []*string{
		// 						to.Ptr("searchService"),
		// 					},
		// 					RequiredZoneNames: []*string{
		// 						to.Ptr("privatelink.search.windows.net"),
		// 					},
		// 					ShareablePrivateLinkResourceTypes: []*armsearch.ShareablePrivateLinkResourceType{
		// 						{
		// 							Name: to.Ptr("blob"),
		// 							Properties: &armsearch.ShareablePrivateLinkResourceProperties{
		// 								Type: to.Ptr("Microsoft.Storage/storageAccounts"),
		// 								Description: to.Ptr("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."),
		// 								GroupID: to.Ptr("blob"),
		// 							},
		// 						},
		// 						{
		// 							Name: to.Ptr("table"),
		// 							Properties: &armsearch.ShareablePrivateLinkResourceProperties{
		// 								Type: to.Ptr("Microsoft.Storage/storageAccounts"),
		// 								Description: to.Ptr("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."),
		// 								GroupID: to.Ptr("table"),
		// 							},
		// 						},
		// 						{
		// 							Name: to.Ptr("Sql"),
		// 							Properties: &armsearch.ShareablePrivateLinkResourceProperties{
		// 								Type: to.Ptr("Microsoft.DocumentDB/databaseAccounts"),
		// 								Description: to.Ptr("Azure AI Search indexers can connect to Azure Cosmos DB API for NoSQL for reading data from an indexer data source."),
		// 								GroupID: to.Ptr("Sql"),
		// 							},
		// 						},
		// 						{
		// 							Name: to.Ptr("plr"),
		// 							Properties: &armsearch.ShareablePrivateLinkResourceProperties{
		// 								Type: to.Ptr("Microsoft.Sql/servers"),
		// 								Description: to.Ptr("Azure AI Search indexers can connect to Azure SQL database on a server for reading data from an indexer data source."),
		// 								GroupID: to.Ptr("sqlServer"),
		// 							},
		// 						},
		// 						{
		// 							Name: to.Ptr("vault"),
		// 							Properties: &armsearch.ShareablePrivateLinkResourceProperties{
		// 								Type: to.Ptr("Microsoft.KeyVault/vaults"),
		// 								Description: to.Ptr("Azure AI Search can access keys in Azure Key Vault to encrypt sensitive data in a search index and synonym map data."),
		// 								GroupID: to.Ptr("vault"),
		// 							},
		// 						},
		// 						{
		// 							Name: to.Ptr("plr"),
		// 							Properties: &armsearch.ShareablePrivateLinkResourceProperties{
		// 								Type: to.Ptr("Microsoft.DBforMySQL/servers"),
		// 								Description: to.Ptr("Azure AI Search indexers can connect to MySQL databases for reading data from an indexer data source."),
		// 								GroupID: to.Ptr("mysqlServer"),
		// 							},
		// 						},
		// 						{
		// 							Name: to.Ptr("site"),
		// 							Properties: &armsearch.ShareablePrivateLinkResourceProperties{
		// 								Type: to.Ptr("Microsoft.Web/sites"),
		// 								Description: to.Ptr("For custom skills that connect to an app service, you can specify sites as the group ID."),
		// 								GroupID: to.Ptr("sites"),
		// 							},
		// 						},
		// 					},
		// 				},
		// 			},
		// 		},
		// 	},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

示例响应

状态代码:

200

{
  "value": [
    {
      "name": "searchService",
      "type": "Microsoft.Search/searchServices/privateLinkResources",
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/privateLinkResources/searchService",
      "properties": {
        "groupId": "searchService",
        "requiredMembers": [
          "searchService"
        ],
        "requiredZoneNames": [
          "privatelink.search.windows.net"
        ],
        "shareablePrivateLinkResourceTypes": [
          {
            "name": "blob",
            "properties": {
              "type": "Microsoft.Storage/storageAccounts",
              "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.",
              "groupId": "blob"
            }
          },
          {
            "name": "table",
            "properties": {
              "type": "Microsoft.Storage/storageAccounts",
              "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.",
              "groupId": "table"
            }
          },
          {
            "name": "Sql",
            "properties": {
              "type": "Microsoft.DocumentDB/databaseAccounts",
              "description": "Azure AI Search indexers can connect to Azure Cosmos DB API for NoSQL for reading data from an indexer data source.",
              "groupId": "Sql"
            }
          },
          {
            "name": "plr",
            "properties": {
              "type": "Microsoft.Sql/servers",
              "description": "Azure AI Search indexers can connect to Azure SQL database on a server for reading data from an indexer data source.",
              "groupId": "sqlServer"
            }
          },
          {
            "name": "vault",
            "properties": {
              "type": "Microsoft.KeyVault/vaults",
              "description": "Azure AI Search can access keys in Azure Key Vault to encrypt sensitive data in a search index and synonym map data.",
              "groupId": "vault"
            }
          },
          {
            "name": "plr",
            "properties": {
              "type": "Microsoft.DBforMySQL/servers",
              "description": "Azure AI Search indexers can connect to MySQL databases for reading data from an indexer data source.",
              "groupId": "mysqlServer"
            }
          },
          {
            "name": "site",
            "properties": {
              "type": "Microsoft.Web/sites",
              "description": "For custom skills that connect to an app service, you can specify sites as the group ID.",
              "groupId": "sites"
            }
          }
        ]
      }
    }
  ]
}

定义

名称	说明
CloudError	包含有关 API 错误的信息。
CloudErrorBody	描述具有错误代码和消息的特定 API 错误。
createdByType	创建资源的标识的类型。
PrivateLinkResource	介绍 Azure AI 搜索服务支持的专用链接资源。
PrivateLinkResourceProperties	介绍 Azure AI 搜索服务支持的专用链接资源的属性。 对于给定的 API 版本，这表示创建共享专用链接资源时“支持的”groupId。
PrivateLinkResourcesResult	包含支持的专用链接资源列表的响应。
ShareablePrivateLinkResourceProperties	介绍已载入到专用链接服务的资源类型的属性，由 Azure AI 搜索支持。
ShareablePrivateLinkResourceType	描述已载入到 Azure AI 搜索支持的专用链接服务的资源类型。
systemData	与创建和上次修改资源相关的元数据。

CloudError

对象

包含有关 API 错误的信息。

名称	类型	说明
error	CloudErrorBody	描述具有错误代码和消息的特定 API 错误。
message	string	提示出错的错误的简要说明（有关详细信息/调试信息，请参阅“error.message”属性）。

CloudErrorBody

对象

描述具有错误代码和消息的特定 API 错误。

名称	类型	说明
code	string	比 HTTP 状态代码更准确地描述错误条件的错误代码。 可用于以编程方式处理特定错误案例。
details	CloudErrorBody[]	包含与此错误相关的嵌套错误。
message	string	详细说明错误并提供调试信息的消息。
target	string	特定错误的目标（例如，错误中属性的名称）。

createdByType

枚举

创建资源的标识的类型。

值	说明
User
Application
ManagedIdentity
Key

PrivateLinkResource

对象

介绍 Azure AI 搜索服务支持的专用链接资源。

名称	类型	说明
id	string (arm-id)	资源的完全限定资源 ID。 例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
name	string	资源的名称
properties	PrivateLinkResourceProperties	介绍 Azure AI 搜索服务支持的专用链接资源的属性。
systemData	systemData	包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。
type	string	资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

PrivateLinkResourceProperties

对象

介绍 Azure AI 搜索服务支持的专用链接资源的属性。 对于给定的 API 版本，这表示创建共享专用链接资源时“支持的”groupId。

名称	类型	说明
groupId	string	专用链接资源的组 ID。
requiredMembers	string[]	专用链接资源所需成员的列表。
requiredZoneNames	string[]	专用链接资源所需的 DNS 区域名称列表。
shareablePrivateLinkResourceTypes	ShareablePrivateLinkResourceType[]	载入到专用链接服务的资源列表，Azure AI 搜索支持。

PrivateLinkResourcesResult

对象

包含支持的专用链接资源列表的响应。

名称	类型	说明
nextLink	string	如果有的话，获取下一组私有链接资源的URL。
value	PrivateLinkResource[]	支持的专用链接资源列表。

ShareablePrivateLinkResourceProperties

对象

介绍已载入到专用链接服务的资源类型的属性，由 Azure AI 搜索支持。

名称	类型	说明
description	string	已载入到专用链接服务的资源类型的说明，由 Azure AI 搜索支持。
groupId	string	已载入到专用链接服务的资源的资源提供程序组 ID，Azure AI 搜索支持。
type	string	已载入专用链接服务的资源的资源提供程序类型，受 Azure AI 搜索支持。

ShareablePrivateLinkResourceType

对象

描述已载入到 Azure AI 搜索支持的专用链接服务的资源类型。

名称	类型	说明
name	string	已载入到专用链接服务的资源类型的名称，由 Azure AI 搜索支持。
properties	ShareablePrivateLinkResourceProperties	介绍已载入到专用链接服务的资源类型的属性，由 Azure AI 搜索支持。

systemData

对象

与创建和上次修改资源相关的元数据。

名称	类型	说明
createdAt	string (date-time)	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string (date-time)	上次修改的资源时间戳（UTC）
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。