Shared Private Link Resources - List By Service

Servicio:: Search Management

Versión de la API:: 2023-11-01

Obtiene una lista de todos los recursos de vínculo privado compartidos administrados por el servicio determinado.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/sharedPrivateLinkResources?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	SharedPrivateLinkResourceListResult	La operación se realizó correctamente. La respuesta contiene la lista de todos los recursos de vínculo privado compartidos administrados por 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

ListSharedPrivateLinkResourcesByService

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:: 200

{
  "value": [
    {
      "name": "testResource",
      "type": "Microsoft.Search/searchServices/sharedPrivateLinkResources",
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/sharedPrivateLinkResources/testResource",
      "properties": {
        "requestMessage": "please approve",
        "groupId": "blob",
        "privateLinkResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/storageAccountName",
        "status": "Pending",
        "resourceRegion": null
      }
    }
  ]
}

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.
SharedPrivateLinkResource	Describe un recurso de Private Link compartido administrado por el servicio de búsqueda.
SharedPrivateLinkResourceListResult	Respuesta que contiene una lista de recursos compartidos de Private Link.
SharedPrivateLinkResourceProperties	Describe las propiedades de un recurso de Private Link compartido existente administrado por el servicio de búsqueda.
SharedPrivateLinkResourceProvisioningState	Estado de aprovisionamiento del recurso de vínculo privado compartido. Los valores válidos son Actualización, Eliminación, Error, Correcto o Incompleto.
SharedPrivateLinkResourceStatus	Estado del recurso de vínculo privado compartido. 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).

SharedPrivateLinkResource

Objeto

Describe un recurso de Private Link compartido administrado por el 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	SharedPrivateLinkResourceProperties	Describe las propiedades de un recurso de Private Link compartido administrado por el servicio de búsqueda.
type	string	Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

SharedPrivateLinkResourceListResult

Objeto

Respuesta que contiene una lista de recursos compartidos de Private Link.

Nombre	Tipo	Description
nextLink	string	Dirección URL para obtener el siguiente conjunto de recursos de vínculo privado compartido, si hay alguno.
value	SharedPrivateLinkResource[]	Lista de recursos compartidos de Private Link.

SharedPrivateLinkResourceProperties

Objeto

Describe las propiedades de un recurso de Private Link compartido existente administrado por el servicio de búsqueda.

Nombre	Tipo	Description
groupId	string	Identificador de grupo del proveedor del recurso para el que está el recurso de vínculo privado compartido.
privateLinkResourceId	string	Identificador de recurso del recurso para el que está el recurso de vínculo privado compartido.
provisioningState	SharedPrivateLinkResourceProvisioningState	Estado de aprovisionamiento del recurso de vínculo privado compartido. Los valores válidos son Actualización, Eliminación, Error, Correcto o Incompleto.
requestMessage	string	Mensaje de solicitud para solicitar la aprobación del recurso de vínculo privado compartido.
resourceRegion	string	Opcional. Se puede usar para especificar la ubicación de Azure Resource Manager del recurso al que se va a crear un vínculo privado compartido. Esto solo es necesario para aquellos recursos cuya configuración dns sea regional (como Azure Kubernetes Service).
status	SharedPrivateLinkResourceStatus	Estado del recurso de vínculo privado compartido. Los valores válidos son Pendiente, Aprobado, Rechazado o Desconectado.

SharedPrivateLinkResourceProvisioningState

Enumeración

Estado de aprovisionamiento del recurso de vínculo privado compartido. Los valores válidos son Actualización, Eliminación, Error, Correcto o Incompleto.

Valor	Description
Updating
Deleting
Failed
Succeeded
Incomplete

SharedPrivateLinkResourceStatus

Enumeración

Estado del recurso de vínculo privado compartido. Los valores válidos son Pendiente, Aprobado, Rechazado o Desconectado.

Valor	Description
Pending
Approved
Rejected
Disconnected