Shared Private Link Resources - Get

Servicio:: Search Management

Versión de la API:: 2024-03-01-preview

Obtiene los detalles del recurso de vínculo privado compartido administrado por el servicio de búsqueda en el grupo de recursos especificado.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}?api-version=2024-03-01-preview

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 pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$	Nombre del servicio Azure AI Search asociado al grupo de recursos especificado.
sharedPrivateLinkResourceName	path	True	string	Nombre del recurso de vínculo privado compartido administrado por el servicio Azure AI Search dentro del grupo de recursos especificado.
subscriptionId	path	True	string	Identificador único de una suscripción de Microsoft Azure. Puede obtener este valor desde la API de Azure Resource Manager 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	SharedPrivateLinkResource	La definición del recurso de vínculo privado compartido se recuperó correctamente y se encuentra en la respuesta.
Other Status Codes	CloudError	HTTP 404 (no encontrado): no se encontró la suscripción, el grupo de recursos, el servicio de búsqueda o el recurso de vínculo privado compartido.

Seguridad

azure_auth

Especifica un flujo de concesión implícito, como se admite en la plataforma de identidad de Microsoft.

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

SharedPrivateLinkResourceGet

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:: 200

{
  "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 vínculo privado compartido administrado por el servicio Azure AI Search.
SharedPrivateLinkResourceProperties	Describe las propiedades de un recurso de vínculo privado compartido existente administrado por el servicio Azure AI Search.
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.
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).

SharedPrivateLinkResource

Objeto

Describe un recurso de vínculo privado compartido administrado por el servicio Azure AI Search.

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 vínculo privado compartido administrado por el servicio Azure AI Search.
type	string	Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

SharedPrivateLinkResourceProperties

Objeto

Describe las propiedades de un recurso de vínculo privado compartido existente administrado por el servicio Azure AI Search.

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	El 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 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 para el que se crea 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	El recurso de vínculo privado compartido está en proceso de creación junto con otros recursos para que sea totalmente funcional.
Deleting	El recurso de vínculo privado compartido está en proceso de eliminación.
Failed	No se pudo aprovisionar o eliminar el recurso de vínculo privado compartido.
Succeeded	El recurso de vínculo privado compartido ha terminado de aprovisionar y está listo para su aprobación.
Incomplete	Se ha aceptado la solicitud de aprovisionamiento para el recurso de vínculo privado compartido, pero aún no se ha iniciado el proceso de creación.

SharedPrivateLinkResourceStatus

Enumeración

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

Valor	Description
Pending	Se ha creado el recurso de vínculo privado compartido y está pendiente de aprobación.
Approved	El recurso de vínculo privado compartido está aprobado y está listo para su uso.
Rejected	El recurso de vínculo privado compartido se ha rechazado y no se puede usar.
Disconnected	El recurso de vínculo privado compartido se ha quitado del servicio.