Items - Get Warehouse Snapshot

Service:

WarehouseSnapshot

API Version:

v1

Returns properties of the specified Warehouse snapshot.

Permissions

The caller must have read permissions for the warehouse snapshot.

Required Delegated Scopes

WarehouseSnapshot.Read.All or WarehouseSnapshot.ReadWrite.All or Item.Read.All or Item.ReadWrite.All

Microsoft Entra supported identities

This API supports the Microsoft identities listed in this section.

Identity	Support
User	Yes
Service principal and Managed identities	Yes

Interface

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

URI Parameters

Name	In	Required	Type	Description
warehouseSnapshotId	path	True	string (uuid)	The Warehouse snapshot ID.
workspaceId	path	True	string (uuid)	The workspace ID.

Responses

Name	Type	Description
200 OK	WarehouseSnapshot	Request completed successfully.
Other Status Codes	ErrorResponse	Common error codes: ItemNotFound - The requested item was not found.

Examples

Get a Warehouse snapshot example

Sample request

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/warehousesnapshots/41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87

Sample response

Status code:

200

{
  "id": "5b218778-e7a5-4d73-8187-f10824047715",
  "displayName": "WarehouseSnapshot 1",
  "description": "A WarehouseSnapshot description.",
  "type": "WarehouseSnapshot",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "properties": {
    "connectionString": "qvrmbuxie7we7glrekxgy6npqu-6xgyei3x2xiejip4iime6knh5m.datawarehouse.fabric.microsoft.com",
    "parentWarehouseId": "7332259c-fb34-4975-99db-85818fb8664f",
    "snapshotDateTime": "2024-10-10T15:20:15Z"
  }
}

Definitions

Name	Description
ErrorRelatedResource	The error related resource details object.
ErrorResponse	The error response.
ErrorResponseDetails	The error response details.
ItemTag	Represents a tag applied on an item.
ItemType	The type of the item. Additional item types may be added over time.
WarehouseSnapshot	A Warehouse snapshot object.
WarehouseSnapshotProperties	The Warehouse snapshot properties.

ErrorRelatedResource

Object

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

Object

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

Object

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.

ItemTag

Object

Represents a tag applied on an item.

Name	Type	Description
displayName	string	The name of the tag.
id	string (uuid)	The tag ID.

ItemType

Enumeration

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

Value	Description
Dashboard	PowerBI dashboard.
Report	PowerBI report.
SemanticModel	PowerBI semantic model.
PaginatedReport	PowerBI paginated report.
Datamart	PowerBI datamart.
Lakehouse	A lakehouse.
Eventhouse	An eventhouse.
Environment	An environment.
KQLDatabase	A KQL database.
KQLQueryset	A KQL queryset.
KQLDashboard	A KQL dashboard.
DataPipeline	A data pipeline.
Notebook	A notebook.
SparkJobDefinition	A spark job definition.
MLExperiment	A machine learning experiment.
MLModel	A machine learning model.
Warehouse	A warehouse.
Eventstream	An eventstream.
SQLEndpoint	An SQL endpoint.
MirroredWarehouse	A mirrored warehouse.
MirroredDatabase	A mirrored database.
Reflex	A Reflex.
GraphQLApi	An API for GraphQL item.
MountedDataFactory	A MountedDataFactory.
SQLDatabase	A SQLDatabase.
CopyJob	A Copy job.
VariableLibrary	A VariableLibrary.
Dataflow	A Dataflow.
ApacheAirflowJob	An ApacheAirflowJob.
WarehouseSnapshot	A Warehouse snapshot.
DigitalTwinBuilder	A DigitalTwinBuilder.
DigitalTwinBuilderFlow	A Digital Twin Builder Flow.
MirroredAzureDatabricksCatalog	A mirrored azure databricks catalog.

WarehouseSnapshot

Object

A Warehouse snapshot object.

Name	Type	Description
description	string	The item description.
displayName	string	The item display name.
folderId	string (uuid)	The folder ID.
id	string (uuid)	The item ID.
properties	WarehouseSnapshotProperties	The Warehouse snapshot properties.
tags	ItemTag[]	List of applied tags.
type	ItemType	The item type.
workspaceId	string (uuid)	The workspace ID.

WarehouseSnapshotProperties

Object

The Warehouse snapshot properties.

Name	Type	Description
connectionString	string	The SQL connection string connected to the workspace containing this warehouse.
parentWarehouseId	string	The parent Warehouse ID.
snapshotDateTime	string (date-time)	The current warehouse snapshot date and time in UTC, using the YYYY-MM-DDTHH:mm:ssZ format.