Private Endpoint Connections - List By Service

Servicio:: Search Management

Versión de la API:: 2023-11-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=2023-11-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
resourceGroupName	path	True	string	Nombre del grupo de recursos dentro de la suscripción actual. Puede obtener este valor desde la API de Azure Resource Manager o el portal.
searchServiceName	path	True	string	Nombre del servicio de búsqueda asociado al grupo de recursos especificado.
subscriptionId	path	True	string	Identificador único de una suscripción de Microsoft Azure. Puede obtener este valor de la API de Azure Resource Manager, las herramientas de línea de comandos o el portal.
api-version	query	True	string	Versión de la API que se va a usar para cada solicitud.

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 operación se realizó correctamente. La respuesta contiene la lista de todas las conexiones de punto de conexión privado para el servicio especificado.
Other Status Codes	CloudError	Error inesperado durante la operación.

Seguridad

azure_auth

Flujo de autorización de OAuth2 de Microsoft Entra ID.

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

Solicitud de ejemplo

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/privateEndpointConnections?api-version=2023-11-01

Respuesta de muestra

status code:: 200

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/privateEndpointConnections/testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546",
      "name": "testEndpoint.50bf4fbe-d7c1-4b48-a642-4f5892642546",
      "type": "Microsoft.Search/searchServices/privateEndpointConnections",
      "properties": {
        "privateEndpoint": {
          "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testEndpoint"
        },
        "privateLinkServiceConnectionState": {
          "status": "Approved",
          "description": "",
          "actionsRequired": "None"
        }
      }
    }
  ]
}

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.
PrivateEndpoint	Recurso de punto de conexión privado del proveedor Microsoft.Network.
PrivateEndpointConnection	Describe una conexión de punto de conexión privado existente al servicio de búsqueda.
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.
PrivateLinkServiceConnectionProvisioningState	Estado de aprovisionamiento de la conexión del servicio private link. Los valores válidos son Actualización, Eliminación, Error, Correcto o Incompleto
PrivateLinkServiceConnectionState	Describe el estado actual de una conexión del servicio Private Link existente al punto de conexión privado de Azure.
PrivateLinkServiceConnectionStatus	Estado de la conexión del servicio private link. Los valores válidos son Pendiente, Aprobado, Rechazado o Desconectado.

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.

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).

PrivateEndpoint

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.

PrivateEndpointConnection

Objeto

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

Nombre	Tipo	Description
id	string	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 de búsqueda.
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 proveedor del recurso para el que está la conexión del servicio private link.
privateEndpoint	PrivateEndpoint	Recurso de punto de conexión privado del proveedor Microsoft.Network.
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Describe el estado actual de una conexión del servicio Private Link existente al punto de conexión privado de Azure.
provisioningState	PrivateLinkServiceConnectionProvisioningState	Estado de aprovisionamiento de la conexión del servicio private link. Los valores válidos son Actualización, Eliminación, Error, Correcto o Incompleto

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 o Incompleto

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.

PrivateLinkServiceConnectionState

Objeto

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

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.

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.