Edit

Share via


Managed Private Endpoints - List Workspace Managed Private Endpoints

Note

This API is in preview.

Returns a list of managed private endpoints associated with the specified workspace.

Permissions

The caller must have viewer or higher workspace role.

Required Delegated Scopes

Workspace.Read.All or Workspace.ReadWrite.All

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

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/managedPrivateEndpoints
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/managedPrivateEndpoints?continuationToken={continuationToken}

URI Parameters

Name In Required Type Description
workspaceId
path True

string (uuid)

The workspace ID.

continuationToken
query

string

A token for retrieving the next page of results.

Responses

Name Type Description
200 OK

ManagedPrivateEndpoints

Request completed successfully.

Other Status Codes

ErrorResponse

Common error codes:

  • UnknownError - An error occurred.

Examples

List managed private endpoints in workspace example
List managed private endpoints in workspace with continuation example

List managed private endpoints in workspace example

Sample request

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

Sample response

{
  "value": [
    {
      "id": "59a92b06-6e5a-468c-b748-e28c8ff28da3",
      "name": "SqlPE",
      "targetPrivateLinkResourceId": "/subscriptions/e3bf3f1a-4d64-4e42-85e9-aa1b84e3874/resourceGroups/testRG/providers/Microsoft.SqlServer/SqlServer/sql1",
      "provisioningState": "Succeeded",
      "connectionState": {
        "status": "Approved",
        "description": "Endpoint approved"
      },
      "targetSubresourceType": "sqlServer"
    },
    {
      "id": "1b56faf6-9cb8-4506-8c6c-83e0aece804f",
      "name": "BlobPE",
      "targetPrivateLinkResourceId": "/subscriptions/73310022-c811-4844-8b73-f9baa17c0d08/resourceGroups/testRG2/providers/Microsoft.Storage/storageAccounts/storage1",
      "provisioningState": "Succeeded",
      "connectionState": {
        "status": "Approved",
        "description": "Endpoint approval provided"
      },
      "targetSubresourceType": "blob"
    }
  ]
}

List managed private endpoints in workspace with continuation example

Sample request

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

Sample response

{
  "value": [
    {
      "id": "59a92b06-6e5a-468c-b748-e28c8ff28da3",
      "name": "SqlPE",
      "targetPrivateLinkResourceId": "/subscriptions/e3bf3f1a-4d64-4e42-85e9-aa1b84e3874/resourceGroups/testRG/providers/Microsoft.SqlServer/SqlServer/sql1",
      "provisioningState": "Succeeded",
      "connectionState": {
        "status": "Approved",
        "description": "Endpoint approved"
      },
      "targetSubresourceType": "sqlServer"
    },
    {
      "id": "1b56faf6-9cb8-4506-8c6c-83e0aece804f",
      "name": "BlobPE",
      "targetPrivateLinkResourceId": "/subscriptions/73310022-c811-4844-8b73-f9baa17c0d08/resourceGroups/testRG2/providers/Microsoft.Storage/storageAccounts/storage1",
      "provisioningState": "Succeeded",
      "connectionState": {
        "status": "Approved",
        "description": "Endpoint approval provided"
      },
      "targetSubresourceType": "blob"
    }
  ],
  "continuationToken": "LDEsMTAwMDAwLDA%3D",
  "continuationUri": "https://api.fabric.microsoft.com/v1/workspaces/47482db6-4583-4672-86dd-999d0f8f4d7a/managedPrivateEndpoints?continuationToken=LDEsMTAwMDAwLDA%3D"
}

Definitions

Name Description
ConnectionStatus

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

ErrorRelatedResource

The error related resource details object.

ErrorResponse

The error response.

ErrorResponseDetails

The error response details.

ManagedPrivateEndpoint

Managed private endpoint.

ManagedPrivateEndpoints
PrivateEndpointConnectionState

Private endpoint connection state

PrivateEndpointProvisioningState

Provisioning state of endpoint.

ConnectionStatus

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

ErrorRelatedResource

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

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

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.

ManagedPrivateEndpoint

Managed private endpoint.

Name Type Description
connectionState

PrivateEndpointConnectionState

Endpoint connection state of provisioned endpoints.

id

string (uuid)

Managed private endpoint Id.

name

string

The private endpoint name.

provisioningState

PrivateEndpointProvisioningState

Provisioning state of endpoint.

targetPrivateLinkResourceId

string

Resource Id of data source for which private endpoint is created

targetSubresourceType

string

Sub-resource pointing to Private-link resoure.

ManagedPrivateEndpoints

Name Type Description
continuationToken

string

The token for the next result set batch. If there are no more records, it's removed from the response.

continuationUri

string

The URI of the next result set batch. If there are no more records, it's removed from the response.

value

ManagedPrivateEndpoint[]

A list of managed private endpoints.

PrivateEndpointConnectionState

Private endpoint connection state

Name Type Description
actionsRequired

string

Actions required to establish connection.

description

string

Description message (if any) provided on approving or rejecting the end point.

status

ConnectionStatus

Connection status

PrivateEndpointProvisioningState

Provisioning state of endpoint.

Value Description
Provisioning

Private endpoint in provisioning is in-progress

Succeeded

Private endpoint provisioning Succeeded

Updating

Private endpoint updating

Deleting

Private endpoint deleting

Failed

Private endpoint provisioning failed