Items - List Mirrored Azure Databricks Catalogs

Service:: MirroredAzureDatabricksCatalog

Version d'API:: v1

Remarque

Cet API est en préversion.

Retourne une liste de mirroredAzureDatabricksCatalogs à partir de l’espace de travail spécifié.
Cette API prend en charge pagination.

Autorisations

L’appelant doit avoir un rôle d’espace de travail de visionneuse .

Étendues déléguées requises

Workspace.Read.All ou Workspace.ReadWrite.All

Identités prises en charge par Microsoft Entra

Cette API prend en charge les identités Microsoft répertoriées dans cette section.

Identité	Soutien
Utilisateur	Oui
Service principal et identités gérées	Non

Interface

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

Avec des paramètres facultatifs:

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/mirroredAzureDatabricksCatalogs?continuationToken={continuationToken}

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
workspaceId	path	True	string (uuid)	Identifiant de l’espace de travail.
continuationToken	query		string	Jeton permettant de récupérer la page suivante des résultats.

Réponses

Nom	Type	Description
200 OK	MirroredAzureDatabricksCatalogs	La demande s’est terminée avec succès.
Other Status Codes	ErrorResponse	Codes d’erreur courants : InvalidItemType - Type d’élément non valide

Nom

Type

Description

200 OK

MirroredAzureDatabricksCatalogs

La demande s’est terminée avec succès.

Other Status Codes

ErrorResponse

Codes d’erreur courants :

InvalidItemType - Type d’élément non valide

Exemples

List mirroredAzureDatabricksCatalogs in workspace example

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 200

{
  "value": [
    {
      "id": "3546052c-ae64-4526-b1a8-52af7761426f",
      "displayName": "MirroredAzureDatabricksCatalog_1",
      "description": "A MirroredAzureDatabricksCatalog description.",
      "type": "MirroredAzureDatabricksCatalog",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "properties": {
        "catalogName": "catalog_1",
        "mirroringMode": "Full",
        "databricksWorkspaceConnectionId": "c1128f28-d84f-417c-8234-0feb91e35f86",
        "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": "Disabled",
        "storageConnectionId": "c1128f28-d84f-417c-8234-0feb91e35f87"
      }
    },
    {
      "id": "a8a1bffa-7eea-49dc-a1d2-6281c1d031f1",
      "displayName": "MirroredAzureDatabricksCatalog_2",
      "description": "A MirroredAzureDatabricksCatalog description.",
      "type": "MirroredAzureDatabricksCatalog",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "properties": {
        "catalogName": "catalog_2",
        "mirroringMode": "Full",
        "databricksWorkspaceConnectionId": "c1128f28-d84f-417c-8234-0feb91e35f86",
        "oneLakeTablesPath": "https://onelake.dfs.fabric.microsoft.com/fc5d0537-1b22-4de1-a5e9-9b8bb58ed1e1/6dc325f6-46f6-4a2a-930b-10b96a463566/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": "Disabled",
        "storageConnectionId": "c1128f28-d84f-417c-8234-0feb91e35f86"
      }
    }
  ]
}

Définitions

Nom	Description
AutoSync	Activez ou désactivez la synchronisation automatique pour le catalogue. Lorsque cette option est activée, toutes les modifications de métadonnées, y compris les schémas et les tables, sont automatiquement synchronisées toutes les 15 minutes. En cas de désactivation, les utilisateurs doivent actualiser manuellement les métadonnées. Ce paramètre ne peut être modifié qu’au cours d’une demande de mise à jour. Des types `autoSync` supplémentaires peuvent être ajoutés au fil du temps.
ErrorInfo	L’information sur l’erreur.
ErrorRelatedResource	Objet de détails de ressource associé à l’erreur.
ErrorResponse	Réponse d’erreur.
ErrorResponseDetails	Détails de la réponse d’erreur.
ItemTag	Représente une balise appliquée à un élément.
ItemType	Type de l’élément. Des types d’éléments supplémentaires peuvent être ajoutés au fil du temps.
MirroredAzureDatabricksCatalog	Élément MirroredAzureDatabricksCatalog.
MirroredAzureDatabricksCatalogProperties	Propriétés MirroredAzureDatabricksCatalog.
MirroredAzureDatabricksCatalogs	Liste de MirroredAzureDatabricksCatalogs.
MirroringModes	Mode de mise en miroir. Un modèle de mise en miroir supplémentaire peut être ajouté au fil du temps.
MirrorStatus	État de la mise en miroir. Un état supplémentaire peut être ajouté au fil du temps.
SqlEndpointProperties	Objet contenant les propriétés du point de terminaison SQL.
Status	État de synchronisation. Un état supplémentaire peut être ajouté au fil du temps.
SyncDetails	État de la mise en miroir MirroredAzureDatabricksCatalog.

AutoSync

Énumération

Activez ou désactivez la synchronisation automatique pour le catalogue. Lorsque cette option est activée, toutes les modifications de métadonnées, y compris les schémas et les tables, sont automatiquement synchronisées toutes les 15 minutes. En cas de désactivation, les utilisateurs doivent actualiser manuellement les métadonnées. Ce paramètre ne peut être modifié qu’au cours d’une demande de mise à jour. Des types autoSync supplémentaires peuvent être ajoutés au fil du temps.

Valeur	Description
Disabled	La synchronisation automatique est désactivée.
Enabled	La synchronisation automatique est activée.

ErrorInfo

Object

L’information sur l’erreur.

Nom	Type	Description
errorCode	string	Code d’erreur.
errorDetails	string	Détails de l’erreur.
errorMessage	string	Message d’erreur.

ErrorRelatedResource

Object

Objet de détails de ressource associé à l’erreur.

Nom	Type	Description
resourceId	string	ID de ressource impliqué dans l’erreur.
resourceType	string	Type de la ressource impliquée dans l’erreur.

ErrorResponse

Object

Réponse d’erreur.

Nom	Type	Description
errorCode	string	Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message	string	Représentation lisible humaine de l’erreur.
moreDetails	ErrorResponseDetails[]	Liste des détails d’erreur supplémentaires.
relatedResource	ErrorRelatedResource	Détails de la ressource associée à l’erreur.
requestId	string	ID de la demande associée à l’erreur.

ErrorResponseDetails

Object

Détails de la réponse d’erreur.

Nom	Type	Description
errorCode	string	Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message	string	Représentation lisible humaine de l’erreur.
relatedResource	ErrorRelatedResource	Détails de la ressource associée à l’erreur.

ItemTag

Object

Représente une balise appliquée à un élément.

Nom	Type	Description
displayName	string	Nom de la balise.
id	string (uuid)	ID de balise.

ItemType

Énumération

Type de l’élément. Des types d’éléments supplémentaires peuvent être ajoutés au fil du temps.

Valeur	Description
ApacheAirflowJob	An ApacheAirflowJob.
CopyJob	Tâche de copie.
Dashboard	Tableau de bord PowerBI.
DataPipeline	Un pipeline de données.
Dataflow	Flux de données.
Datamart	Datamart PowerBI.
DigitalTwinBuilder	A DigitalTwinBuilder.
DigitalTwinBuilderFlow	Flux de générateur de jumeaux numériques.
Environment	Environnement.
Eventhouse	Un eventhouse.
Eventstream	Flux d’événements.
GraphQLApi	API pour l’élément GraphQL.
KQLDashboard	Tableau de bord KQL.
KQLDatabase	Base de données KQL.
KQLQueryset	Ensemble de requêtes KQL.
Lakehouse	Un lac.
MLExperiment	Une expérience de Machine Learning.
MLModel	Modèle Machine Learning.
MirroredAzureDatabricksCatalog	Catalogue Azure databricks mis en miroir.
MirroredDatabase	Une base de données mise en miroir.
MirroredWarehouse	Un entrepôt mis en miroir.
MountedDataFactory	Un MountedDataFactory.
Notebook	Un notebook.
PaginatedReport	Rapport paginé PowerBI.
Reflex	Un réflexe.
Report	Rapport PowerBI.
SQLDatabase	A SQLDatabase.
SQLEndpoint	Point de terminaison SQL.
SemanticModel	Modèle sémantique PowerBI.
SparkJobDefinition	Définition d’un travail Spark.
VariableLibrary	A VariableLibrary.
Warehouse	Un entrepôt.
WarehouseSnapshot	Capture instantanée de l’entrepôt.

MirroredAzureDatabricksCatalog

Object

Élément MirroredAzureDatabricksCatalog.

Nom	Type	Description
description	string	Description de l’élément.
displayName	string	Nom complet de l’élément.
folderId	string (uuid)	ID du dossier.
id	string (uuid)	ID d’élément.
properties	MirroredAzureDatabricksCatalogProperties	Propriétés MirroredAzureDatabricksCatalog.
tags	ItemTag[]	Liste des balises appliquées.
type	ItemType	Type d’élément.
workspaceId	string (uuid)	Identifiant de l’espace de travail.

MirroredAzureDatabricksCatalogProperties

Object

Propriétés MirroredAzureDatabricksCatalog.

Nom	Type	Description
autoSync	AutoSync	Synchroniser automatiquement le catalogue. Des types `autoSync` supplémentaires peuvent être ajoutés au fil du temps.
catalogName	string	Nom du catalogue Azure databricks.
databricksWorkspaceConnectionId	string (uuid)	ID de connexion de l’espace de travail Azure databricks.
mirrorStatus	MirrorStatus	État de synchronisation MirroredAzureDatabricksCatalog.
mirroringMode	MirroringModes	Mode de mise en miroir. Un modèle de mise en miroir supplémentaire peut être ajouté au fil du temps.
oneLakeTablesPath	string	Chemin OneLake du répertoire des tables MirroredAzureDatabricksCatalog.
sqlEndpointProperties	SqlEndpointProperties	Objet contenant les propriétés du point de terminaison SQL.
storageConnectionId	string (uuid)	ID de connexion de stockage.
syncDetails	SyncDetails	État de synchronisation MirroredAzureDatabricksCatalog.

MirroredAzureDatabricksCatalogs

Object

Liste de MirroredAzureDatabricksCatalogs.

Nom	Type	Description
continuationToken	string	Jeton du lot du jeu de résultats suivant. S’il n’y a plus d’enregistrements, il est supprimé de la réponse.
continuationUri	string	URI du lot du jeu de résultats suivant. S’il n’y a plus d’enregistrements, il est supprimé de la réponse.
value	MirroredAzureDatabricksCatalog[]	Liste de MirroredAzureDatabricksCatalogs.

MirroringModes

Énumération

Mode de mise en miroir. Un modèle de mise en miroir supplémentaire peut être ajouté au fil du temps.

Valeur	Description
Full	Mettre en miroir tout à l’intérieur d’un catalogue, à l’exception des schémas et des tables spécifiquement exclus. Tout est synchronisé par défaut si aucune exclusion n’est fournie.
Partial	Seuls les schémas et tables sélectionnés sont mis en miroir. Rien n’est synchronisé par défaut.

MirrorStatus

Énumération

État de la mise en miroir. Un état supplémentaire peut être ajouté au fil du temps.

Valeur	Description
Mirrored	Indique que l’ensemble du catalogue a été correctement mis en miroir, ce qui garantit que tous les schémas et tables de la source sont entièrement synchronisés avec l’élément MirroredAzureDatabricksCatalog.
NotMirrored	Indique que le catalogue n’a pas encore été mis en miroir. Aucun schéma ou table n’est synchronisé par défaut, sauf s’il est configuré explicitement.

SqlEndpointProperties

Object

Objet contenant les propriétés du point de terminaison SQL.

Nom	Type	Description
connectionString	string	Chaîne de connexion de point de terminaison SQL.
id	string	ID de point de terminaison SQL.

Status

Énumération

État de synchronisation. Un état supplémentaire peut être ajouté au fil du temps.

Valeur	Description
Failed	Le processus de mise en miroir a échoué.
InProgress	Le processus de mise en miroir est actuellement en cours.
NotStarted	La mise en miroir de catalogues n’est pas encore démarrée
Success	Le catalogue a été correctement mis en miroir.

SyncDetails

Object

État de la mise en miroir MirroredAzureDatabricksCatalog.

Nom	Type	Description
errorInfo	ErrorInfo	L’information sur l’erreur.
lastSyncDateTime	string (date-time)	Heure de la dernière synchronisation au format UTC, à l’aide du format AAAA-MM-DDTHH :mm :ssZ.
status	Status	État de synchronisation. Un état supplémentaire peut être ajouté au fil du temps.

Partager via

Items - List Mirrored Azure Databricks Catalogs

Autorisations

Étendues déléguées requises

Identités prises en charge par Microsoft Entra

Interface

Paramètres URI

Réponses

Exemples

List mirroredAzureDatabricksCatalogs in workspace example

Exemple de requête

Exemple de réponse

Définitions

AutoSync

ErrorInfo

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ItemTag

ItemType

MirroredAzureDatabricksCatalog

MirroredAzureDatabricksCatalogProperties

MirroredAzureDatabricksCatalogs

MirroringModes

MirrorStatus

SqlEndpointProperties

Status

SyncDetails