通过

Items - List SQL Endpoints

服务:
SQLEndpoint
API 版本:
v1

从指定的工作区返回 SQL 终结点的列表。
此 API 支持 分页。

Permissions

调用方必须具有 查看器 工作区角色。

所需的委派范围

Workspace.Read.All 或 Workspace.ReadWrite.All

Microsoft Entra 支持的标识

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

Identity Support
User Yes
服务主体和托管标识 No

Interface

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/sqlEndpoints
具有可选参数: 
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/sqlEndpoints?continuationToken={continuationToken}

URI 参数

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

string (uuid)

工作区 ID。
continuationToken
 query

string

用于检索下一页结果的令牌。

响应

名称 类型 说明
200 OK

SQLEndpoints

请求成功完成。
Other Status Codes

ErrorResponse

常见错误代码：

  • InvalidItemType - 项类型无效。

示例

List SQL endpoints in workspace example

示例请求

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/sqlEndpoints

示例响应

状态代码:
200 
{
  "value": [
    {
      "id": "3546052c-ae64-4526-b1a8-52af7761426f",
      "displayName": "SQLEndpoint Name 1",
      "description": "A SQL endpoint description.",
      "type": "SQLEndpoint",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
    }
  ]
}

定义

名称 说明
ErrorRelatedResource

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

错误响应。
ErrorResponseDetails

错误响应详细信息。
ItemTag

表示应用于项的标记。
ItemType

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

SQL 终结点对象。
SQLEndpoints

SQL 终结点的列表。

ErrorRelatedResource

对象

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

名称 类型 说明
resourceId

string

错误中涉及的资源 ID。
resourceType

string

错误中涉及的资源的类型。

ErrorResponse

对象

错误响应。

名称 类型 说明
errorCode

string

提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。
message

string

错误的人工可读表示形式。
moreDetails

ErrorResponseDetails[]

其他错误详细信息的列表。
relatedResource

ErrorRelatedResource

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

string

与错误关联的请求的 ID。

ErrorResponseDetails

对象

错误响应详细信息。

名称 类型 说明
errorCode

string

提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。
message

string

错误的人工可读表示形式。
relatedResource

ErrorRelatedResource

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

ItemTag

对象

表示应用于项的标记。

名称 类型 说明
displayName

string

标签的名称。
id

string (uuid)

标记 ID。

ItemType

枚举

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

值 说明
Dashboard

PowerBI 仪表板。
Report

PowerBI 报表。
SemanticModel

PowerBI 语义模型。
PaginatedReport

PowerBI 分页报表。
Datamart

PowerBI Datamart。
Lakehouse

湖屋
Eventhouse

事件屋。
Environment

环境。
KQLDatabase

KQL 数据库。
KQLQueryset

KQL 查询集。
KQLDashboard

KQL 仪表板。
DataPipeline

数据管道。
Notebook

笔记本。
SparkJobDefinition

spark 作业定义。
MLExperiment

机器学习试验。
MLModel

机器学习模型。
Warehouse

仓库。
Eventstream

事件流。
SQLEndpoint

SQL 终结点。
MirroredWarehouse

镜像仓库。
MirroredDatabase

镜像数据库。
Reflex

反射。
GraphQLApi

GraphQL 项的 API。
MountedDataFactory

MountedDataFactory。
SQLDatabase

SQLDatabase。
CopyJob

复制作业。
VariableLibrary

VariableLibrary。
Dataflow

数据流。
ApacheAirflowJob

ApacheAirflowJob。
WarehouseSnapshot

仓库快照。
DigitalTwinBuilder

DigitalTwinBuilder。
DigitalTwinBuilderFlow

数字孪生生成器流。
MirroredAzureDatabricksCatalog

镜像的 Azure databricks 目录。
Map

地图。
AnomalyDetector

异常检测器。
UserDataFunction

用户数据函数。
GraphModel

GraphModel。
GraphQuerySet

图形查询集。
SnowflakeDatabase

用于存储从 Snowflake 帐户创建的 Iceberg 表的 Snowflake 数据库。
OperationsAgent

OperationsAgent。
CosmosDBDatabase

Cosmos DB 数据库。

SQLEndpoint

对象

SQL 终结点对象。

名称 类型 说明
description

string

项说明。
displayName

string

项显示名称。
folderId

string (uuid)

文件夹 ID。
id

string (uuid)

项 ID。
tags

ItemTag[]

已应用的标记列表。
type

ItemType

项类型。
workspaceId

string (uuid)

工作区 ID。

SQLEndpoints

对象

SQL 终结点的列表。

名称 类型 说明
continuationToken

string

下一个结果集批处理的令牌。 如果没有更多记录，则会从响应中删除该记录。
continuationUri

string

下一个结果集批处理的 URI。 如果没有更多记录，则会从响应中删除该记录。
value

SQLEndpoint[]

SQL 终结点的列表。