通过

Managed Private Endpoints - Create Workspace Managed Private Endpoint

服务:
Core
API 版本:
v1

在指定的工作区中创建托管专用终结点。

注释

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

权限

调用方必须具有 管理员 工作区角色。

所需的委派范围

Workspace.ReadWrite.All。

局限性

  • 若要创建托管专用终结点，工作区必须位于受支持的 Fabric 容量上。 有关详细信息，请参阅：Microsoft Fabric 许可证类型。

Microsoft Entra 支持的标识

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

身份 支持
用户 是的
服务主体 和 托管标识 是的

接口

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

URI 参数

名称 在 必需 类型 说明
workspaceId
 path True

string (uuid)

工作区 ID。

请求正文

名称 必需 类型 说明
name True

string

专用终结点名称。 不应超过 64 个字符。
targetPrivateLinkResourceId True

string

需要为其创建专用终结点的数据源的资源 ID。
requestMessage

string

用于批准专用终结点请求的消息。 不应超过 140 个字符。
targetFQDNs

string[]

要与专用终结点关联的完全限定域名（FQDN）。 不应超过 20 个 FQDN。
targetSubresourceType

string

指向 专用链接的子资源。

响应

名称 类型 说明
201 Created

ManagedPrivateEndpoint

请求成功完成。

标头

Location: string
Other Status Codes

ErrorResponse

常见错误代码：

  • UnknownError - 发生错误。

示例

Create a managed private endpoint example

示例请求

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

示例响应

状态代码:
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"
}

定义

名称 说明
ConnectionStatus

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

创建托管专用终结点请求有效负载。
ErrorRelatedResource

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

错误响应。
ErrorResponseDetails

错误响应详细信息。
ManagedPrivateEndpoint

托管专用终结点。
PrivateEndpointConnectionState

专用终结点连接状态
PrivateEndpointProvisioningState

终结点的预配状态。

ConnectionStatus

枚举

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

值 说明
Pending

待审批
Approved

已批准的终结点
Rejected

终结点被拒绝
Disconnected

终结点已断开连接

CreateManagedPrivateEndpointRequest

Object

创建托管专用终结点请求有效负载。

名称 类型 说明
name

string

专用终结点名称。 不应超过 64 个字符。
requestMessage

string

用于批准专用终结点请求的消息。 不应超过 140 个字符。
targetFQDNs

string[]

要与专用终结点关联的完全限定域名（FQDN）。 不应超过 20 个 FQDN。
targetPrivateLinkResourceId

string

需要为其创建专用终结点的数据源的资源 ID。
targetSubresourceType

string

指向 专用链接的子资源。

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

指向 专用链接的子资源。

PrivateEndpointConnectionState

Object

专用终结点连接状态

名称 类型 说明
actionsRequired

string

建立连接所需的作。
description

string

说明消息（如果有）在批准或拒绝终点时提供。
status

ConnectionStatus

连接状态

PrivateEndpointProvisioningState

枚举

终结点的预配状态。

值 说明
Provisioning

预配中的专用终结点正在进行中
Succeeded

专用终结点预配成功
Updating

专用终结点更新
Deleting

删除专用终结点
Failed

专用终结点预配失败