Discovery - Discover Schemas

Service:

MirroredAzureDatabricksCatalog

Version d'API:

v1

Remarque

Cet API est en préversion.

Retourne une liste de schémas dans le catalogue donné à partir du catalogue Unity.
Cette API prend en charge pagination.

Autorisations

L’appelant doit avoir visionneuse ou un rôle d’espace de travail supérieur.

Étendues déléguées requises

Workspace.Read.All ou Workspace.ReadWrite.All ou DatabricksCatalog.Read.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}/azuredatabricks/catalogs/{catalogName}/schemas?databricksWorkspaceConnectionId={databricksWorkspaceConnectionId}

Avec des paramètres facultatifs:

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/azuredatabricks/catalogs/{catalogName}/schemas?databricksWorkspaceConnectionId={databricksWorkspaceConnectionId}&continuationToken={continuationToken}&maxResults={maxResults}

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
catalogName	path	True	string	Nom du catalogue.
workspaceId	path	True	string (uuid)	Identifiant de l’espace de travail.
databricksWorkspaceConnectionId	query	True	string (uuid)	ID de connexion de l’espace de travail Databricks.
continuationToken	query		string	Jeton permettant de récupérer la page suivante des résultats.
maxResults	query		integer	Nombre maximal de résultats à retourner.

Réponses

Nom	Type	Description
200 OK	DatabricksSchemas	La demande s’est terminée avec succès.
Other Status Codes	ErrorResponse	Codes d’erreur courants : OperationNotSupportedForItem : opération non prise en charge pour l’élément demandé. CorruptedPayload : la charge utile fournie est endommagée.

Exemples

List Databricks schemas example

Exemple de requête

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/azuredatabricks/catalogs/catalog_1/schemas?databricksWorkspaceConnectionId=c1128f28-d84f-417c-8234-0feb91e35f86

Exemple de réponse

Code d’état:

200

{
  "value": [
    {
      "name": "schema_1",
      "fullName": "catalog_1.schema_1",
      "storageLocation": "abfss://default@externalaccount.dfs.core.windows.net/__unitystorage/schemas/230217cd-94f2-4017-907d-768298b02e2b"
    },
    {
      "name": "schema_2",
      "fullName": "catalog_1.schema_2"
    }
  ],
  "continuationToken": null,
  "continuationUri": null
}

Définitions

Nom	Description
DatabricksSchema	Schéma à partir du catalogue Unity
DatabricksSchemas	Liste des schémas du catalogue Unity.
ErrorRelatedResource	Objet de détails de ressource associé à l’erreur.
ErrorResponse	Réponse d’erreur.
ErrorResponseDetails	Détails de la réponse d’erreur.

DatabricksSchema

Object

Schéma à partir du catalogue Unity

Nom	Type	Description
fullName	string	Nom complet du schéma, sous la forme de catalog_name.schema_name.
name	string	Nom du schéma, relatif au catalogue parent.
storageLocation	string	Emplacement de stockage du schéma.

DatabricksSchemas

Object

Liste des schémas du catalogue Unity.

Nom	Type	Description
Error	ErrorResponse	Erreur définie si impossible d’extraire des schémas
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	DatabricksSchema[]	Liste des schémas Databricks.

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.