Items - Create Mirrored Azure Databricks Catalog

Servicio:: MirroredAzureDatabricksCatalog

Versión de la API:: v1

Nota:

Esta API está en versión preliminar.

Crea un objeto mirroredAzureDatabricksCatalog en el área de trabajo especificada.
Esta API admite operaciones de larga duración (LRO).

Permisos

El autor de la llamada debe tener un rol de área de trabajo colaborador .

Ámbitos delegados necesarios

MirroredAzureDatabricksCatalog.ReadWrite.All o Item.ReadWrite.All

Identidades admitidas de Microsoft Entra

Esta API admite las identidades de Microsoft enumeradas en esta sección.

identidad	Apoyo
Usuario	Sí
Entidad de servicio e Identidades administradas	No

Interfaz

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
workspaceId	path	True	string (uuid)	El identificador del área de trabajo.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
displayName	True	string	El nombre para mostrar MirroredAzureDatabricksCatalog. El nombre para mostrar debe seguir las reglas de nomenclatura según el tipo de elemento.
creationPayload		MirroredAzureDatabricksCatalogCreationPayload	Carga de creación mirroredAzureDatabricksCatalog.
definition		MirroredAzureDatabricksCatalogPublicDefinition	Definición pública MirroredAzureDatabricksCatalog. Utilice `definition` o `creationPayload`. No puede usar ambos al mismo tiempo.
description		string	Descripción de MirroredAzureDatabricksCatalog. La longitud máxima es de 256 caracteres.

Respuestas

Nombre	Tipo	Description
201 Created	MirroredAzureDatabricksCatalog	Creado correctamente
202 Accepted		Solicitud aceptada, reflejadaAzureDatabricksCatalog aprovisionamiento en curso. Encabezados Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Códigos de error comunes: InvalidItemType: el tipo de elemento no es válido ItemDisplayNameAlreadyInUse: ya se usa el nombre para mostrar del elemento. CorruptedPayload: la carga proporcionada está dañada.

Nombre

Tipo

Description

201 Created

MirroredAzureDatabricksCatalog

Creado correctamente

202 Accepted

Solicitud aceptada, reflejadaAzureDatabricksCatalog aprovisionamiento en curso.

Encabezados

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

Other Status Codes

ErrorResponse

Códigos de error comunes:

InvalidItemType: el tipo de elemento no es válido
ItemDisplayNameAlreadyInUse: ya se usa el nombre para mostrar del elemento.
CorruptedPayload: la carga proporcionada está dañada.

Ejemplos

Create a mirroredAzureDatabricksCatalog with creation payload example

Create an mirroredAzureDatabricksCatalog with definition example

Create a mirroredAzureDatabricksCatalog with creation payload example

Solicitud de ejemplo

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

Respuesta de muestra

status code:: 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"
}

status code:: 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

Solicitud de ejemplo

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

Respuesta de muestra

status code:: 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"
}

status code:: 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

Definiciones

Nombre	Description
AutoSync	Habilite o deshabilite la sincronización automática para el catálogo. Cuando se habilita, todos los cambios de metadatos, incluidos los esquemas y las tablas, se sincronizan automáticamente cada 15 minutos. Cuando está deshabilitado, los usuarios deben actualizar manualmente los metadatos. Esta configuración solo se puede modificar durante una solicitud de actualización. Se pueden agregar tipos de `autoSync` adicionales a lo largo del tiempo.
CreateMirroredAzureDatabricksCatalogRequest	Cree la carga de solicitud MirroredAzureDatabricksCatalog.
ErrorInfo	La información de error.
ErrorRelatedResource	Objeto de detalles del recurso relacionado con el error.
ErrorResponse	Respuesta de error.
ErrorResponseDetails	Detalles de la respuesta de error.
ItemTag	Representa una etiqueta aplicada en un elemento.
ItemType	Tipo del elemento. Se pueden agregar tipos de elementos adicionales a lo largo del tiempo.
MirroredAzureDatabricksCatalog	Un elemento MirroredAzureDatabricksCatalog.
MirroredAzureDatabricksCatalogCreationPayload	MirroredAzureDatabricksCatalog create item payload.
MirroredAzureDatabricksCatalogProperties	Propiedades MirroredAzureDatabricksCatalog.
MirroredAzureDatabricksCatalogPublicDefinition	Objeto de definición pública MirroredAzureDatabricksCatalog. Consulte este artículo para obtener más información sobre cómo crear una definición pública de definición de MirroredAzureDatabricksCatalog.
MirroredAzureDatabricksCatalogPublicDefinitionPart	Objeto de parte de definición MirroredAzureDatabricksCatalog.
MirroringModes	Modo para la creación de reflejo. Se puede agregar mirroringMode adicional a lo largo del tiempo.
MirrorStatus	Estado de la creación de reflejo. Se puede agregar un estado adicional a lo largo del tiempo.
PayloadType	Tipo de la carga de la parte de definición. Se pueden agregar tipos de carga adicionales a lo largo del tiempo.
SqlEndpointProperties	Objeto que contiene las propiedades del punto de conexión de SQL.
Status	Estado de sincronización. Se puede agregar un estado adicional a lo largo del tiempo.
SyncDetails	El estado de creación de reflejo MirroredAzureDatabricksCatalog.

AutoSync

Enumeración

Habilite o deshabilite la sincronización automática para el catálogo. Cuando se habilita, todos los cambios de metadatos, incluidos los esquemas y las tablas, se sincronizan automáticamente cada 15 minutos. Cuando está deshabilitado, los usuarios deben actualizar manualmente los metadatos. Esta configuración solo se puede modificar durante una solicitud de actualización. Se pueden agregar tipos de autoSync adicionales a lo largo del tiempo.

Valor	Description
Disabled	La sincronización automática está deshabilitada.
Enabled	La sincronización automática está habilitada.

CreateMirroredAzureDatabricksCatalogRequest

Object

Cree la carga de solicitud MirroredAzureDatabricksCatalog.

Nombre	Tipo	Description
creationPayload	MirroredAzureDatabricksCatalogCreationPayload	Carga de creación mirroredAzureDatabricksCatalog.
definition	MirroredAzureDatabricksCatalogPublicDefinition	Definición pública MirroredAzureDatabricksCatalog. Utilice `definition` o `creationPayload`. No puede usar ambos al mismo tiempo.
description	string	Descripción de MirroredAzureDatabricksCatalog. La longitud máxima es de 256 caracteres.
displayName	string	El nombre para mostrar MirroredAzureDatabricksCatalog. El nombre para mostrar debe seguir las reglas de nomenclatura según el tipo de elemento.

ErrorInfo

Object

La información de error.

Nombre	Tipo	Description
errorCode	string	Código de error.
errorDetails	string	Detalles del error.
errorMessage	string	El mensaje de error.

ErrorRelatedResource

Object

Objeto de detalles del recurso relacionado con el error.

Nombre	Tipo	Description
resourceId	string	Identificador de recurso implicado en el error.
resourceType	string	Tipo del recurso implicado en el error.

ErrorResponse

Object

Respuesta de error.

Nombre	Tipo	Description
errorCode	string	Identificador específico que proporciona información sobre una condición de error, lo que permite una comunicación estandarizada entre nuestro servicio y sus usuarios.
message	string	Representación legible del error.
moreDetails	ErrorResponseDetails[]	Lista de detalles de error adicionales.
relatedResource	ErrorRelatedResource	Detalles del recurso relacionado con el error.
requestId	string	Identificador de la solicitud asociada al error.

ErrorResponseDetails

Object

Detalles de la respuesta de error.

Nombre	Tipo	Description
errorCode	string	Identificador específico que proporciona información sobre una condición de error, lo que permite una comunicación estandarizada entre nuestro servicio y sus usuarios.
message	string	Representación legible del error.
relatedResource	ErrorRelatedResource	Detalles del recurso relacionado con el error.

ItemTag

Object

Representa una etiqueta aplicada en un elemento.

Nombre	Tipo	Description
displayName	string	Nombre de la etiqueta.
id	string (uuid)	Identificador de etiqueta.

ItemType

Enumeración

Tipo del elemento. Se pueden agregar tipos de elementos adicionales a lo largo del tiempo.

Valor	Description
ApacheAirflowJob	An ApacheAirflowJob.
CopyJob	Un trabajo de copia.
Dashboard	Panel de PowerBI.
DataPipeline	Una canalización de datos.
Dataflow	Flujo de datos.
Datamart	Datamart de PowerBI.
DigitalTwinBuilder	A DigitalTwinBuilder.
DigitalTwinBuilderFlow	Un flujo de Digital Twin Builder.
Environment	Un entorno.
Eventhouse	Un centro de eventos.
Eventstream	Una secuencia de eventos.
GraphQLApi	Una API para el elemento GraphQL.
KQLDashboard	Un panel de KQL.
KQLDatabase	Una base de datos KQL.
KQLQueryset	Un conjunto de consultas KQL.
Lakehouse	Una casa de lago.
MLExperiment	Un experimento de aprendizaje automático.
MLModel	Un modelo de aprendizaje automático.
MirroredAzureDatabricksCatalog	Un catálogo de Azure Databricks reflejado.
MirroredDatabase	Una base de datos reflejada.
MirroredWarehouse	Un almacén reflejado.
MountedDataFactory	A MountedDataFactory.
Notebook	Un cuaderno.
PaginatedReport	Informe paginado de PowerBI.
Reflex	Un reflejo.
Report	Informe de PowerBI.
SQLDatabase	A SQLDatabase.
SQLEndpoint	Un punto de conexión de SQL.
SemanticModel	Modelo semántico de PowerBI.
SparkJobDefinition	Una definición de trabajo de Spark.
VariableLibrary	A VariableLibrary.
Warehouse	Un almacén.
WarehouseSnapshot	Una instantánea de almacenamiento.

MirroredAzureDatabricksCatalog

Object

Un elemento MirroredAzureDatabricksCatalog.

Nombre	Tipo	Description
description	string	Descripción del elemento.
displayName	string	Nombre para mostrar del elemento.
folderId	string (uuid)	Identificador de carpeta.
id	string (uuid)	Identificador del elemento.
properties	MirroredAzureDatabricksCatalogProperties	Propiedades MirroredAzureDatabricksCatalog.
tags	ItemTag[]	Lista de etiquetas aplicadas.
type	ItemType	Tipo de elemento.
workspaceId	string (uuid)	El identificador del área de trabajo.

MirroredAzureDatabricksCatalogCreationPayload

Object

MirroredAzureDatabricksCatalog create item payload.

Nombre	Tipo	Description
catalogName	string	Nombre del catálogo de Azure Databricks.
databricksWorkspaceConnectionId	string (uuid)	Identificador de conexión del área de trabajo de Azure Databricks.
mirroringMode	MirroringModes	Modo de creación de reflejo.
storageConnectionId	string (uuid)	Identificador de conexión de almacenamiento.

MirroredAzureDatabricksCatalogProperties

Object

Propiedades MirroredAzureDatabricksCatalog.

Nombre	Tipo	Description
autoSync	AutoSync	Sincronizar automáticamente el catálogo. Se pueden agregar tipos de `autoSync` adicionales a lo largo del tiempo.
catalogName	string	Nombre del catálogo de Azure Databricks.
databricksWorkspaceConnectionId	string (uuid)	Identificador de conexión del área de trabajo de Azure Databricks.
mirrorStatus	MirrorStatus	Estado de sincronización MirroredAzureDatabricksCatalog.
mirroringMode	MirroringModes	Modo de creación de reflejo. Se puede agregar mirroringMode adicional a lo largo del tiempo.
oneLakeTablesPath	string	Ruta de acceso oneLake al directorio de tablas MirroredAzureDatabricksCatalog.
sqlEndpointProperties	SqlEndpointProperties	Objeto que contiene las propiedades del punto de conexión de SQL.
storageConnectionId	string (uuid)	Identificador de conexión de almacenamiento.
syncDetails	SyncDetails	Estado de sincronización MirroredAzureDatabricksCatalog.

MirroredAzureDatabricksCatalogPublicDefinition

Object

Objeto de definición pública MirroredAzureDatabricksCatalog. Consulte este artículo para obtener más información sobre cómo crear una definición pública de definición de MirroredAzureDatabricksCatalog.

Nombre	Tipo	Description
format	string	Formato de la definición de elemento.
parts	MirroredAzureDatabricksCatalogPublicDefinitionPart[]	Lista de elementos de definición.

MirroredAzureDatabricksCatalogPublicDefinitionPart

Object

Objeto de parte de definición MirroredAzureDatabricksCatalog.

Nombre	Tipo	Description
path	string	Ruta de acceso de la parte MirroredAzureDatabricksCatalog.
payload	string	Carga de la parte MirroredAzureDatabricksCatalog.
payloadType	PayloadType	Tipo de carga.

MirroringModes

Enumeración

Modo para la creación de reflejo. Se puede agregar mirroringMode adicional a lo largo del tiempo.

Valor	Description
Full	Refleje todo lo que hay dentro de un catálogo excepto los esquemas y tablas excluidos específicamente. Todo se sincroniza de forma predeterminada si no se proporciona ninguna exclusión.
Partial	Solo se reflejan los esquemas y tablas seleccionados. No se sincroniza nada de forma predeterminada.

MirrorStatus

Enumeración

Estado de la creación de reflejo. Se puede agregar un estado adicional a lo largo del tiempo.

Valor	Description
Mirrored	Indica que todo el catálogo se ha reflejado correctamente, lo que garantiza que todos los esquemas y tablas del origen estén totalmente sincronizados con el elemento MirroredAzureDatabricksCatalog.
NotMirrored	Indica que el catálogo aún no se ha reflejado. De forma predeterminada, no se sincronizan esquemas ni tablas a menos que se configuren explícitamente.

PayloadType

Enumeración

Tipo de la carga de la parte de definición. Se pueden agregar tipos de carga adicionales a lo largo del tiempo.

Valor	Description
InlineBase64	Base 64 insertada.

SqlEndpointProperties

Object

Objeto que contiene las propiedades del punto de conexión de SQL.

Nombre	Tipo	Description
connectionString	string	Cadena de conexión del punto de conexión de SQL.
id	string	Identificador del punto de conexión de SQL.

Status

Enumeración

Estado de sincronización. Se puede agregar un estado adicional a lo largo del tiempo.

Valor	Description
Failed	Error en el proceso de creación de reflejo.
InProgress	El proceso de creación de reflejo está actualmente en curso.
NotStarted	La creación de reflejo del catálogo aún no se ha iniciado
Success	El catálogo se ha reflejado correctamente.

SyncDetails

Object

El estado de creación de reflejo MirroredAzureDatabricksCatalog.

Nombre	Tipo	Description
errorInfo	ErrorInfo	La información de error.
lastSyncDateTime	string (date-time)	La última hora de sincronización en UTC, con el formato AAAA-MM-DDTHH:mm:ssZ.
status	Status	Estado de sincronización. Se puede agregar un estado adicional a lo largo del tiempo.

Compartir a través de

Items - Create Mirrored Azure Databricks Catalog

Permisos

Ámbitos delegados necesarios

Identidades admitidas de Microsoft Entra

Interfaz

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Ejemplos

Create a mirroredAzureDatabricksCatalog with creation payload example

Solicitud de ejemplo

Respuesta de muestra

Create an mirroredAzureDatabricksCatalog with definition example

Solicitud de ejemplo

Respuesta de muestra

Definiciones

AutoSync

CreateMirroredAzureDatabricksCatalogRequest

ErrorInfo

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemTag

ItemType

MirroredAzureDatabricksCatalog

MirroredAzureDatabricksCatalogCreationPayload

MirroredAzureDatabricksCatalogProperties

MirroredAzureDatabricksCatalogPublicDefinition

MirroredAzureDatabricksCatalogPublicDefinitionPart

MirroringModes

MirrorStatus

PayloadType

SqlEndpointProperties

Status

SyncDetails