Items - List Warehouses

  • Reference
Service:
Warehouse
API Version:
v1

Returns a list of warehouses from the specified workspace.

This API supports pagination.

Permissions

The caller must have viewer or higher workspace role.

Required Delegated Scopes

Workspace.Read.All or Workspace.ReadWrite.All

Microsoft Entra supported identities

This API supports the Microsoft identities listed in this section.

Identity Support
User Yes
Service principal No
Managed identities No

Interface

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

URI Parameters

Name In Required Type Description
workspaceId
 path True

string

uuid

The workspace ID.
continuationToken
 query

string

A token for retrieving the next page of results.

Responses

Name Type Description
200 OK

Warehouses

Request completed successfully.
Other Status Codes

ErrorResponse

Common error codes:

  • InvalidItemType - Invalid item type.

Examples

List warehouses in workspace example

Sample request

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

Sample response

Status code:
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"
      }
    },
    {
      "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"
      }
    }
  ]
}

Definitions

Name Description
ErrorRelatedResource

The error related resource details object.
ErrorResponse

The error response.
ErrorResponseDetails

The error response details.
ItemType

The type of the item. Additional item types may be added over time.
Warehouse

A warehouse object.
WarehouseProperties

The warehouse item properties.
Warehouses

A list of warehouses.

ErrorRelatedResource

The error related resource details object.

Name Type Description
resourceId

string

The resource ID that's involved in the error.
resourceType

string

The type of the resource that's involved in the error.

ErrorResponse

The error response.

Name Type Description
errorCode

string

A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message

string

A human readable representation of the error.
moreDetails

ErrorResponseDetails[]

List of additional error details.
relatedResource

ErrorRelatedResource

The error related resource details.
requestId

string

ID of the request associated with the error.

ErrorResponseDetails

The error response details.

Name Type Description
errorCode

string

A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message

string

A human readable representation of the error.
relatedResource

ErrorRelatedResource

The error related resource details.

ItemType

The type of the item. Additional item types may be added over time.

Name Type Description
Dashboard

string

PowerBI dashboard.
DataPipeline

string

A data pipeline.
Datamart

string

PowerBI datamart.
Environment

string

An environment.
Eventhouse

string

An eventhouse.
Eventstream

string

An eventstream.
KQLDashboard

string

A KQL dashboard.
KQLDatabase

string

A KQL database.
KQLQueryset

string

A KQL queryset.
Lakehouse

string

A lakehouse.
MLExperiment

string

A machine learning experiment.
MLModel

string

A machine learning model.
MirroredDatabase

string

A mirrored database.
MirroredWarehouse

string

A mirrored warehouse.
Notebook

string

A notebook.
PaginatedReport

string

PowerBI paginated report.
Report

string

PowerBI report.
SQLEndpoint

string

An SQL endpoint.
SemanticModel

string

PowerBI semantic model.
SparkJobDefinition

string

A spark job definition.
Warehouse

string

A warehouse.

Warehouse

A warehouse object.

Name Type Description
description

string

The item description.
displayName

string

The item display name.
id

string

The item ID.
properties

WarehouseProperties

The warehouse properties.
type

ItemType

The item type.
workspaceId

string

The workspace ID.

WarehouseProperties

The warehouse item properties.

Name Type Description
connectionString

string

The SQL connection string connected to the workspace containing this warehouse.
createdDate

string

The date and time the warehouse was created.
lastUpdatedTime

string

The date and time the warehouse was last updated

Warehouses

A list of warehouses.

Name Type Description
continuationToken

string

The token for the next result set batch. If there are no more records, it's removed from the response.
continuationUri

string

The URI of the next result set batch. If there are no more records, it's removed from the response.
value

Warehouse[]

A list of warehouses.