Items - Create Mirrored Azure Databricks Catalog

Serviço:: MirroredAzureDatabricksCatalog

Versão da API:: v1

Observação

Esta API está na versão prévia.

Cria um mirroredAzureDatabricksCatalog no workspace especificado.
Essa API dá suporte a LRO (operações de execução longa).

Permissões

O chamador deve ter uma função de workspace de colaborador .

Escopos delegados necessários

MirroredAzureDatabricksCatalog.ReadWrite.All ou Item.ReadWrite.All

Identidades com suporte do Microsoft Entra

Esta API dá suporte às identidades do Microsoft listadas nesta seção.

Identidade	Apoio
Utilizador	Sim
Entidade de serviço e identidades gerenciadas	Não

Interfase

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
workspaceId	path	True	string (uuid)	O identificador do espaço de trabalho.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
displayName	True	string	O nome de exibição MirroredAzureDatabricksCatalog. O nome de exibição deve seguir regras de nomenclatura de acordo com o tipo de item.
creationPayload		MirroredAzureDatabricksCatalogCreationPayload	O conteúdo de criação mirroredAzureDatabricksCatalog.
definition		MirroredAzureDatabricksCatalogPublicDefinition	A definição pública MirroredAzureDatabricksCatalog. Use `definition` ou `creationPayload`. Você não pode usar ambos ao mesmo tempo.
description		string	A descrição mirroredAzureDatabricksCatalog. O comprimento máximo é de 256 caracteres.

Respostas

Nome	Tipo	Description
201 Created	MirroredAzureDatabricksCatalog	Criado com êxito
202 Accepted		Solicitação aceita, espelhado Provisionamento deAzureDatabricksCatalog em andamento. Cabeçalhos Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Códigos de erro comuns: InvalidItemType – O tipo de item é inválido ItemDisplayNameAlreadyInUse – O nome de exibição do item já está sendo usado. CorruptedPayload – O conteúdo fornecido está corrompido.

Nome

Tipo

Description

201 Created

MirroredAzureDatabricksCatalog

Criado com êxito

202 Accepted

Solicitação aceita, espelhado Provisionamento deAzureDatabricksCatalog em andamento.

Cabeçalhos

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

Other Status Codes

ErrorResponse

Códigos de erro comuns:

InvalidItemType – O tipo de item é inválido
ItemDisplayNameAlreadyInUse – O nome de exibição do item já está sendo usado.
CorruptedPayload – O conteúdo fornecido está corrompido.

Exemplos

Create a mirroredAzureDatabricksCatalog with creation payload example

Create an mirroredAzureDatabricksCatalog with definition example

Create a mirroredAzureDatabricksCatalog with creation payload example

Solicitação de exemplo

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

Resposta de exemplo

Código de status:: 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"
}

Código de status:: 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

Solicitação de exemplo

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

Resposta de exemplo

Código de status:: 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"
}

Código de status:: 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

Definições

Nome	Description
AutoSync	Habilite ou desabilite a sincronização automática para o catálogo. Quando habilitados, todas as alterações de metadados, incluindo esquemas e tabelas, são sincronizadas automaticamente a cada 15 minutos. Quando desabilitados, os usuários devem atualizar manualmente os metadados. Essa configuração só pode ser modificada durante uma solicitação de atualização. Tipos de `autoSync` adicionais podem ser adicionados ao longo do tempo.
CreateMirroredAzureDatabricksCatalogRequest	Crie o conteúdo da solicitação MirroredAzureDatabricksCatalog.
ErrorInfo	As informações sobre o erro.
ErrorRelatedResource	O objeto de detalhes do recurso relacionado ao erro.
ErrorResponse	A resposta de erro.
ErrorResponseDetails	Os detalhes da resposta de erro.
ItemTag	Representa uma marca aplicada em um item.
ItemType	O tipo do item. Tipos de item adicionais podem ser adicionados ao longo do tempo.
MirroredAzureDatabricksCatalog	Um item MirroredAzureDatabricksCatalog.
MirroredAzureDatabricksCatalogCreationPayload	MirroredAzureDatabricksCatalog create item payload.
MirroredAzureDatabricksCatalogProperties	As propriedades MirroredAzureDatabricksCatalog.
MirroredAzureDatabricksCatalogPublicDefinition	Objeto de definição pública MirroredAzureDatabricksCatalog. Consulte este artigo para obter mais detalhes sobre como criar uma definição pública de definição MirroredAzureDatabricksCatalog.
MirroredAzureDatabricksCatalogPublicDefinitionPart	Objeto de parte de definição MirroredAzureDatabricksCatalog.
MirroringModes	Modo para espelhamento. MirroringMode adicional pode ser adicionado ao longo do tempo.
MirrorStatus	Status do espelhamento. Status adicional pode ser adicionado ao longo do tempo.
PayloadType	O tipo da carga da parte de definição. Tipos de conteúdo adicionais podem ser adicionados ao longo do tempo.
SqlEndpointProperties	Um objeto que contém as propriedades do ponto de extremidade SQL.
Status	O status da sincronização. Status adicional pode ser adicionado ao longo do tempo.
SyncDetails	O status de espelhamento MirroredAzureDatabricksCatalog.

AutoSync

Enumeração

Habilite ou desabilite a sincronização automática para o catálogo. Quando habilitados, todas as alterações de metadados, incluindo esquemas e tabelas, são sincronizadas automaticamente a cada 15 minutos. Quando desabilitados, os usuários devem atualizar manualmente os metadados. Essa configuração só pode ser modificada durante uma solicitação de atualização. Tipos de autoSync adicionais podem ser adicionados ao longo do tempo.

Valor	Description
Disabled	A sincronização automática está desabilitada.
Enabled	A sincronização automática está habilitada.

CreateMirroredAzureDatabricksCatalogRequest

Objeto

Crie o conteúdo da solicitação MirroredAzureDatabricksCatalog.

Nome	Tipo	Description
creationPayload	MirroredAzureDatabricksCatalogCreationPayload	O conteúdo de criação mirroredAzureDatabricksCatalog.
definition	MirroredAzureDatabricksCatalogPublicDefinition	A definição pública MirroredAzureDatabricksCatalog. Use `definition` ou `creationPayload`. Você não pode usar ambos ao mesmo tempo.
description	string	A descrição mirroredAzureDatabricksCatalog. O comprimento máximo é de 256 caracteres.
displayName	string	O nome de exibição MirroredAzureDatabricksCatalog. O nome de exibição deve seguir regras de nomenclatura de acordo com o tipo de item.

ErrorInfo

Objeto

As informações sobre o erro.

Nome	Tipo	Description
errorCode	string	O código de erro.
errorDetails	string	Os detalhes do erro.
errorMessage	string	A mensagem de erro.

ErrorRelatedResource

Objeto

O objeto de detalhes do recurso relacionado ao erro.

Nome	Tipo	Description
resourceId	string	A ID do recurso envolvida no erro.
resourceType	string	O tipo do recurso envolvido no erro.

ErrorResponse

Objeto

A resposta de erro.

Nome	Tipo	Description
errorCode	string	Um identificador específico que fornece informações sobre uma condição de erro, permitindo a comunicação padronizada entre nosso serviço e seus usuários.
message	string	Uma representação legível humana do erro.
moreDetails	ErrorResponseDetails[]	Lista de detalhes de erro adicionais.
relatedResource	ErrorRelatedResource	Os detalhes do recurso relacionado ao erro.
requestId	string	ID da solicitação associada ao erro.

ErrorResponseDetails

Objeto

Os detalhes da resposta de erro.

Nome	Tipo	Description
errorCode	string	Um identificador específico que fornece informações sobre uma condição de erro, permitindo a comunicação padronizada entre nosso serviço e seus usuários.
message	string	Uma representação legível humana do erro.
relatedResource	ErrorRelatedResource	Os detalhes do recurso relacionado ao erro.

ItemTag

Objeto

Representa uma marca aplicada em um item.

Nome	Tipo	Description
displayName	string	O nome da marca.
id	string (uuid)	A ID da marca.

ItemType

Enumeração

O tipo do item. Tipos de item adicionais podem ser adicionados ao longo do tempo.

Valor	Description
ApacheAirflowJob	Um ApacheAirflowJob.
CopyJob	Um trabalho de cópia.
Dashboard	Painel do PowerBI.
DataPipeline	Um pipeline de dados.
Dataflow	Um fluxo de dados.
Datamart	Datamart do PowerBI.
DigitalTwinBuilder	Um DigitalTwinBuilder.
DigitalTwinBuilderFlow	Um fluxo do Construtor de Gêmeos Digitais.
Environment	Um ambiente.
Eventhouse	Uma casa de eventos.
Eventstream	Um fluxo de eventos.
GraphQLApi	Um item de API para GraphQL.
KQLDashboard	Um painel KQL.
KQLDatabase	Um banco de dados KQL.
KQLQueryset	Um conjunto de consultas KQL.
Lakehouse	Uma casa no lago.
MLExperiment	Um experimento de aprendizado de máquina.
MLModel	Um modelo de machine learning.
MirroredAzureDatabricksCatalog	Um catálogo espelhado do Azure Databricks.
MirroredDatabase	Um banco de dados espelhado.
MirroredWarehouse	Um armazém espelhado.
MountedDataFactory	Um MountedDataFactory.
Notebook	Um notebook.
PaginatedReport	Relatório paginado do PowerBI.
Reflex	Um Reflexo.
Report	Relatório do PowerBI.
SQLDatabase	Um SQLDatabase.
SQLEndpoint	Um ponto de extremidade SQL.
SemanticModel	Modelo semântico do PowerBI.
SparkJobDefinition	Uma definição de trabalho do Spark.
VariableLibrary	Um VariableLibrary.
Warehouse	Um armazém.
WarehouseSnapshot	Um instantâneo do Warehouse.

MirroredAzureDatabricksCatalog

Objeto

Um item MirroredAzureDatabricksCatalog.

Nome	Tipo	Description
description	string	A descrição do item.
displayName	string	O nome de exibição do item.
folderId	string (uuid)	A ID da pasta.
id	string (uuid)	A ID do item.
properties	MirroredAzureDatabricksCatalogProperties	As propriedades MirroredAzureDatabricksCatalog.
tags	ItemTag[]	Lista de marcas aplicadas.
type	ItemType	O tipo de item.
workspaceId	string (uuid)	O identificador do espaço de trabalho.

MirroredAzureDatabricksCatalogCreationPayload

Objeto

MirroredAzureDatabricksCatalog create item payload.

Nome	Tipo	Description
catalogName	string	Nome do catálogo do Azure Databricks.
databricksWorkspaceConnectionId	string (uuid)	A ID de conexão do workspace do Azure Databricks.
mirroringMode	MirroringModes	Modo de espelhamento.
storageConnectionId	string (uuid)	A ID da conexão de armazenamento.

MirroredAzureDatabricksCatalogProperties

Objeto

As propriedades MirroredAzureDatabricksCatalog.

Nome	Tipo	Description
autoSync	AutoSync	Sincronizar automaticamente o catálogo. Tipos de `autoSync` adicionais podem ser adicionados ao longo do tempo.
catalogName	string	Nome do catálogo do Azure Databricks.
databricksWorkspaceConnectionId	string (uuid)	A ID de conexão do workspace do Azure Databricks.
mirrorStatus	MirrorStatus	O status de sincronização MirroredAzureDatabricksCatalog.
mirroringMode	MirroringModes	Modo de espelhamento. MirroringMode adicional pode ser adicionado ao longo do tempo.
oneLakeTablesPath	string	Caminho do OneLake para o diretório de tabelas MirroredAzureDatabricksCatalog.
sqlEndpointProperties	SqlEndpointProperties	Um objeto que contém as propriedades do ponto de extremidade SQL.
storageConnectionId	string (uuid)	A ID da conexão de armazenamento.
syncDetails	SyncDetails	O status de sincronização MirroredAzureDatabricksCatalog.

MirroredAzureDatabricksCatalogPublicDefinition

Objeto

Objeto de definição pública MirroredAzureDatabricksCatalog. Consulte este artigo para obter mais detalhes sobre como criar uma definição pública de definição MirroredAzureDatabricksCatalog.

Nome	Tipo	Description
format	string	O formato da definição do item.
parts	MirroredAzureDatabricksCatalogPublicDefinitionPart[]	Uma lista de partes de definição.

MirroredAzureDatabricksCatalogPublicDefinitionPart

Objeto

Objeto de parte de definição MirroredAzureDatabricksCatalog.

Nome	Tipo	Description
path	string	O caminho da parte MirroredAzureDatabricksCatalog.
payload	string	O conteúdo da parte MirroredAzureDatabricksCatalog.
payloadType	PayloadType	O tipo de conteúdo.

MirroringModes

Enumeração

Modo para espelhamento. MirroringMode adicional pode ser adicionado ao longo do tempo.

Valor	Description
Full	Espelhar tudo dentro de um catálogo, exceto esquemas e tabelas especificamente excluídos. Tudo será sincronizado por padrão se nenhuma exclusão for fornecida.
Partial	Somente esquemas e tabelas selecionados são espelhados. Nada é sincronizado por padrão.

MirrorStatus

Enumeração

Status do espelhamento. Status adicional pode ser adicionado ao longo do tempo.

Valor	Description
Mirrored	Indica que todo o catálogo foi espelhado com êxito, garantindo que todos os esquemas e tabelas da origem sejam totalmente sincronizados com o item MirroredAzureDatabricksCatalog.
NotMirrored	Indica que o catálogo ainda não foi espelhado. Nenhum esquema ou tabela é sincronizado por padrão, a menos que esteja configurado explicitamente.

PayloadType

Enumeração

O tipo da carga da parte de definição. Tipos de conteúdo adicionais podem ser adicionados ao longo do tempo.

Valor	Description
InlineBase64	Base 64 embutida.

SqlEndpointProperties

Objeto

Um objeto que contém as propriedades do ponto de extremidade SQL.

Nome	Tipo	Description
connectionString	string	Cadeia de conexão do ponto de extremidade DO SQL.
id	string	ID do ponto de extremidade do SQL.

Status

Enumeração

O status da sincronização. Status adicional pode ser adicionado ao longo do tempo.

Valor	Description
Failed	O processo de espelhamento falhou.
InProgress	O processo de espelhamento está em andamento no momento.
NotStarted	O espelhamento de catálogo ainda não foi iniciado
Success	O catálogo foi espelhado com êxito.

SyncDetails

Objeto

O status de espelhamento MirroredAzureDatabricksCatalog.

Nome	Tipo	Description
errorInfo	ErrorInfo	As informações sobre o erro.
lastSyncDateTime	string (date-time)	A hora da data da última sincronização em UTC, usando o formato YYYY-MM-DDTHH:mm:ssZ.
status	Status	O status da sincronização. Status adicional pode ser adicionado ao longo do tempo.

Compartilhar via

Items - Create Mirrored Azure Databricks Catalog

Permissões

Escopos delegados necessários

Identidades com suporte do Microsoft Entra

Interfase

Parâmetros de URI

Corpo da solicitação

Respostas

Exemplos

Create a mirroredAzureDatabricksCatalog with creation payload example

Solicitação de exemplo

Resposta de exemplo

Create an mirroredAzureDatabricksCatalog with definition example

Solicitação de exemplo

Resposta de exemplo

Definições

AutoSync

CreateMirroredAzureDatabricksCatalogRequest

ErrorInfo

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemTag

ItemType

MirroredAzureDatabricksCatalog

MirroredAzureDatabricksCatalogCreationPayload

MirroredAzureDatabricksCatalogProperties

MirroredAzureDatabricksCatalogPublicDefinition

MirroredAzureDatabricksCatalogPublicDefinitionPart

MirroringModes

MirrorStatus

PayloadType

SqlEndpointProperties

Status

SyncDetails