Items - Create Mirrored Azure Databricks Catalog

Služba:: MirroredAzureDatabricksCatalog

Verze rozhraní API:: v1

Poznámka:

Toto rozhraní API je ve verzi Preview.

Vytvoří zrcadlený SouborAzureDatabricksCatalog v zadaném pracovním prostoru.
Toto rozhraní API podporuje dlouhotrvajících operací (LRO).

Povolení

Volající musí mít roli pracovního prostoru přispěvatele .

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í

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

Parametry identifikátoru URI

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

Text požadavku

Name	Vyžadováno	Typ	Description
displayName	True	string	Zobrazovaný název MirroredAzureDatabricksCatalog. Zobrazovaný název musí odpovídat pravidlům pojmenování podle typu položky.
creationPayload		MirroredAzureDatabricksCatalogCreationPayload	Datová část vytvoření MirroredAzureDatabricksCatalog
definition		MirroredAzureDatabricksCatalogPublicDefinition	Veřejná definice MirroredAzureDatabricksCatalog. Použijte `definition` nebo `creationPayload`. Nemůžete použít oba současně.
description		string	Popis MirroredAzureDatabricksCatalog. Maximální délka je 256 znaků.

Odpovědi

Name	Typ	Description
201 Created	MirroredAzureDatabricksCatalog	Úspěšně vytvořeno
202 Accepted		Žádost byla přijata, zrcadlené zřizováníAzureDatabricksCatalog probíhá. Hlavičky Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Běžné kódy chyb: InvalidItemType – Typ položky je neplatný. ItemDisplayNameAlreadyInUse – Zobrazovaný název položky je již použit. Poškozená částPayload – zadanou datovou část je poškozena.

Name

Typ

Description

201 Created

MirroredAzureDatabricksCatalog

Úspěšně vytvořeno

202 Accepted

Žádost byla přijata, zrcadlené zřizováníAzureDatabricksCatalog probíhá.

Hlavičky

Location: string
x-ms-operation-id: string
Retry-After: integer

Other Status Codes

ErrorResponse

Běžné kódy chyb:

InvalidItemType – Typ položky je neplatný.
ItemDisplayNameAlreadyInUse – Zobrazovaný název položky je již použit.
Poškozená částPayload – zadanou datovou část je poškozena.

Příklady

Create a mirroredAzureDatabricksCatalog with creation payload example

Create an mirroredAzureDatabricksCatalog with definition example

Create a mirroredAzureDatabricksCatalog with creation payload example

Ukázkový požadavek

HTTP

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

{
  "displayName": "MirroredAzureDatabricksCatalog_created_with_creationPayload",
  "description": "A MirroredAzureDatabricksCatalog created with creation payload.",
  "creationPayload": {
    "catalogName": "catalog_1",
    "databricksWorkspaceConnectionId": "c1128f28-d84f-417c-8234-0feb91e35f86",
    "mirroringMode": "Full",
    "storageConnectionId": "c1128f28-d84f-417c-8234-0feb91e35f87"
  }
}

Ukázková odpověď

Stavový kód:: 201

{
  "displayName": "MirroredAzureDatabricksCatalog_created_with_creationPayload",
  "description": "A MirroredAzureDatabricksCatalog created with creation payload.",
  "type": "MirroredAzureDatabricksCatalog",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

Stavový kód:: 202

Location: https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
Retry-After: 30

Create an mirroredAzureDatabricksCatalog with definition example

Ukázkový požadavek

HTTP

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

{
  "displayName": "MirroredAzureDatabricksCatalog_created_with_definition",
  "description": "A MirroredAzureDatabricksCatalog created with definition.",
  "definition": {
    "parts": [
      {
        "path": "mirroredAzureDatabricksCatalog.json",
        "payload": "eyAicHJvcGVydGllcy..WJsZSIgfSB9IH0gXSB9IH0",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Ukázková odpověď

Stavový kód:: 201

{
  "displayName": "MirroredAzureDatabricksCatalog_created_with_definition",
  "description": "A MirroredAzureDatabricksCatalog created with definition.",
  "type": "MirroredAzureDatabricksCatalog",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

Stavový kód:: 202

Location: https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
Retry-After: 30

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`.
CreateMirroredAzureDatabricksCatalogRequest	Vytvoření datové části požadavku MirroredAzureDatabricksCatalog
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.
MirroredAzureDatabricksCatalogCreationPayload	ZrcadleníAzureDatabricksCatalog vytvoření datové části položky
MirroredAzureDatabricksCatalogProperties	MirroredAzureDatabricksCatalog – vlastnosti.
MirroredAzureDatabricksCatalogPublicDefinition	MirroredAzureDatabricksCatalog public definition object. Další podrobnosti o vytvoření veřejné definice definice MirroredAzureDatabricksCatalog najdete v tomto článku .
MirroredAzureDatabricksCatalogPublicDefinitionPart	MirroredAzureDatabricksCatalog definition part object.
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.
PayloadType	Typ datové části definice. V průběhu času je možné přidat další typy datových částí.
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

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.

CreateMirroredAzureDatabricksCatalogRequest

Objekt

Vytvoření datové části požadavku MirroredAzureDatabricksCatalog

Name	Typ	Description
creationPayload	MirroredAzureDatabricksCatalogCreationPayload	Datová část vytvoření MirroredAzureDatabricksCatalog
definition	MirroredAzureDatabricksCatalogPublicDefinition	Veřejná definice MirroredAzureDatabricksCatalog. Použijte `definition` nebo `creationPayload`. Nemůžete použít oba současně.
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.

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.

MirroredAzureDatabricksCatalogCreationPayload

Objekt

ZrcadleníAzureDatabricksCatalog vytvoření datové části položky

Name	Typ	Description
catalogName	string	Název katalogu Azure Databricks
databricksWorkspaceConnectionId	string (uuid)	ID připojení pracovního prostoru Azure Databricks
mirroringMode	MirroringModes	Režim zrcadlení
storageConnectionId	string (uuid)	ID připojení k úložišti.

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.

MirroredAzureDatabricksCatalogPublicDefinition

Objekt

MirroredAzureDatabricksCatalog public definition object. Další podrobnosti o vytvoření veřejné definice definice MirroredAzureDatabricksCatalog najdete v tomto článku .

Name	Typ	Description
format	string	Formát definice položky.
parts	MirroredAzureDatabricksCatalogPublicDefinitionPart[]	Seznam částí definice.

MirroredAzureDatabricksCatalogPublicDefinitionPart

Objekt

MirroredAzureDatabricksCatalog definition part object.

Name	Typ	Description
path	string	Cesta části MirroredAzureDatabricksCatalog.
payload	string	Datová část části MirroredAzureDatabricksCatalog.
payloadType	PayloadType	Typ datové části.

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é.

PayloadType

Výčet

Typ datové části definice. V průběhu času je možné přidat další typy datových částí.

Hodnota	Description
InlineBase64	Vložená základna 64.

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.

Sdílet prostřednictvím

Items - Create 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

Create a mirroredAzureDatabricksCatalog with creation payload example

Ukázkový požadavek

Ukázková odpověď

Create an mirroredAzureDatabricksCatalog with definition example

Ukázkový požadavek

Ukázková odpověď

Definice

AutoSync

CreateMirroredAzureDatabricksCatalogRequest

ErrorInfo

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemTag

ItemType

MirroredAzureDatabricksCatalog

MirroredAzureDatabricksCatalogCreationPayload

MirroredAzureDatabricksCatalogProperties

MirroredAzureDatabricksCatalogPublicDefinition

MirroredAzureDatabricksCatalogPublicDefinitionPart

MirroringModes

MirrorStatus

PayloadType

SqlEndpointProperties

Status

SyncDetails