Items - List Item Connections

服务:: Core

API 版本:: v1

返回指定项连接到的连接列表。
此 API 支持分页。

权限

调用方必须具有项的 读取和写入 权限。

所需的委派范围

对于项 API，请使用以下范围类型：

泛型范围：Item.ReadWrite.All
特定范围：itemType。ReadWrite.All（例如：Notebook.ReadWrite.All）

有关范围的详细信息，请参阅 Scopes 文章。

局限性

除非调用方具有删除敏感度标签的使用权限，否则对于具有受保护敏感度标签的项目，将阻止此 API。

Microsoft Entra 支持的标识

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

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

接口

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/connections

具有可选参数:

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

URI 参数

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

响应

名称	类型	说明
200 OK	ItemConnections	请求成功完成。
Other Status Codes	ErrorResponse	常见错误代码： ItemNotFound - 指示服务器找不到请求的项目。

名称

类型

说明

200 OK

ItemConnections

请求成功完成。

Other Status Codes

ErrorResponse

常见错误代码：

ItemNotFound - 指示服务器找不到请求的项目。

示例

List item connections - Semantic Model Direct Lake example

List item connections example

List item connections with continuation example

List item connections - Semantic Model Direct Lake example

示例请求

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/4b218778-e7a5-4d73-8187-f10824047715/items/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7/connections

示例响应

状态代码:: 200

{
  "value": [
    {
      "connectivityType": "Automatic",
      "connectionDetails": {
        "type": "SQL",
        "path": "xqoruksalslrtkdxe2bvrlwgsi-5j2iqepw1i3ucdp6bepe62hcii.datawarehouse.fabric.microsoft.com;532183f5-ac60-4d12-0fc5-4094532f14b5"
      }
    }
  ]
}

List item connections example

示例请求

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/4b218778-e7a5-4d73-8187-f10824047715/items/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7/connections

示例响应

状态代码:: 200

{
  "value": [
    {
      "connectivityType": "ShareableCloud",
      "displayName": "ContosoConnection1",
      "id": "6952a7b2-aea3-414f-9d85-6c0fe5d34539",
      "connectionDetails": {
        "type": "Web",
        "path": "https://www.contoso.com"
      }
    },
    {
      "connectivityType": "OnPremisesGateway",
      "displayName": "ContosoConnection2",
      "id": "0b9af1bd-e974-4893-8947-d89d5a560385",
      "gatewayId": "58376c10-5f61-4024-887e-748df4beae45",
      "connectionDetails": {
        "type": "SQL",
        "path": "contoso.database.windows.net;sales"
      }
    }
  ]
}

List item connections with continuation example

示例请求

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/4b218778-e7a5-4d73-8187-f10824047715/items/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7/connections

示例响应

状态代码:: 200

{
  "value": [
    {
      "connectivityType": "Automatic",
      "connectionDetails": {
        "type": "SQL",
        "path": "xqoruksalslrtkdxe2bvrlwgsi-5j2iqepw1i3ucdp6bepe62hcii.datawarehouse.fabric.microsoft.com;532183f5-ac60-4d12-0fc5-4094532f14b5"
      }
    }
  ]
}

定义

名称	说明
ConnectivityType	连接的连接类型。可能会随着时间的推移添加其他连接类型。
ErrorRelatedResource	与错误相关的资源详细信息对象。
ErrorResponse	错误响应。
ErrorResponseDetails	错误响应详细信息。
ItemConnection
ItemConnections
ListConnectionDetails	列表作的连接详细信息输出。

ConnectivityType

枚举

连接的连接类型。可能会随着时间的推移添加其他连接类型。

值	说明
ShareableCloud	连接通过云进行连接，可与其他人共享。
PersonalCloud	连接通过云进行连接，无法与他人共享。
OnPremisesGateway	连接通过本地数据网关进行连接。
OnPremisesGatewayPersonal	连接通过个人本地数据网关进行连接。
VirtualNetworkGateway	连接通过虚拟网络数据网关进行连接。
Automatic	连接使用隐式数据连接通过云进行连接。此选项仅适用于使用单一 Sign-On（SSO）的特定方案。”
None	连接未绑定

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	与错误相关的资源详细信息。

ItemConnection

Object

名称	类型	说明
connectionDetails	ListConnectionDetails	连接的连接详细信息。
connectivityType	ConnectivityType	连接的连接类型。
displayName	string	连接的显示名称。最大长度为 200 个字符。
gatewayId	string (uuid)	连接的网关对象 ID。
id	string (uuid)	连接的对象 ID。

ItemConnections

Object

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

ListConnectionDetails

Object

列表作的连接详细信息输出。

名称	类型	说明
path	string	连接的路径。
type	string	连接的类型。

通过

Items - List Item Connections

权限

所需的委派范围

局限性

Microsoft Entra 支持的标识

接口

URI 参数

响应

示例

List item connections - Semantic Model Direct Lake example

示例请求

示例响应

List item connections example

示例请求

示例响应

List item connections with continuation example

示例请求

示例响应

定义

ConnectivityType

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemConnection

ItemConnections

ListConnectionDetails