Private Link Resources - List Supported

Service:: Search Management

API-versie:: 2025-05-01

Hiermee haalt u een lijst op met alle ondersteunde private link-resourcetypen voor de opgegeven service.

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

URI-parameters

Name	In	Vereist	Type	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	De naam van de resourcegroep. De naam is hoofdletterongevoelig.
searchServiceName	path	True	string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$	De naam van de Azure AI Search-service die is gekoppeld aan de opgegeven resourcegroep.
subscriptionId	path	True	string (uuid)	De id van het doelabonnement. De waarde moet een UUID zijn.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagkoptekst

Name	Vereist	Type	Description
x-ms-client-request-id		string (uuid)	Een door de client gegenereerde GUID-waarde die deze aanvraag identificeert. Indien opgegeven, wordt dit opgenomen in antwoordinformatie als een manier om de aanvraag bij te houden.

Antwoorden

Name	Type	Description
200 OK	PrivateLinkResourcesResult	Azure-bewerking is voltooid.
Other Status Codes	CloudError	Een onverwachte foutreactie.

Beveiliging

azure_auth

OAuth2-stroom voor Azure Active Directory.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

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

Voorbeeldrespons

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

Definities

Name	Description
CloudError	Bevat informatie over een API-fout.
CloudErrorBody	Beschrijft een bepaalde API-fout met een foutcode en een bericht.
createdByType	Het type identiteit waarmee de resource is gemaakt.
PrivateLinkResource	Beschrijft een ondersteunde private link-resource voor de Azure AI Search-service.
PrivateLinkResourceProperties	Beschrijft de eigenschappen van een ondersteunde Private Link-resource voor de Azure AI Search-service. Voor een bepaalde API-versie vertegenwoordigt dit de 'ondersteunde' groupIds bij het maken van een gedeelde private link-resource.
PrivateLinkResourcesResult	Antwoord met een lijst met ondersteunde Private Link-resources.
ShareablePrivateLinkResourceProperties	Beschrijft de eigenschappen van een resourcetype dat is toegevoegd aan de Private Link-service, ondersteund door Azure AI Search.
ShareablePrivateLinkResourceType	Beschrijft een resourcetype dat is toegevoegd aan de Private Link-service die wordt ondersteund door Azure AI Search.
systemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

CloudError

Object

Bevat informatie over een API-fout.

Name	Type	Description
error	CloudErrorBody	Beschrijft een bepaalde API-fout met een foutcode en een bericht.
message	string	Een korte beschrijving van de fout die aangeeft wat er fout is gegaan (voor informatie over details/foutopsporing raadpleegt u de eigenschap 'error.message').

CloudErrorBody

Object

Beschrijft een bepaalde API-fout met een foutcode en een bericht.

Name	Type	Description
code	string	Een foutcode die de foutvoorwaarde nauwkeuriger beschrijft dan een HTTP-statuscode. Kan worden gebruikt om programmatisch specifieke foutcases af te handelen.
details	CloudErrorBody[]	Bevat geneste fouten die betrekking hebben op deze fout.
message	string	Een bericht met een gedetailleerde beschrijving van de fout en informatie over foutopsporing.
target	string	Het doel van de specifieke fout (bijvoorbeeld de naam van de eigenschap in fout).

createdByType

Opsomming

Het type identiteit waarmee de resource is gemaakt.

Waarde	Description
User
Application
ManagedIdentity
Key

PrivateLinkResource

Object

Beschrijft een ondersteunde private link-resource voor de Azure AI Search-service.

Name	Type	Description
id	string (arm-id)	Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceType}/{resourceName}"
name	string	De naam van de resource
properties	PrivateLinkResourceProperties	Beschrijft de eigenschappen van een ondersteunde Private Link-resource voor de Azure AI Search-service.
systemData	systemData	Azure Resource Manager-metagegevens met createdBy- en modifiedBy-gegevens.
type	string	Het type bron. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

PrivateLinkResourceProperties

Object

Beschrijft de eigenschappen van een ondersteunde Private Link-resource voor de Azure AI Search-service. Voor een bepaalde API-versie vertegenwoordigt dit de 'ondersteunde' groupIds bij het maken van een gedeelde private link-resource.

Name	Type	Description
groupId	string	De groeps-id van de private link-resource.
requiredMembers	string[]	De lijst met vereiste leden van de private link-resource.
requiredZoneNames	string[]	De lijst met vereiste DNS-zonenamen van de private link-resource.
shareablePrivateLinkResourceTypes	ShareablePrivateLinkResourceType[]	De lijst met resources die worden toegevoegd aan de Private Link-service, die worden ondersteund door Azure AI Search.

PrivateLinkResourcesResult

Object

Antwoord met een lijst met ondersteunde Private Link-resources.

Name	Type	Description
nextLink	string	De URL om de volgende set privé-linkbronnen te krijgen, als die er zijn.
value	PrivateLinkResource[]	De lijst met ondersteunde Private Link-resources.

ShareablePrivateLinkResourceProperties

Object

Beschrijft de eigenschappen van een resourcetype dat is toegevoegd aan de Private Link-service, ondersteund door Azure AI Search.

Name	Type	Description
description	string	De beschrijving van het resourcetype dat is toegevoegd aan de Private Link-service, ondersteund door Azure AI Search.
groupId	string	De resourceprovidergroep-id voor de resource die is toegevoegd aan de Private Link-service, die wordt ondersteund door Azure AI Search.
type	string	Het type resourceprovider voor de resource die is toegevoegd aan de Private Link-service, die wordt ondersteund door Azure AI Search.

ShareablePrivateLinkResourceType

Object

Beschrijft een resourcetype dat is toegevoegd aan de Private Link-service die wordt ondersteund door Azure AI Search.

Name	Type	Description
name	string	De naam van het resourcetype dat is toegevoegd aan de Private Link-service, ondersteund door Azure AI Search.
properties	ShareablePrivateLinkResourceProperties	Beschrijft de eigenschappen van een resourcetype dat is toegevoegd aan de Private Link-service, ondersteund door Azure AI Search.

systemData

Object

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

Name	Type	Description
createdAt	string (date-time)	De tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit waarmee de resource is gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string (date-time)	De tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy	string	De identiteit die de resource voor het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource voor het laatst heeft gewijzigd.

Delen via

Private Link Resources - List Supported

URI-parameters

Aanvraagkoptekst

Antwoorden

Beveiliging

azure_auth

Bereiken

Voorbeelden

ListSupportedPrivateLinkResources

Voorbeeldaanvraag

Voorbeeldrespons

Definities

CloudError

CloudErrorBody

createdByType

PrivateLinkResource

PrivateLinkResourceProperties

PrivateLinkResourcesResult

ShareablePrivateLinkResourceProperties

ShareablePrivateLinkResourceType

systemData