Managed Private Endpoints - List Workspace Managed Private Endpoints

服务:: Core

API 版本:: v1

返回与指定工作区关联的托管专用终结点的列表。

注释

此 API 是预览版的一部分，仅用于评估和开发目的。它可能会根据反馈进行更改，不建议将其用于生产。

Permissions

调用方必须具有 查看器 或更高版本的工作区角色。

所需的委派范围

Workspace.Read.All 或 Workspace.ReadWrite.All

Microsoft Entra 支持的标识

此 API 支持本节中列出的Microsoft 标识。

Identity	Support
User	Yes
服务主体和托管标识	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 参数

名称	在	必需	类型	说明
workspaceId	path	True	string (uuid)	工作区 ID。
continuationToken	query		string	用于检索下一页结果的令牌。

响应

名称	类型	说明
200 OK	ManagedPrivateEndpoints	请求成功完成。
Other Status Codes	ErrorResponse	常见错误代码： UnknownError - 发生错误。

名称

类型

说明

200 OK

ManagedPrivateEndpoints

请求成功完成。

Other Status Codes

ErrorResponse

常见错误代码：

UnknownError - 发生错误。

示例

List managed private endpoints in workspace example

List managed private endpoints in workspace with continuation example

List managed private endpoints in workspace example

示例请求

HTTP

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

示例响应

状态代码:: 200

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

示例请求

HTTP

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

示例响应

状态代码:: 200

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

定义

名称	说明
ConnectionStatus	专用终结点连接状态。可能会随着时间的推移添加其他连接状态。
ErrorRelatedResource	与错误相关的资源详细信息对象。
ErrorResponse	错误响应。
ErrorResponseDetails	错误响应详细信息。
ManagedPrivateEndpoint	托管专用终结点。
ManagedPrivateEndpoints
PrivateEndpointConnectionState	专用终结点连接状态
PrivateEndpointProvisioningState	终结点的预配状态。

ConnectionStatus

枚举

专用终结点连接状态。可能会随着时间的推移添加其他连接状态。

值	说明
Pending	待审批
Approved	已批准的终结点
Rejected	终结点被拒绝
Disconnected	终结点已断开连接

ErrorRelatedResource

Object

与错误相关的资源详细信息对象。

名称	类型	说明
resourceId	string	错误中涉及的资源 ID。
resourceType	string	错误中涉及的资源的类型。

ErrorResponse

Object

错误响应。

名称	类型	说明
errorCode	string	提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。
message	string	错误的人工可读表示形式。
moreDetails	ErrorResponseDetails[]	其他错误详细信息的列表。
relatedResource	ErrorRelatedResource	与错误相关的资源详细信息。
requestId	string	与错误关联的请求的 ID。

ErrorResponseDetails

Object

错误响应详细信息。

名称	类型	说明
errorCode	string	提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。
message	string	错误的人工可读表示形式。
relatedResource	ErrorRelatedResource	与错误相关的资源详细信息。

ManagedPrivateEndpoint

Object

托管专用终结点。

名称	类型	说明
connectionState	PrivateEndpointConnectionState	已预配终结点的终结点连接状态。
id	string (uuid)	托管专用终结点 ID。
name	string	专用终结点名称。
provisioningState	PrivateEndpointProvisioningState	终结点的预配状态。
targetPrivateLinkResourceId	string	为其创建专用终结点的数据源的资源 ID
targetSubresourceType	string	指向专用链接的子资源。

ManagedPrivateEndpoints

Object

名称	类型	说明
continuationToken	string	下一个结果集批处理的令牌。如果没有更多记录，则会从响应中删除该记录。
continuationUri	string	下一个结果集批处理的 URI。如果没有更多记录，则会从响应中删除该记录。
value	ManagedPrivateEndpoint[]	托管专用终结点的列表。

PrivateEndpointConnectionState

Object

专用终结点连接状态

名称	类型	说明
actionsRequired	string	建立连接所需的作。
description	string	说明消息（如果有）在批准或拒绝终点时提供。
status	ConnectionStatus	连接状态

PrivateEndpointProvisioningState

枚举

终结点的预配状态。

值	说明
Provisioning	预配中的专用终结点正在进行中
Succeeded	专用终结点预配成功
Updating	专用终结点更新
Deleting	删除专用终结点
Failed	专用终结点预配失败

通过

Managed Private Endpoints - List Workspace Managed Private Endpoints

Permissions

所需的委派范围

Microsoft Entra 支持的标识

Interface

URI 参数

响应

示例

List managed private endpoints in workspace example

示例请求

示例响应

List managed private endpoints in workspace with continuation example

示例请求

示例响应

定义

ConnectionStatus

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ManagedPrivateEndpoint

ManagedPrivateEndpoints

PrivateEndpointConnectionState

PrivateEndpointProvisioningState