Items - Update Mirrored Azure Databricks Catalog

Služba:: MirroredAzureDatabricksCatalog

Verze rozhraní API:: v1

Poznámka:

Toto rozhraní API je ve verzi Preview.

Aktualizuje vlastnosti zadané zrcadlenéAzureDatabricksCatalog.

Povolení

Volající musí mít oprávnění ke čtení a zápisu pro zrcadlený katalog Azure Databricks.

Požadované delegovaná rozsahy

MirroredAzureDatabricksCatalog.ReadWrite.All nebo Item.ReadWrite.All

Podporované identity v Microsoft Entra

Toto rozhraní API podporuje identity Microsoft uvedené v této části.

Identita	Podpora
Uživatel	Ano
Hlavní služba a Spravované identity	Ne

Rozhraní

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
mirroredAzureDatabricksCatalogId	path	True	string (uuid)	Zrcadlené IDAzureDatabricksCatalog.
workspaceId	path	True	string (uuid)	Identifikátor pracovního prostoru.

Text požadavku

Name	Typ	Description
description	string	Popis MirroredAzureDatabricksCatalog. Maximální délka je 256 znaků.
displayName	string	Zobrazovaný název MirroredAzureDatabricksCatalog. Zobrazovaný název musí odpovídat pravidlům pojmenování podle typu položky.
publicUpdateableExtendedProperties	MirroredAzureDatabricksCatalogUpdatePayload	Datová část aktualizovatelných vlastností MirroredAzureDatabricksCatalog

Odpovědi

Name	Typ	Description
200 OK	MirroredAzureDatabricksCatalog	Žádost byla úspěšně dokončena.
Other Status Codes	ErrorResponse	Běžné kódy chyb: ItemNotFound – Požadovaná položka nebyla nalezena. InvalidRequest – Neplatný požadavek na aktualizaci

Name

Typ

Description

200 OK

MirroredAzureDatabricksCatalog

Žádost byla úspěšně dokončena.

Other Status Codes

ErrorResponse

Běžné kódy chyb:

ItemNotFound – Požadovaná položka nebyla nalezena.
InvalidRequest – Neplatný požadavek na aktualizaci

Příklady

Update a mirroredAzureDatabricksCatalog example

Update a mirroredAzureDatabricksCatalog with updateable prperties example

Update a mirroredAzureDatabricksCatalog example

Ukázkový požadavek

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."
}

Ukázková odpověď

Stavový kód:: 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

Ukázkový požadavek

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"
  }
}

Ukázková odpověď

Stavový kód:: 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"
  }
}

Definice

Name	Description
AutoSync	Povolte nebo zakažte automatickou synchronizaci katalogu. Když je tato možnost povolená, všechny změny metadat, včetně schémat a tabulek, se automaticky synchronizují každých 15 minut. Pokud je tato možnost zakázaná, uživatelé musí metadata aktualizovat ručně. Toto nastavení lze změnit pouze během žádosti o aktualizaci. V průběhu času je možné přidat další typy `autoSync`.
ErrorInfo	Informace o chybě.
ErrorRelatedResource	Chyba související s objektem podrobností o prostředku.
ErrorResponse	Odpověď na chybu.
ErrorResponseDetails	Podrobnosti o odpovědi na chybu.
ItemTag	Představuje značku použitou u položky.
ItemType	Typ položky. V průběhu času je možné přidat další typy položek.
MirroredAzureDatabricksCatalog	Položka MirroredAzureDatabricksCatalog.
MirroredAzureDatabricksCatalogProperties	MirroredAzureDatabricksCatalog – vlastnosti.
MirroredAzureDatabricksCatalogUpdatePayload	Datová část aktualizace položky MirroredAzureDatabricksCatalog
MirroringModes	Režim zrcadlení V průběhu času je možné přidat další zrcadleníMode.
MirrorStatus	Stav zrcadlení V průběhu času se může přidat další stav.
SqlEndpointProperties	Objekt obsahující vlastnosti koncového bodu SQL.
Status	Stav synchronizace. V průběhu času se může přidat další stav.
SyncDetails	Stav zrcadlení MirroredAzureDatabricksCatalog
UpdateMirroredAzureDatabricksCatalogRequest	Aktualizace požadavku MirroredAzureDatabricksCatalog

AutoSync

Výčet

Povolte nebo zakažte automatickou synchronizaci katalogu. Když je tato možnost povolená, všechny změny metadat, včetně schémat a tabulek, se automaticky synchronizují každých 15 minut. Pokud je tato možnost zakázaná, uživatelé musí metadata aktualizovat ručně. Toto nastavení lze změnit pouze během žádosti o aktualizaci. V průběhu času je možné přidat další typy autoSync.

Hodnota	Description
Disabled	Automatická synchronizace je zakázaná.
Enabled	Je povolená automatická synchronizace.

ErrorInfo

Objekt

Informace o chybě.

Name	Typ	Description
errorCode	string	Kód chyby.
errorDetails	string	Podrobnosti o chybě.
errorMessage	string	Chybová zpráva.

ErrorRelatedResource

Objekt

Chyba související s objektem podrobností o prostředku.

Name	Typ	Description
resourceId	string	ID prostředku, které je součástí chyby.
resourceType	string	Typ prostředku, který je součástí chyby.

ErrorResponse

Objekt

Odpověď na chybu.

Name	Typ	Description
errorCode	string	Konkrétní identifikátor, který poskytuje informace o chybovém stavu, což umožňuje standardizovanou komunikaci mezi naší službou a jejími uživateli.
message	string	Lidské čitelné vyjádření chyby.
moreDetails	ErrorResponseDetails[]	Seznam dalších podrobností o chybě
relatedResource	ErrorRelatedResource	Podrobnosti o prostředku souvisejícím s chybou
requestId	string	ID požadavku přidruženého k chybě.

ErrorResponseDetails

Objekt

Podrobnosti o odpovědi na chybu.

Name	Typ	Description
errorCode	string	Konkrétní identifikátor, který poskytuje informace o chybovém stavu, což umožňuje standardizovanou komunikaci mezi naší službou a jejími uživateli.
message	string	Lidské čitelné vyjádření chyby.
relatedResource	ErrorRelatedResource	Podrobnosti o prostředku souvisejícím s chybou

ItemTag

Objekt

Představuje značku použitou u položky.

Name	Typ	Description
displayName	string	Název značky.
id	string (uuid)	ID značky.

ItemType

Výčet

Typ položky. V průběhu času je možné přidat další typy položek.

Hodnota	Description
ApacheAirflowJob	An ApacheAirflowJob.
CopyJob	Úloha kopírování.
Dashboard	Řídicí panel PowerBI
DataPipeline	Datový kanál.
Dataflow	Tok dat.
Datamart	Datový diagram PowerBI
DigitalTwinBuilder	A DigitalTwinBuilder.
DigitalTwinBuilderFlow	Tok digitálního dvojčete.
Environment	Prostředí.
Eventhouse	Eventhouse.
Eventstream	Eventstream.
GraphQLApi	Rozhraní API pro položku GraphQL
KQLDashboard	Řídicí panel KQL.
KQLDatabase	Databáze KQL.
KQLQueryset	Sada dotazů KQL.
Lakehouse	Jezero.
MLExperiment	Experiment strojového učení.
MLModel	Model strojového učení.
MirroredAzureDatabricksCatalog	Zrcadlený katalog Azure Databricks.
MirroredDatabase	Zrcadlené databáze.
MirroredWarehouse	Zrcadlený sklad.
MountedDataFactory	A MountedDataFactory.
Notebook	Poznámkový blok.
PaginatedReport	Stránkovaná sestava PowerBI
Reflex	A Reflex.
Report	Sestava PowerBI
SQLDatabase	Databáze SQLDatabase.
SQLEndpoint	Koncový bod SQL.
SemanticModel	Sémantický model PowerBI
SparkJobDefinition	Definice úlohy Sparku.
VariableLibrary	ProměnnáLibrary.
Warehouse	Sklad.
WarehouseSnapshot	Snímek skladu.

MirroredAzureDatabricksCatalog

Objekt

Položka MirroredAzureDatabricksCatalog.

Name	Typ	Description
description	string	Popis položky.
displayName	string	Zobrazovaný název položky.
folderId	string (uuid)	ID složky.
id	string (uuid)	ID položky.
properties	MirroredAzureDatabricksCatalogProperties	MirroredAzureDatabricksCatalog – vlastnosti.
tags	ItemTag[]	Seznam použitých značek
type	ItemType	Typ položky.
workspaceId	string (uuid)	Identifikátor pracovního prostoru.

MirroredAzureDatabricksCatalogProperties

Objekt

MirroredAzureDatabricksCatalog – vlastnosti.

Name	Typ	Description
autoSync	AutoSync	Automaticky synchronizujte katalog. V průběhu času je možné přidat další typy `autoSync`.
catalogName	string	Název katalogu Azure Databricks
databricksWorkspaceConnectionId	string (uuid)	ID připojení pracovního prostoru Azure Databricks
mirrorStatus	MirrorStatus	Stav synchronizace MirroredAzureDatabricksCatalog.
mirroringMode	MirroringModes	Režim zrcadlení V průběhu času je možné přidat další zrcadleníMode.
oneLakeTablesPath	string	Cesta OneLake k adresáři tabulek MirroredAzureDatabricksCatalog.
sqlEndpointProperties	SqlEndpointProperties	Objekt obsahující vlastnosti koncového bodu SQL.
storageConnectionId	string (uuid)	ID připojení k úložišti.
syncDetails	SyncDetails	Stav synchronizace MirroredAzureDatabricksCatalog.

MirroredAzureDatabricksCatalogUpdatePayload

Objekt

Datová část aktualizace položky MirroredAzureDatabricksCatalog

Name	Typ	Description
autoSync	AutoSync	Automaticky synchronizujte katalog.
mirroringMode	MirroringModes	Režim zrcadlení
storageConnectionId	string (uuid)	ID připojení k úložišti.

MirroringModes

Výčet

Režim zrcadlení V průběhu času je možné přidat další zrcadleníMode.

Hodnota	Description
Full	Zrcadlit všechno uvnitř katalogu s výjimkou výslovně vyloučených schémat a tabulek. Pokud není k dispozici žádné vyloučení, vše se ve výchozím nastavení synchronizuje.
Partial	Zrcadlí se pouze vybraná schémata a tabulky. Ve výchozím nastavení se nic nesynchronizuje.

MirrorStatus

Výčet

Stav zrcadlení V průběhu času se může přidat další stav.

Hodnota	Description
Mirrored	Označuje, že celý katalog byl úspěšně zrcadlený a zajišťuje, aby všechna schémata a tabulky ze zdroje byly plně synchronizovány s položkou MirroredAzureDatabricksCatalog.
NotMirrored	Označuje, že katalog ještě nebyl zrcadlený. Žádná schémata ani tabulky se ve výchozím nastavení nesynchronují, pokud nejsou explicitně nakonfigurované.

SqlEndpointProperties

Objekt

Objekt obsahující vlastnosti koncového bodu SQL.

Name	Typ	Description
connectionString	string	Připojovací řetězec koncového bodu SQL
id	string	ID koncového bodu SQL

Status

Výčet

Stav synchronizace. V průběhu času se může přidat další stav.

Hodnota	Description
Failed	Proces zrcadlení se nezdařil.
InProgress	Proces zrcadlení právě probíhá.
NotStarted	Zrcadlení katalogu ještě není spuštěno.
Success	Katalog byl úspěšně zrcadlený.

SyncDetails

Objekt

Stav zrcadlení MirroredAzureDatabricksCatalog

Name	Typ	Description
errorInfo	ErrorInfo	Informace o chybě.
lastSyncDateTime	string (date-time)	Datum poslední synchronizace ve formátu UTC pomocí formátu RRRR-MM-DDTHH:mm:ssZ.
status	Status	Stav synchronizace. V průběhu času se může přidat další stav.

UpdateMirroredAzureDatabricksCatalogRequest

Objekt

Aktualizace požadavku MirroredAzureDatabricksCatalog

Name	Typ	Description
description	string	Popis MirroredAzureDatabricksCatalog. Maximální délka je 256 znaků.
displayName	string	Zobrazovaný název MirroredAzureDatabricksCatalog. Zobrazovaný název musí odpovídat pravidlům pojmenování podle typu položky.
publicUpdateableExtendedProperties	MirroredAzureDatabricksCatalogUpdatePayload	Datová část aktualizovatelných vlastností MirroredAzureDatabricksCatalog

Sdílet prostřednictvím

Items - Update Mirrored Azure Databricks Catalog

Povolení

Požadované delegovaná rozsahy

Podporované identity v Microsoft Entra

Rozhraní

Parametry identifikátoru URI

Text požadavku

Odpovědi

Příklady

Update a mirroredAzureDatabricksCatalog example

Ukázkový požadavek

Ukázková odpověď

Update a mirroredAzureDatabricksCatalog with updateable prperties example

Ukázkový požadavek

Ukázková odpověď

Definice

AutoSync

ErrorInfo

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemTag

ItemType

MirroredAzureDatabricksCatalog

MirroredAzureDatabricksCatalogProperties

MirroredAzureDatabricksCatalogUpdatePayload

MirroringModes

MirrorStatus

SqlEndpointProperties

Status

SyncDetails

UpdateMirroredAzureDatabricksCatalogRequest