Items - Update Mirrored Azure Databricks Catalog

Service:: MirroredAzureDatabricksCatalog

API Version:: v1

Note

This API is in preview.

Updates the properties of the specified mirroredAzureDatabricksCatalog.

Permissions

The caller must have read and write permissions for the mirrored azure databricks catalog.

Required Delegated Scopes

MirroredAzureDatabricksCatalog.ReadWrite.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	No

Interface

PATCH https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/mirroredAzureDatabricksCatalogs/{mirroredAzureDatabricksCatalogId}

URI Parameters

Name	In	Required	Type	Description
mirroredAzureDatabricksCatalogId	path	True	string (uuid)	The mirroredAzureDatabricksCatalog ID.
workspaceId	path	True	string (uuid)	The workspace ID.

Request Body

Name	Type	Description
description	string	The MirroredAzureDatabricksCatalog description. Maximum length is 256 characters.
displayName	string	The MirroredAzureDatabricksCatalog display name. The display name must follow naming rules according to item type.
publicUpdateableExtendedProperties	MirroredAzureDatabricksCatalogUpdatePayload	The MirroredAzureDatabricksCatalog updateable properties payload.

Responses

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

Name

Type

Description

200 OK

MirroredAzureDatabricksCatalog

Request completed successfully.

Other Status Codes

ErrorResponse

Common error codes:

ItemNotFound - The requested item was not found.
InvalidRequest - Invalid update request.

Examples

Update a mirroredAzureDatabricksCatalog example

Update a mirroredAzureDatabricksCatalog with updateable prperties example

Update a mirroredAzureDatabricksCatalog example

Sample request

HTTP

PATCH https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/mirroredAzureDatabricksCatalogs/5b218778-e7a5-4d73-8187-f10824047715

{
  "displayName": "MirroredAzureDatabricksCatalog_New_Name",
  "description": "A new description for mirroredAzureDatabricksCatalog."
}

Sample response

Status code:: 200

{
  "displayName": "MirroredAzureDatabricksCatalog_New_Name",
  "description": "A new description for mirroredAzureDatabricksCatalog.",
  "type": "MirroredAzureDatabricksCatalog",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715",
  "properties": {
    "catalogName": "catalog_1",
    "databricksWorkspaceConnectionId": "0c9e2ee0-f451-40f3-8355-9bb6d133237d",
    "mirroringMode": "Partial",
    "oneLakeTablesPath": "https://onelake.dfs.fabric.microsoft.com/2382cdf5-d577-44d0-a1fc-42184f29a7eb/e5fb215b-1934-413e-b33a-debaf844afde/Tables",
    "sqlEndpointProperties": {
      "connectionString": "qvrmbuxie7we7glrekxgy6npqu-6xgyei3x2xiejip4iime6knh5m.datawarehouse.fabric.microsoft.com",
      "id": "37dc8a41-dea9-465d-b528-3e95043b2356"
    },
    "syncDetails": {
      "status": "Success",
      "lastSyncDateTime": "2024-12-26T09:40:38.8583698Z",
      "errorInfo": null
    },
    "mirrorStatus": "NotMirrored",
    "autoSync": "Disabled",
    "storageConnectionId": null
  }
}

Update a mirroredAzureDatabricksCatalog with updateable prperties example

Sample request

HTTP

PATCH https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/mirroredAzureDatabricksCatalogs/5b218778-e7a5-4d73-8187-f10824047715

{
  "displayName": "MirroredAzureDatabricksCatalog_New_Name",
  "description": "A new description for mirroredAzureDatabricksCatalog.",
  "publicUpdateableExtendedProperties": {
    "autoSync": "Enabled",
    "mirroringMode": "Full",
    "storageConnectionId": "c1128f28-d84f-417c-8234-0feb91e35f87"
  }
}

Sample response

Status code:: 200

{
  "displayName": "MirroredAzureDatabricksCatalog_New_Name",
  "description": "A new description for mirroredAzureDatabricksCatalog.",
  "type": "MirroredAzureDatabricksCatalog",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715",
  "properties": {
    "catalogName": "catalog_1",
    "databricksWorkspaceConnectionId": "0c9e2ee0-f451-40f3-8355-9bb6d133237d",
    "mirroringMode": "Full",
    "oneLakeTablesPath": "https://onelake.dfs.fabric.microsoft.com/2382cdf5-d577-44d0-a1fc-42184f29a7eb/e5fb215b-1934-413e-b33a-debaf844afde/Tables",
    "sqlEndpointProperties": {
      "connectionString": "qvrmbuxie7we7glrekxgy6npqu-6xgyei3x2xiejip4iime6knh5m.datawarehouse.fabric.microsoft.com",
      "id": "37dc8a41-dea9-465d-b528-3e95043b2356"
    },
    "syncDetails": {
      "status": "Success",
      "lastSyncDateTime": "2024-12-26T09:40:38.8583698Z",
      "errorInfo": null
    },
    "mirrorStatus": "Mirrored",
    "autoSync": "Enabled",
    "storageConnectionId": "c1128f28-d84f-417c-8234-0feb91e35f87"
  }
}

Definitions

Name	Description
AutoSync	Enable or disable automatic synchronization for the catalog. When enabled, all metadata changes, including schemas and tables, are automatically synchronized every 15 minutes. When disabled, users must manually refresh the metadata. This setting can only be modified during an update request. Additional `autoSync` types may be added over time.
ErrorInfo	The error information.
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.
MirroredAzureDatabricksCatalog	A MirroredAzureDatabricksCatalog item.
MirroredAzureDatabricksCatalogProperties	The MirroredAzureDatabricksCatalog properties.
MirroredAzureDatabricksCatalogUpdatePayload	MirroredAzureDatabricksCatalog update item payload.
MirroringModes	Mode for mirroring. Additional mirroringMode may be added over time.
MirrorStatus	Status of mirroring. Additional status may be added over time.
SqlEndpointProperties	An object containing the properties of the SQL endpoint.
Status	The sync status. Additional status may be added over time.
SyncDetails	The MirroredAzureDatabricksCatalog mirroring status.
UpdateMirroredAzureDatabricksCatalogRequest	Update MirroredAzureDatabricksCatalog request.

AutoSync

Enumeration

Enable or disable automatic synchronization for the catalog. When enabled, all metadata changes, including schemas and tables, are automatically synchronized every 15 minutes. When disabled, users must manually refresh the metadata. This setting can only be modified during an update request. Additional autoSync types may be added over time.

Value	Description
Enabled	Automatic synchronization is enabled.
Disabled	Automatic synchronization is disabled.

ErrorInfo

Object

The error information.

Name	Type	Description
errorCode	string	The error code.
errorDetails	string	The error details.
errorMessage	string	The error message.

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.

MirroredAzureDatabricksCatalog

Object

A MirroredAzureDatabricksCatalog item.

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	MirroredAzureDatabricksCatalogProperties	The MirroredAzureDatabricksCatalog properties.
tags	ItemTag[]	List of applied tags.
type	ItemType	The item type.
workspaceId	string (uuid)	The workspace ID.

MirroredAzureDatabricksCatalogProperties

Object

The MirroredAzureDatabricksCatalog properties.

Name	Type	Description
autoSync	AutoSync	Auto sync the catalog. Additional `autoSync` types may be added over time.
catalogName	string	Azure databricks catalog name.
databricksWorkspaceConnectionId	string (uuid)	The Azure databricks workspace connection id.
mirrorStatus	MirrorStatus	The MirroredAzureDatabricksCatalog sync status.
mirroringMode	MirroringModes	Mirroring mode. Additional mirroringMode may be added over time.
oneLakeTablesPath	string	OneLake path to the MirroredAzureDatabricksCatalog tables directory.
sqlEndpointProperties	SqlEndpointProperties	An object containing the properties of the SQL endpoint.
storageConnectionId	string (uuid)	The storage connection id.
syncDetails	SyncDetails	The MirroredAzureDatabricksCatalog sync status.

MirroredAzureDatabricksCatalogUpdatePayload

Object

MirroredAzureDatabricksCatalog update item payload.

Name	Type	Description
autoSync	AutoSync	Auto sync the catalog.
mirroringMode	MirroringModes	Mirroring mode.
storageConnectionId	string (uuid)	The storage connection id.

MirroringModes

Enumeration

Mode for mirroring. Additional mirroringMode may be added over time.

Value	Description
Full	Mirror everything inside a catalog except specifically excluded schemas and tables. Everything is synced by default if no exclusion is provided.
Partial	Only selected schemas and tables are mirrored. Nothing is synced by default.

MirrorStatus

Enumeration

Status of mirroring. Additional status may be added over time.

Value	Description
Mirrored	Indicates that the entire catalog has been successfully mirrored, ensuring that all schemas and tables from the source are fully synchronized with the MirroredAzureDatabricksCatalog item.
NotMirrored	Indicates that the catalog has not been mirrored yet. No schemas or tables are synchronized by default unless explicitly configured.

SqlEndpointProperties

Object

An object containing the properties of the SQL endpoint.

Name	Type	Description
connectionString	string	SQL endpoint connection string.
id	string	SQL endpoint ID.

Status

Enumeration

The sync status. Additional status may be added over time.

Value	Description
NotStarted	The catalog mirroring is not started yet
InProgress	The mirroring process is currently in progress.
Success	The catalog has been successfully mirrored.
Failed	The mirroring process has failed.

SyncDetails

Object

The MirroredAzureDatabricksCatalog mirroring status.

Name	Type	Description
errorInfo	ErrorInfo	The error information.
lastSyncDateTime	string (date-time)	The last sync date time in UTC, using the YYYY-MM-DDTHH:mm:ssZ format.
status	Status	The sync status. Additional status may be added over time.

UpdateMirroredAzureDatabricksCatalogRequest

Object

Update MirroredAzureDatabricksCatalog request.

Name	Type	Description
description	string	The MirroredAzureDatabricksCatalog description. Maximum length is 256 characters.
displayName	string	The MirroredAzureDatabricksCatalog display name. The display name must follow naming rules according to item type.
publicUpdateableExtendedProperties	MirroredAzureDatabricksCatalogUpdatePayload	The MirroredAzureDatabricksCatalog updateable properties payload.

Share via

Items - Update Mirrored Azure Databricks Catalog

Permissions

Required Delegated Scopes

Microsoft Entra supported identities

Interface

URI Parameters

Request Body

Responses

Examples

Update a mirroredAzureDatabricksCatalog example

Sample request

Sample response

Update a mirroredAzureDatabricksCatalog with updateable prperties example

Sample request

Sample response

Definitions

AutoSync

ErrorInfo

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemTag

ItemType

MirroredAzureDatabricksCatalog

MirroredAzureDatabricksCatalogProperties

MirroredAzureDatabricksCatalogUpdatePayload

MirroringModes

MirrorStatus

SqlEndpointProperties

Status

SyncDetails

UpdateMirroredAzureDatabricksCatalogRequest