Private Link Resources - List Supported

Servizio:

Search Management

Versione API:

2025-05-01

Ottiene un elenco di tutti i tipi di risorse di collegamento privato supportati per il servizio specificato.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nome del gruppo di risorse. Il nome è insensibile alle maiuscole e minuscole.
searchServiceName	path	True	string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$	Nome del servizio Ricerca intelligenza artificiale di Azure associato al gruppo di risorse specificato.
subscriptionId	path	True	string (uuid)	ID della sottoscrizione di destinazione. Il valore deve essere un UUID.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
x-ms-client-request-id		string (uuid)	Valore GUID generato dal client che identifica questa richiesta. Se specificato, verrà incluso nelle informazioni di risposta come modo per tenere traccia della richiesta.

Risposte

Nome	Tipo	Descrizione
200 OK	PrivateLinkResourcesResult	L'operazione di Azure è stata completata correttamente.
Other Status Codes	CloudError	Risposta di errore imprevista.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

ListSupportedPrivateLinkResources

Esempio di richiesta

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

Risposta di esempio

Codice di stato:

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"
            }
          }
        ]
      }
    }
  ]
}

Definizioni

Nome	Descrizione
CloudError	Contiene informazioni su un errore dell'API.
CloudErrorBody	Descrive un particolare errore dell'API con un codice di errore e un messaggio.
createdByType	Tipo di identità che ha creato la risorsa.
PrivateLinkResource	Descrive una risorsa di collegamento privato supportata per il servizio Ricerca di intelligenza artificiale di Azure.
PrivateLinkResourceProperties	Descrive le proprietà di una risorsa di collegamento privato supportata per il servizio Ricerca intelligenza artificiale di Azure. Per una determinata versione dell'API, rappresenta i groupId "supportati" durante la creazione di una risorsa di collegamento privato condiviso.
PrivateLinkResourcesResult	Risposta contenente un elenco di risorse di collegamento privato supportate.
ShareablePrivateLinkResourceProperties	Descrive le proprietà di un tipo di risorsa di cui è stato eseguito l'onboarding nel servizio di collegamento privato, supportato da Ricerca di intelligenza artificiale di Azure.
ShareablePrivateLinkResourceType	Descrive un tipo di risorsa di cui è stato eseguito l'onboarding nel servizio di collegamento privato, supportato da Ricerca di intelligenza artificiale di Azure.
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.

CloudError

Oggetto

Contiene informazioni su un errore dell'API.

Nome	Tipo	Descrizione
error	CloudErrorBody	Descrive un particolare errore dell'API con un codice di errore e un messaggio.
message	string	Breve descrizione dell'errore che indica cosa è andato storto (per informazioni dettagliate/debug fare riferimento alla proprietà 'error.message').

CloudErrorBody

Oggetto

Descrive un particolare errore dell'API con un codice di errore e un messaggio.

Nome	Tipo	Descrizione
code	string	Codice di errore che descrive più precisamente la condizione di errore rispetto a un codice di stato HTTP. Può essere usato per gestire casi di errore specifici a livello di codice.
details	CloudErrorBody[]	Contiene errori annidati correlati a questo errore.
message	string	Messaggio che descrive l'errore in dettaglio e fornisce informazioni di debug.
target	string	Destinazione dell'errore specifico, ad esempio il nome della proprietà in errore.

createdByType

Enumerazione

Tipo di identità che ha creato la risorsa.

Valore	Descrizione
User
Application
ManagedIdentity
Key

PrivateLinkResource

Oggetto

Descrive una risorsa di collegamento privato supportata per il servizio Ricerca di intelligenza artificiale di Azure.

Nome	Tipo	Descrizione
id	string (arm-id)	ID risorsa completo per la risorsa. Ad esempio, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Nome della risorsa
properties	PrivateLinkResourceProperties	Descrive le proprietà di una risorsa di collegamento privato supportata per il servizio Ricerca intelligenza artificiale di Azure.
systemData	systemData	Metadati di Azure Resource Manager contenenti le informazioni createdBy e modifiedBy.
type	string	Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

PrivateLinkResourceProperties

Oggetto

Descrive le proprietà di una risorsa di collegamento privato supportata per il servizio Ricerca intelligenza artificiale di Azure. Per una determinata versione dell'API, rappresenta i groupId "supportati" durante la creazione di una risorsa di collegamento privato condiviso.

Nome	Tipo	Descrizione
groupId	string	ID gruppo della risorsa collegamento privato.
requiredMembers	string[]	Elenco dei membri obbligatori della risorsa collegamento privato.
requiredZoneNames	string[]	Elenco dei nomi di zona DNS necessari della risorsa collegamento privato.
shareablePrivateLinkResourceTypes	ShareablePrivateLinkResourceType[]	Elenco delle risorse di cui viene eseguito l'onboarding nel servizio di collegamento privato, supportate da Ricerca di intelligenza artificiale di Azure.

PrivateLinkResourcesResult

Oggetto

Risposta contenente un elenco di risorse di collegamento privato supportate.

Nome	Tipo	Descrizione
nextLink	string	L'URL per ottenere il prossimo insieme di risorse private link, se ce ne sono.
value	PrivateLinkResource[]	Elenco delle risorse di collegamento privato supportate.

ShareablePrivateLinkResourceProperties

Oggetto

Descrive le proprietà di un tipo di risorsa di cui è stato eseguito l'onboarding nel servizio di collegamento privato, supportato da Ricerca di intelligenza artificiale di Azure.

Nome	Tipo	Descrizione
description	string	Descrizione del tipo di risorsa di cui è stato eseguito l'onboarding nel servizio di collegamento privato, supportato da Ricerca di intelligenza artificiale di Azure.
groupId	string	ID del gruppo di provider di risorse per la risorsa di cui è stato eseguito l'onboarding nel servizio di collegamento privato, supportato da Ricerca di intelligenza artificiale di Azure.
type	string	Tipo di provider di risorse per la risorsa di cui è stato eseguito l'onboarding nel servizio di collegamento privato, supportato da Ricerca di intelligenza artificiale di Azure.

ShareablePrivateLinkResourceType

Oggetto

Descrive un tipo di risorsa di cui è stato eseguito l'onboarding nel servizio di collegamento privato, supportato da Ricerca di intelligenza artificiale di Azure.

Nome	Tipo	Descrizione
name	string	Nome del tipo di risorsa di cui è stato eseguito l'onboarding nel servizio di collegamento privato, supportato da Ricerca di intelligenza artificiale di Azure.
properties	ShareablePrivateLinkResourceProperties	Descrive le proprietà di un tipo di risorsa di cui è stato eseguito l'onboarding nel servizio di collegamento privato, supportato da Ricerca di intelligenza artificiale di Azure.

systemData

Oggetto

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string (date-time)	Timestamp della creazione della risorsa (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string (date-time)	Timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima volta la risorsa.