Managed Private Endpoints - Create Workspace Managed Private Endpoint

Servicio:: Core

Versión de la API:: v1

Crea un punto de conexión privado administrado en el área de trabajo especificada.

Permissions

El autor de la llamada debe tener rol de administrador área de trabajo.

Ámbitos delegados necesarios

Workspace.ReadWrite.All.

Limitations

Para crear un punto de conexión privado administrado, el área de trabajo debe estar en una capacidad de Fabric compatible. Para obtener más información, consulte: tipos de licencia de Microsoft Fabric.

Identidades admitidas de Microsoft Entra

Esta API admite las identidades de Microsoft enumeradas en esta sección.

Identity	Support
User	Yes
Entidad de servicio e Identidades administradas	Yes

Interface

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/managedPrivateEndpoints

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
workspaceId	path	True	string (uuid)	Identificador del área de trabajo.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
name	True	string	Nombre del punto de conexión privado. No debe tener más de 64 caracteres.
targetPrivateLinkResourceId	True	string	Identificador de recurso del origen de datos para el que se debe crear el punto de conexión privado.
requestMessage		string	Mensaje para aprobar la solicitud de punto de conexión privado. No debe tener más de 140 caracteres.
targetFQDNs		string[]	Nombres de dominio completos (FQDN) que se van a asociar al punto de conexión privado. No debe ser superior a 20 FQDN.
targetSubresourceType		string	Subrecurso que apunta a private-link resoure.

Respuestas

Nombre Tipo Description

201 Created

Nombre	Tipo	Description
201 Created	ManagedPrivateEndpoint	Solicitud completada correctamente. Encabezados Location: string
429 Too Many Requests	ErrorResponse	Se superó el límite de frecuencia de servicio. El servidor devuelve un `Retry-After` encabezado que indica, en segundos, cuánto tiempo debe esperar el cliente antes de enviar solicitudes adicionales. Encabezados Retry-After: integer
Other Status Codes	ErrorResponse	Códigos de error comunes: UnknownError: se produjo un error.

ManagedPrivateEndpoint

Solicitud completada correctamente.

Encabezados

Location: string

429 Too Many Requests

ErrorResponse

Se superó el límite de frecuencia de servicio. El servidor devuelve un Retry-After encabezado que indica, en segundos, cuánto tiempo debe esperar el cliente antes de enviar solicitudes adicionales.

Encabezados

Retry-After: integer

Other Status Codes

ErrorResponse

Códigos de error comunes:

UnknownError: se produjo un error.

Ejemplos

Create a managed private endpoint example

Solicitud de ejemplo

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/47482db6-4583-4672-86dd-999d0f8f4d7a/managedPrivateEndpoints

{
  "name": "testprivatendpoint1",
  "targetPrivateLinkResourceId": "/subscriptions/2374e587-d28b-4898-a39c-6070e078ae31/resourceGroups/testrg/providers/Microsoft.Sql/servers/testsql1",
  "targetSubresourceType": "sqlServer",
  "requestMessage": "Request message to approve private endpoint"
}

Respuesta de muestra

status code:: 201

Location: https://api.fabric.microsoft.com/v1/workspaces/47482db6-4583-4672-86dd-999d0f8f4d7a/managedPrivateEndpoints/59a92b06-6e5a-468c-b748-e28c8ff28da3

{
  "id": "59a92b06-6e5a-468c-b748-e28c8ff28da3",
  "name": "SqlPE",
  "targetPrivateLinkResourceId": "/subscriptions/e3bf3f1a-4d64-4e42-85e9-aa1b84e3874/resourceGroups/testRG/providers/Microsoft.SqlServer/SqlServer/sql1",
  "provisioningState": "Provisioning",
  "targetSubresourceType": "sqlServer"
}

Definiciones

Nombre	Description
ConnectionStatus	Estado de conexión del punto de conexión privado. El estado de conexión adicional se puede agregar a lo largo del tiempo.
CreateManagedPrivateEndpointRequest	Cree una carga de solicitud de punto de conexión privado administrado.
ErrorRelatedResource	Objeto de detalles del recurso relacionado con el error.
ErrorResponse	Respuesta de error.
ErrorResponseDetails	Detalles de la respuesta de error.
ManagedPrivateEndpoint	Punto de conexión privado administrado.
PrivateEndpointConnectionState	Estado de conexión del punto de conexión privado
PrivateEndpointProvisioningState	Estado de aprovisionamiento del punto de conexión.

ConnectionStatus

Enumeración

Estado de conexión del punto de conexión privado. El estado de conexión adicional se puede agregar a lo largo del tiempo.

Valor	Description
Pending	Aprobación pendiente
Approved	Punto de conexión aprobado
Rejected	Punto de conexión rechazado
Disconnected	Punto de conexión desconectado

CreateManagedPrivateEndpointRequest

Objeto

Cree una carga de solicitud de punto de conexión privado administrado.

Nombre	Tipo	Description
name	string	Nombre del punto de conexión privado. No debe tener más de 64 caracteres.
requestMessage	string	Mensaje para aprobar la solicitud de punto de conexión privado. No debe tener más de 140 caracteres.
targetFQDNs	string[]	Nombres de dominio completos (FQDN) que se van a asociar al punto de conexión privado. No debe ser superior a 20 FQDN.
targetPrivateLinkResourceId	string	Identificador de recurso del origen de datos para el que se debe crear el punto de conexión privado.
targetSubresourceType	string	Subrecurso que apunta a private-link resoure.

ErrorRelatedResource

Objeto

Objeto de detalles del recurso relacionado con el error.

Nombre	Tipo	Description
resourceId	string	Identificador de recurso implicado en el error.
resourceType	string	Tipo del recurso implicado en el error.

ErrorResponse

Objeto

Respuesta de error.

Nombre	Tipo	Description
errorCode	string	Identificador específico que proporciona información sobre una condición de error, lo que permite una comunicación estandarizada entre nuestro servicio y sus usuarios.
isRetriable	boolean	Cuando es true, se puede reintentar la solicitud. Use el `Retry-After` encabezado de respuesta para determinar el retraso, si está disponible.
message	string	Representación legible del error.
moreDetails	ErrorResponseDetails[]	Lista de detalles de error adicionales.
relatedResource	ErrorRelatedResource	Detalles del recurso relacionado con el error.
requestId	string (uuid)	Identificador de la solicitud asociada al error.

ErrorResponseDetails

Objeto

Detalles de la respuesta de error.

Nombre	Tipo	Description
errorCode	string	Identificador específico que proporciona información sobre una condición de error, lo que permite una comunicación estandarizada entre nuestro servicio y sus usuarios.
message	string	Representación legible del error.
relatedResource	ErrorRelatedResource	Detalles del recurso relacionado con el error.