Discovery - Discover Catalogs

Service:

MirroredAzureDatabricksCatalog

API Version:

v1

Note

This API is in preview.

Returns a list of catalogs from Unity Catalog.
This API supports pagination.

Permissions

The caller must have viewer or higher workspace role.

Required Delegated Scopes

Workspace.Read.All or Workspace.ReadWrite.All or DatabricksCatalog.Read.All

Microsoft Entra supported identities

This API supports the Microsoft identities listed in this section.

Identity	Support
User	Yes
Service principal and Managed identities	No

Interface

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/azuredatabricks/catalogs?databricksWorkspaceConnectionId={databricksWorkspaceConnectionId}

With optional parameters:

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/azuredatabricks/catalogs?databricksWorkspaceConnectionId={databricksWorkspaceConnectionId}&continuationToken={continuationToken}&maxResults={maxResults}

URI Parameters

Name	In	Required	Type	Description
workspaceId	path	True	string (uuid)	The workspace ID.
databricksWorkspaceConnectionId	query	True	string (uuid)	The Databricks workspace connection ID.
continuationToken	query		string	A token for retrieving the next page of results.
maxResults	query		integer	The maximum number of results to return.

Responses

Name	Type	Description
200 OK	DatabricksCatalogs	Request completed successfully.
Other Status Codes	ErrorResponse	Common error codes: OperationNotSupportedForItem - Operation not supported for requested item. CorruptedPayload - The provided payload is corrupted.

Examples

List Databricks catalogs example

Sample request

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/azuredatabricks/catalogs?databricksWorkspaceConnectionId=c1128f28-d84f-417c-8234-0feb91e35f86

Sample response

Status code:

200

{
  "value": [
    {
      "name": "catalog_1",
      "catalogType": "MANAGED_CATALOG",
      "storageLocation": "abfss://default@externalaccount.dfs.core.windows.net/__unitystorage/catalogs/230217cd-94f2-4017-907d-768298b02e2b",
      "fullName": "catalog_1"
    },
    {
      "name": "catalog_2",
      "catalogType": "MANAGED_CATALOG",
      "storageLocation": "abfss://default@externalaccount.dfs.core.windows.net/__unitystorage/catalogs/230217cd-94f2-4017-907d-768298b02e2b",
      "fullName": "catalog_2"
    }
  ],
  "continuationToken": null,
  "continuationUri": null
}

Definitions

Name	Description
CatalogType	The type of the catalog. Additional CatalogType types may be added over time.
DatabricksCatalog	A catalog from Unity Catalog
DatabricksCatalogs	A list of catalogs from Unity Catalog.
ErrorRelatedResource	The error related resource details object.
ErrorResponse	The error response.
ErrorResponseDetails	The error response details.

CatalogType

Enumeration

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

Value	Description
MANAGED_CATALOG	Managed Catalog

DatabricksCatalog

Object

A catalog from Unity Catalog

Name	Type	Description
catalogType	CatalogType	The type of the catalog.
fullName	string	The full name of the catalog. This variable depends on name.
name	string	The name of the catalog.
storageLocation	string	The storage location of the catalog.

DatabricksCatalogs

Object

A list of catalogs from Unity Catalog.

Name	Type	Description
Error	ErrorResponse	Error is set if unable to fetch catalogs
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	DatabricksCatalog[]	A list of Catalogs.

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.