Private Endpoint Connections - List By Service

Servicio:: Search Management

Versión de la API:: 2025-05-01

Obtiene una lista de todas las conexiones de punto de conexión privado en el servicio especificado.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
searchServiceName	path	True	string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$	Nombre del servicio Azure AI Search asociado al grupo de recursos especificado.
subscriptionId	path	True	string (uuid)	Identificador de la suscripción de destino. El valor debe ser un UUID.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
x-ms-client-request-id		string (uuid)	Valor GUID generado por el cliente que identifica esta solicitud. Si se especifica, se incluirá en la información de respuesta como una manera de realizar un seguimiento de la solicitud.

Respuestas

Nombre	Tipo	Description
200 OK	PrivateEndpointConnectionListResult	La solicitud se ha realizado correctamente.
Other Status Codes	CloudError	Una respuesta de error inesperada.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

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

Respuesta de muestra

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

Definiciones

Nombre	Description
CloudError	Contiene información sobre un error de API.
CloudErrorBody	Describe un error de API determinado con un código de error y un mensaje.
createdByType	Tipo de identidad que creó el recurso.
PrivateEndpointConnection	Describe una conexión de punto de conexión privado existente al servicio Azure AI Search.
PrivateEndpointConnectionListResult	Respuesta que contiene una lista de conexiones de punto de conexión privado.
PrivateEndpointConnectionProperties	Describe las propiedades de una conexión de punto de conexión privado existente al servicio de búsqueda.
PrivateEndpointConnectionPropertiesPrivateEndpoint	Recurso de punto de conexión privado del proveedor Microsoft.Network.
PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState	Describe el estado actual de una conexión de servicio de Azure Private Link existente al punto de conexión privado.
PrivateLinkServiceConnectionProvisioningState	Estado de aprovisionamiento de la conexión del servicio private link. Los valores válidos son Actualización, Eliminación, Error, Correcto, Incompleto o Cancelado.
PrivateLinkServiceConnectionStatus	Estado de la conexión del servicio private link. Los valores válidos son Pendiente, Aprobado, Rechazado o Desconectado.
systemData	Metadatos relativos a la creación y última modificación del recurso.

CloudError

Objeto

Contiene información sobre un error de API.

Nombre	Tipo	Description
error	CloudErrorBody	Describe un error de API determinado con un código de error y un mensaje.
message	string	Una breve descripción del error que indica lo que salió mal (para obtener detalles o información de depuración, consulte la propiedad "error.message").

CloudErrorBody

Objeto

Describe un error de API determinado con un código de error y un mensaje.

Nombre	Tipo	Description
code	string	Código de error que describe la condición de error más precisamente que un código de estado HTTP. Se puede usar para controlar mediante programación casos de error específicos.
details	CloudErrorBody[]	Contiene errores anidados relacionados con este error.
message	string	Mensaje que describe el error con detalle y proporciona información de depuración.
target	string	Destino del error concreto (por ejemplo, el nombre de la propiedad en error).

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
User
Application
ManagedIdentity
Key

PrivateEndpointConnection

Objeto

Describe una conexión de punto de conexión privado existente al servicio Azure AI Search.

Nombre	Tipo	Description
id	string (arm-id)	Identificador de recurso completo para el recurso. Por ejemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Nombre del recurso
properties	PrivateEndpointConnectionProperties	Describe las propiedades de una conexión de punto de conexión privado existente al servicio Azure AI Search.
systemData	systemData	Metadatos de Azure Resource Manager que contienen información createdBy y modifiedBy.
type	string	Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionListResult

Objeto

Respuesta que contiene una lista de conexiones de punto de conexión privado.

Nombre	Tipo	Description
nextLink	string	Dirección URL de solicitud que se puede usar para consultar la página siguiente de conexiones de punto de conexión privado. Se devuelve cuando el número total de conexiones de punto de conexión privado solicitadas supera el tamaño máximo de página.
value	PrivateEndpointConnection[]	Lista de conexiones de punto de conexión privado.

PrivateEndpointConnectionProperties

Objeto

Describe las propiedades de una conexión de punto de conexión privado existente al servicio de búsqueda.

Nombre	Tipo	Description
groupId	string	Identificador de grupo del recurso de Azure para el que está el servicio private link.
privateEndpoint	PrivateEndpointConnectionPropertiesPrivateEndpoint	Recurso de punto de conexión privado del proveedor Microsoft.Network.
privateLinkServiceConnectionState	PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState	Describe el estado actual de una conexión de servicio de Azure Private Link existente al punto de conexión privado.
provisioningState	PrivateLinkServiceConnectionProvisioningState	Estado de aprovisionamiento de la conexión del servicio private link. Los valores válidos son Actualización, Eliminación, Error, Correcto, Incompleto o Cancelado.

PrivateEndpointConnectionPropertiesPrivateEndpoint

Objeto

Recurso de punto de conexión privado del proveedor Microsoft.Network.

Nombre	Tipo	Description
id	string	Identificador de recurso del recurso de punto de conexión privado del proveedor Microsoft.Network.

PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState

Objeto

Describe el estado actual de una conexión de servicio de Azure Private Link existente al punto de conexión privado.

Nombre	Tipo	Valor predeterminado	Description
actionsRequired	string	None	Descripción de cualquier acción adicional que pueda ser necesaria.
description	string		Descripción del estado de conexión del servicio private link.
status	PrivateLinkServiceConnectionStatus		Estado de la conexión del servicio private link. Los valores válidos son Pendiente, Aprobado, Rechazado o Desconectado.

PrivateLinkServiceConnectionProvisioningState

Enumeración

Estado de aprovisionamiento de la conexión del servicio private link. Los valores válidos son Actualización, Eliminación, Error, Correcto, Incompleto o Cancelado.

Valor	Description
Updating	La conexión del servicio private link está en proceso de crearse junto con otros recursos para que sea totalmente funcional.
Deleting	La conexión del servicio private link está en proceso de eliminación.
Failed	No se pudo aprovisionar o eliminar la conexión del servicio private link.
Succeeded	La conexión del servicio private link ha finalizado el aprovisionamiento y está lista para su aprobación.
Incomplete	Se ha aceptado la solicitud de aprovisionamiento para el recurso de conexión del servicio private link, pero aún no se ha iniciado el proceso de creación.
Canceled	Se ha cancelado la solicitud de aprovisionamiento para el recurso de conexión del servicio private link.

PrivateLinkServiceConnectionStatus

Enumeración

Estado de la conexión del servicio private link. Los valores válidos son Pendiente, Aprobado, Rechazado o Desconectado.

Valor	Description
Pending	Se ha creado la conexión del punto de conexión privado y está pendiente de aprobación.
Approved	La conexión de punto de conexión privado está aprobada y está lista para su uso.
Rejected	Se ha rechazado la conexión del punto de conexión privado y no se puede usar.
Disconnected	La conexión del punto de conexión privado se ha quitado del servicio.

systemData

Objeto

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string (date-time)	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string (date-time)	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.