Shared Private Link Resources - Create Or Update

Servicio:: Search Management

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

Inicia la creación o actualización de un recurso de vínculo privado compartido administrado por el servicio de búsqueda en el grupo de recursos determinado.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}?api-version=2025-05-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 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.

Cuerpo de la solicitud

Nombre	Tipo	Description
properties	SharedPrivateLinkResourceProperties	Describe las propiedades de un recurso de vínculo privado compartido administrado por el servicio Azure AI Search.

Respuestas

Nombre	Tipo	Description
200 OK	SharedPrivateLinkResource	Detalles del recurso de vínculo privado compartido que se creó o actualizó.
202 Accepted		Se ha aceptado la operación de creación o actualización de recursos de private link compartido y se completará de forma asincrónica.
Other Status Codes	CloudError	HTTP 400 (solicitud incorrecta): el nombre de recurso de vínculo privado compartido especificado o la definición de recurso de vínculo privado compartido no es válida; Consulte el código de error y el mensaje en la respuesta para obtener más información. 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. HTTP 409 (Conflicto): la suscripción especificada está deshabilitada.

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

SharedPrivateLinkResourceCreateOrUpdate

Solicitud de ejemplo

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice/sharedPrivateLinkResources/testResource?api-version=2025-05-01

{
  "properties": {
    "requestMessage": "please approve",
    "groupId": "blob",
    "privateLinkResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/storageAccountName",
    "resourceRegion": null
  }
}

Respuesta de muestra

status code:: 202

Location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchService/sharedPrivateLinkResources/testResource/operationStatuses/08586060559526078782?api-version=2025-05-01
Azure-AsyncOperation: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchService/sharedPrivateLinkResources/testResource/operationStatuses/08586060559526078782?api-version=2025-05-01

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.
createdByType	Tipo de identidad que creó el recurso.
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.
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