Managed Private Endpoints - Create Workspace Managed Private Endpoint

Service:: Core

API Version:: v1

Creates a managed private endpoint in the specified workspace.

Permissions

The caller must have admin workspace role.

Required Delegated Scopes

Workspace.ReadWrite.All.

Limitations

To create managed private endpoint the workspace must be on a supported Fabric capacity. For more information see: Microsoft Fabric license types.

Microsoft Entra supported identities

This API supports the Microsoft identities listed in this section.

Identity	Support
User	Yes
Service principal and Managed identities	Yes

Interface

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

URI Parameters

Name	In	Required	Type	Description
workspaceId	path	True	string (uuid)	The workspace ID.

Request Body

Name	Required	Type	Description
name	True	string	The private endpoint name. Should not be more than 64 characters.
targetPrivateLinkResourceId	True	string	Resource Id of data source for which private endpoint needs to be created.
requestMessage		string	Message to approve private endpoint request. Should not be more than 140 characters.
targetFQDNs		string[]	Fully qualified domain names (FQDNs) to be associated with the private endpoint. Should not be more than 20 FQDNs.
targetSubresourceType		string	Sub-resource pointing to Private-link resoure.

Responses

Name	Type	Description
201 Created	ManagedPrivateEndpoint	Request completed successfully. Headers Location: string
Other Status Codes	ErrorResponse	Common error codes: UnknownError - An error occurred.

Name

Type

Description

201 Created

ManagedPrivateEndpoint

Request completed successfully.

Headers

Location: string

Other Status Codes

ErrorResponse

Common error codes:

UnknownError - An error occurred.

Examples

Create a managed private endpoint example

Create a managed private endpont with FQDNs example

Create a managed private endpoint example

Sample request

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"
}

Sample response

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"
}

Create a managed private endpont with FQDNs example

Sample request

HTTP

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

{
  "name": "testprivatendpoint2",
  "targetPrivateLinkResourceId": "/subscriptions/2374e587-d28b-4898-a39c-6070e078ae31/resourceGroups/testrg/providers/Microsoft.Network/privatelinkservice/pls1",
  "requestMessage": "Request message to approve private endpoint",
  "targetFQDNs": [
    "database1.cloudprovider.net",
    "database2.cloudprovider.net"
  ]
}

Sample response

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": "testprivateendpoint2",
  "targetPrivateLinkResourceId": "/subscriptions/2374e587-d28b-4898-a39c-6070e078ae31/resourceGroups/testrg/providers/Microsoft.Network/privatelinkservice/pls1",
  "provisioningState": "Provisioning"
}

Definitions

Name	Description
ConnectionStatus	Private endpoint connection status. Additional connection status may be added over time.
CreateManagedPrivateEndpointRequest	Create managed private endpoint request payload.
ErrorRelatedResource	The error related resource details object.
ErrorResponse	The error response.
ErrorResponseDetails	The error response details.
ManagedPrivateEndpoint	Managed private endpoint.
PrivateEndpointConnectionState	Private endpoint connection state
PrivateEndpointProvisioningState	Provisioning state of endpoint.

ConnectionStatus

Enumeration

Private endpoint connection status. Additional connection status may be added over time.

Value	Description
Pending	Pending approval
Approved	Endpoint approved
Rejected	Endpoint rejected
Disconnected	Endpoint disconnected

CreateManagedPrivateEndpointRequest

Object

Create managed private endpoint request payload.

Name	Type	Description
name	string	The private endpoint name. Should not be more than 64 characters.
requestMessage	string	Message to approve private endpoint request. Should not be more than 140 characters.
targetFQDNs	string[]	Fully qualified domain names (FQDNs) to be associated with the private endpoint. Should not be more than 20 FQDNs.
targetPrivateLinkResourceId	string	Resource Id of data source for which private endpoint needs to be created.
targetSubresourceType	string	Sub-resource pointing to Private-link resoure.

ErrorRelatedResource

Object

The error related resource details object.

Name	Type	Description
resourceId	string	The resource ID that's involved in the error.
resourceType	string	The type of the resource that's involved in the error.

ErrorResponse

Object

The error response.

Name	Type	Description
errorCode	string	A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message	string	A human readable representation of the error.
moreDetails	ErrorResponseDetails[]	List of additional error details.
relatedResource	ErrorRelatedResource	The error related resource details.
requestId	string	ID of the request associated with the error.

ErrorResponseDetails

Object

The error response details.

Name	Type	Description
errorCode	string	A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message	string	A human readable representation of the error.
relatedResource	ErrorRelatedResource	The error related resource details.