Private Endpoint Connections - List By Service

Servizio:: Search Management

Versione API:: 2025-05-01

Ottiene un elenco di tutte le connessioni endpoint private nel servizio specificato.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/privateEndpointConnections?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	PrivateEndpointConnectionListResult	La richiesta ha avuto esito positivo.
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

ListPrivateEndpointConnectionsByService

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/privateEndpointConnections?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/ListPrivateEndpointConnectionsByService.json
func ExamplePrivateEndpointConnectionsClient_NewListByServicePager() {
	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.NewPrivateEndpointConnectionsClient().NewListByServicePager("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.PrivateEndpointConnectionsClientListByServiceResponse{
		// 	PrivateEndpointConnectionListResult: armsearch.PrivateEndpointConnectionListResult{
		// 		Value: []*armsearch.PrivateEndpointConnection{
		// 			{
		// 				Name: to.Ptr("testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546"),
		// 				Type: to.Ptr("Microsoft.Search/searchServices/privateEndpointConnections"),
		// 				ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/privateEndpointConnections/testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546"),
		// 				Properties: &armsearch.PrivateEndpointConnectionProperties{
		// 					PrivateEndpoint: &armsearch.PrivateEndpointConnectionPropertiesPrivateEndpoint{
		// 						ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testEndpoint"),
		// 					},
		// 					PrivateLinkServiceConnectionState: &armsearch.PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState{
		// 						Description: to.Ptr(""),
		// 						ActionsRequired: to.Ptr("None"),
		// 						Status: to.Ptr(armsearch.PrivateLinkServiceConnectionStatusApproved),
		// 					},
		// 				},
		// 			},
		// 		},
		// 	},
		// }
	}
}

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": "testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546",
      "type": "Microsoft.Search/searchServices/privateEndpointConnections",
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/privateEndpointConnections/testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546",
      "properties": {
        "privateEndpoint": {
          "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testEndpoint"
        },
        "privateLinkServiceConnectionState": {
          "description": "",
          "actionsRequired": "None",
          "status": "Approved"
        }
      }
    }
  ]
}

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.
PrivateEndpointConnection	Descrive una connessione endpoint privato esistente al servizio Ricerca intelligenza artificiale di Azure.
PrivateEndpointConnectionListResult	Risposta contenente un elenco di connessioni endpoint private.
PrivateEndpointConnectionProperties	Descrive le proprietà di una connessione endpoint privato esistente al servizio di ricerca.
PrivateEndpointConnectionPropertiesPrivateEndpoint	Risorsa endpoint privato dal provider Microsoft.Network.
PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState	Descrive lo stato corrente di una connessione al servizio collegamento privato di Azure esistente all'endpoint privato.
PrivateLinkServiceConnectionProvisioningState	Stato di provisioning della connessione al servizio collegamento privato. I valori validi sono Aggiornamento, Eliminazione, Operazione non riuscita, Completata, Incompleta o Annullata.
PrivateLinkServiceConnectionStatus	Stato della connessione al servizio collegamento privato. I valori validi sono In sospeso, Approvato, Rifiutato o Disconnesso.
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

PrivateEndpointConnection

Oggetto

Descrive una connessione endpoint privato esistente al servizio Ricerca 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	PrivateEndpointConnectionProperties	Descrive le proprietà di una connessione endpoint privato esistente al 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"

PrivateEndpointConnectionListResult

Oggetto

Risposta contenente un elenco di connessioni endpoint private.

Nome	Tipo	Descrizione
nextLink	string	URL della richiesta che può essere usato per eseguire una query sulla pagina successiva delle connessioni endpoint private. Restituito quando il numero totale di connessioni endpoint private richieste supera le dimensioni massime della pagina.
value	PrivateEndpointConnection[]	Elenco di connessioni endpoint private.

PrivateEndpointConnectionProperties

Oggetto

Descrive le proprietà di una connessione endpoint privato esistente al servizio di ricerca.

Nome	Tipo	Descrizione
groupId	string	ID del gruppo della risorsa di Azure per cui si trova il servizio collegamento privato.
privateEndpoint	PrivateEndpointConnectionPropertiesPrivateEndpoint	Risorsa endpoint privato dal provider Microsoft.Network.
privateLinkServiceConnectionState	PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState	Descrive lo stato corrente di una connessione al servizio collegamento privato di Azure esistente all'endpoint privato.
provisioningState	PrivateLinkServiceConnectionProvisioningState	Stato di provisioning della connessione al servizio collegamento privato. I valori validi sono Aggiornamento, Eliminazione, Operazione non riuscita, Completata, Incompleta o Annullata.

PrivateEndpointConnectionPropertiesPrivateEndpoint

Oggetto

Risorsa endpoint privato dal provider Microsoft.Network.

Nome	Tipo	Descrizione
id	string	ID risorsa della risorsa endpoint privato dal provider Microsoft.Network.

PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState

Oggetto

Descrive lo stato corrente di una connessione al servizio collegamento privato di Azure esistente all'endpoint privato.

Nome	Tipo	Valore predefinito	Descrizione
actionsRequired	string	None	Descrizione di eventuali azioni aggiuntive che possono essere necessarie.
description	string		Descrizione dello stato della connessione al servizio di collegamento privato.
status	PrivateLinkServiceConnectionStatus		Stato della connessione al servizio collegamento privato. I valori validi sono In sospeso, Approvato, Rifiutato o Disconnesso.

PrivateLinkServiceConnectionProvisioningState

Enumerazione

Stato di provisioning della connessione al servizio collegamento privato. I valori validi sono Aggiornamento, Eliminazione, Operazione non riuscita, Completata, Incompleta o Annullata.

Valore	Descrizione
Updating	La connessione al servizio di collegamento privato è in corso di creazione insieme ad altre risorse affinché sia completamente funzionante.
Deleting	La connessione al servizio collegamento privato è in corso di eliminazione.
Failed	Impossibile effettuare il provisioning o l'eliminazione della connessione al servizio collegamento privato.
Succeeded	Il provisioning della connessione al servizio collegamento privato è terminato ed è pronto per l'approvazione.
Incomplete	La richiesta di provisioning per la risorsa di connessione al servizio di collegamento privato è stata accettata, ma il processo di creazione non è ancora stato avviato.
Canceled	La richiesta di provisioning per la risorsa di connessione al servizio collegamento privato è stata annullata.

PrivateLinkServiceConnectionStatus

Enumerazione

Stato della connessione al servizio collegamento privato. I valori validi sono In sospeso, Approvato, Rifiutato o Disconnesso.

Valore	Descrizione
Pending	La connessione all'endpoint privato è stata creata ed è in attesa di approvazione.
Approved	La connessione all'endpoint privato è approvata ed è pronta per l'uso.
Rejected	La connessione all'endpoint privato è stata rifiutata e non può essere usata.
Disconnected	La connessione all'endpoint privato è stata rimossa dal servizio.

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.