Items - List Warehouses

服务:

Warehouse

API 版本:

v1

返回指定工作区中的仓库列表。
此 API 支持 分页。

权限

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

所需的委派范围

Workspace.Read.All 或 Workspace.ReadWrite.All

Microsoft Entra 支持的标识

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

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

接口

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/warehouses

具有可选参数:

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

URI 参数

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

响应

名称	类型	说明
200 OK	Warehouses	请求成功完成。
Other Status Codes	ErrorResponse	常见错误代码： InvalidItemType - 项类型无效。

示例

List warehouses in workspace example

示例请求

HTTP

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

示例响应

状态代码:

200

{
  "value": [
    {
      "id": "3546052c-ae64-4526-b1a8-52af7761426f",
      "displayName": "Warehouse Name 1",
      "description": "A warehouse description.",
      "type": "Warehouse",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "properties": {
        "connectionString": "qvrmbuxie7we7glrekxgy6npqu-6xgyei3x2xiejip4iime6knh5m.datawarehouse.fabric.microsoft.com",
        "createdDate": "2023-09-28T22:52:13.78",
        "lastUpdatedTime": "2023-10-04T22:56:33.283",
        "collationType": "Latin1_General_100_CI_AS_KS_WS_SC_UTF8"
      }
    },
    {
      "id": "6281bf94-81b9-46b2-b8d3-79bb868fc822",
      "displayName": "Warehouse Name 2",
      "description": "A warehouse description.",
      "type": "Warehouse",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "properties": {
        "connectionString": "qvrmbuxie7we7glrekxgy6npqu-6xgyei3x2xiejip4iime6knh5m.datawarehouse.fabric.microsoft.com",
        "createdDate": "2023-11-21T13:14:30.54",
        "lastUpdatedTime": "2023-12-04T20:03:43.110",
        "collationType": "Latin1_General_100_BIN2_UTF8"
      }
    }
  ]
}

定义

名称	说明
CollationType	仓库排序规则。 可能会随着时间的推移添加其他 collations。
ErrorRelatedResource	与错误相关的资源详细信息对象。
ErrorResponse	错误响应。
ErrorResponseDetails	错误响应详细信息。
ItemType	项的类型。 可能会随着时间的推移添加其他项类型。
Warehouse	仓库对象。
WarehouseProperties	仓库项属性。
Warehouses	仓库列表。

CollationType

Enumeration

仓库排序规则。 可能会随着时间的推移添加其他 collations。

值	说明
Latin1_General_100_BIN2_UTF8	默认值 - 区分大小写 （CS） 排序规则
Latin1_General_100_CI_AS_KS_WS_SC_UTF8	不区分大小写 （CI） 排序规则

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

ItemType

Enumeration

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

值	说明
Dashboard	PowerBI 仪表板。
DataPipeline	数据管道。
Datamart	PowerBI Datamart。
Environment	环境。
Eventhouse	事件屋。
Eventstream	事件流。
GraphQLApi	GraphQL 项的 API。
KQLDashboard	KQL 仪表板。
KQLDatabase	KQL 数据库。
KQLQueryset	KQL 查询集。
Lakehouse	湖屋
MLExperiment	机器学习试验。
MLModel	机器学习模型。
MirroredDatabase	镜像数据库。
MirroredWarehouse	镜像仓库。
MountedDataFactory	MountedDataFactory。
Notebook	笔记本。
PaginatedReport	PowerBI 分页报表。
Reflex	反射。
Report	PowerBI 报表。
SQLDatabase	SQLDatabase。
SQLEndpoint	SQL 终结点。
SemanticModel	PowerBI 语义模型。
SparkJobDefinition	spark 作业定义。
Warehouse	仓库。

Warehouse

Object

仓库对象。

名称	类型	说明
description	string	项说明。
displayName	string	项显示名称。
id	string uuid	项 ID。
properties	WarehouseProperties	仓库属性。
type	ItemType	项类型。
workspaceId	string uuid	工作区 ID。

WarehouseProperties

Object

仓库项属性。

名称	类型	说明
collationType	CollationType	仓库的排序规则类型。
connectionString	string	连接到包含此仓库的工作区的 SQL 连接字符串。
createdDate	string date-time	创建仓库的日期和时间。
lastUpdatedTime	string date-time	上次更新仓库的日期和时间

Warehouses

Object

仓库列表。

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