Private Link Resources - List Supported

Serviço:: Search Management

Versão da API:: 2025-05-01

Obtém uma lista de todos os tipos de recursos de link privado com suporte para o serviço especificado.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
searchServiceName	path	True	string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$	O nome do serviço Azure AI Search associado ao grupo de recursos especificado.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser uma UUID.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
x-ms-client-request-id		string (uuid)	Um valor GUID gerado pelo cliente que identifica essa solicitação. Se especificado, isso será incluído nas informações de resposta como uma maneira de acompanhar a solicitação.

Respostas

Nome	Tipo	Description
200 OK	PrivateLinkResourcesResult	A operação do Azure foi concluída com êxito.
Other Status Codes	CloudError	Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

ListSupportedPrivateLinkResources

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

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

Resposta de exemplo

Código de status:: 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"
            }
          }
        ]
      }
    }
  ]
}

Definições

Nome	Description
CloudError	Contém informações sobre um erro de API.
CloudErrorBody	Descreve um erro de API específico com um código de erro e uma mensagem.
createdByType	O tipo de identidade que criou o recurso.
PrivateLinkResource	Descreve um recurso de link privado com suporte para o serviço Azure AI Search.
PrivateLinkResourceProperties	Descreve as propriedades de um recurso de link privado com suporte para o serviço Azure AI Search. Para uma determinada versão da API, isso representa as groupIds 'com suporte' ao criar um recurso de link privado compartilhado.
PrivateLinkResourcesResult	Resposta que contém uma lista de recursos de link privado com suporte.
ShareablePrivateLinkResourceProperties	Descreve as propriedades de um tipo de recurso que foi integrado ao serviço de link privado, com suporte do Azure AI Search.
ShareablePrivateLinkResourceType	Descreve um tipo de recurso que foi integrado ao serviço de link privado, com suporte do Azure AI Search.
systemData	Metadados relativos à criação e última modificação do recurso.

CloudError

Objeto

Contém informações sobre um erro de API.

Nome	Tipo	Description
error	CloudErrorBody	Descreve um erro de API específico com um código de erro e uma mensagem.
message	string	Uma breve descrição do erro que indica o que deu errado (para obter detalhes/informações de depuração, consulte a propriedade 'error.message').

CloudErrorBody

Objeto

Descreve um erro de API específico com um código de erro e uma mensagem.

Nome	Tipo	Description
code	string	Um código de erro que descreve a condição de erro com mais precisão do que um código de status HTTP. Pode ser usado para lidar programaticamente com casos de erro específicos.
details	CloudErrorBody[]	Contém erros aninhados relacionados a esse erro.
message	string	Uma mensagem que descreve o erro em detalhes e fornece informações de depuração.
target	string	O destino do erro específico (por exemplo, o nome da propriedade em erro).

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key