Mise à jour vers la dernière version d’API Databricks SQL

Cette page décrit les modifications apportées aux API Requêtes, Alertes, Autorisations, Sources de données et Visualisations incluses dans la dernière version de l’API SQL Databricks. L’API héritée est déconseillée et la prise en charge se termine bientôt. Utilisez cette page pour migrer vos applications et intégrations vers la nouvelle version de l’API.

Modifications apportées à l’API Requêtes

La nouvelle API Requêtes inclut une expérience utilisateur plus conviviale avec des noms plus descriptifs, des réponses paginées, et des réponses sous forme de liste automatiquement triées par heure de création. La liste suivante décrit les modifications apportées à l’API Requêtes :

• Le chemin d’accès de l’API est désormais api/2.0/sql/queries et remplace le chemin d’accès hérité de /api/2.0/preview/sql/queries.
• Inclut une nouvelle définition de requête avec des types et des noms de champs plus descriptifs.
• Le point de terminaison de mise à jour prend désormais en charge les mises à jour partielles en utilisant PATCH au lieu de POST.
• Le point de terminaison de mise à jour prend désormais en charge le transfert de propriété de requêtes. Auparavant, cela n’était autorisé qu’à l’aide de l’API Transfert de propriété des objets.
• Les réponses du point de terminaison des listes sont désormais paginées en utilisant la pagination basée sur un jeton.
• Le point de terminaison de liste ne prend plus en charge le filtrage par nom ou par ordre personnalisé. Au lieu de cela, toutes les requêtes accessibles sont retournées et triées dans l’ordre croissant par leur heure de création.
• Le point de terminaison de restauration n’est plus pris en charge. Les requêtes placées dans la corbeille peuvent continuer à être restaurées via l’interface utilisateur Azure Databricks.

Pour obtenir la documentation complète sur l’API Requêtes mise à jour, consultez Requêtes.

Modifications apportées à l’API Alertes

La nouvelle API Alertes inclut une expérience utilisateur plus conviviale avec des types et noms de champs plus descriptifs, des réponses paginées pour répertorier des points de terminaison et un support pour les mises à jour partielles. La liste suivante décrit les modifications apportées à l’API Alertes :

• Le chemin d’accès de l’API est désormais api/2.0/sql/alerts et remplace le chemin d’accès hérité de /api/2.0/preview/sql/alerts.
• Inclut une nouvelle définition d’alerte utilisée avec des types et des noms de champs plus descriptifs.
• Le point de terminaison de mise à jour prend désormais en charge les mises à jour partielles en utilisant PATCH au lieu de POST.
• Le point de terminaison de mise à jour prend désormais en charge le transfert de propriété de requêtes. Auparavant, cela n’était autorisé qu’à l’aide de l’API Transfert de propriété des objets.
• Les réponses du point de terminaison de la liste sont désormais paginées en utilisant la pagination basée sur un jeton.
• Le point de terminaison de suppression déplace désormais l’alerte vers la corbeille au lieu de supprimer définitivement l’alerte. Les alertes mises à la corbeille seront automatiquement supprimées après 30 jours. Les alertes mises à la corbeille peuvent être restaurées dans les 30 jours de la suppression via l’interface utilisateur Azure Databricks.

Pour obtenir la documentation complète sur l’API Alertes mise à jour, consultez Alertes.

API des autorisations déconseillé

L’API Autorisations est désormais marquée comme déconseillée. Utilisez l’API Espace de travail pour gérer les autorisations d’objet. Utilisez les API de mise à jour des requêtes et des alertes pour transférer la propriété de l'objet.

API Sources de données déconseillée

L’API Sources de données est désormais marquée comme déconseillée. Actuellement, ses fonctionnalités sont limitées à l’obtention d’une liste d’entrepôts SQL. Du fait que la nouvelle API Requêtes prend en charge la transmission et le retour des ID d’entrepôt SQL au lieu des ID de source de données, un appel d’API distinct pour la conversion entre les sources de données et les entrepôts SQL n’est plus requis.

Mise à niveau des versions du Kit de développement logiciel (

Si vous accédez à l’API SQL Databricks héritée via les kits SDK Databricks, effectuez une mise à niveau vers la dernière version du SDK et migrez vers les nouvelles API. Consultez les SDK Databricks pour la documentation.

Migration des commandes CLI

Si vous accédez à l’API SQL Databricks héritée via l’interface CLI Databricks, migrez à partir de ces groupes de commandes déconseillés :

Deprecated	Utiliser à la place
requêtes héritées	queries
alertes anciennes	alerts
sources de données	Aucun remplacement

Migration des ressources Terraform

Si vous utilisez Terraform pour gérer vos ressources Databricks SQL, migrez vers les nouvelles définitions de ressources :

Ressource déconseillée	Utiliser à la place	Guide de Migration
databricks_sql_query	databricks_query	Guide de migration
databricks_sql_alert	databricks_alert	Guide de migration
databricks_sql_visualization	databricks_dashboard	Aucun guide de migration

Pour databricks_sql_endpoint et databricks_sql_warehouse :

Effectuez une mise à niveau vers le fournisseur Databricks Terraform v1.105.0 ou version ultérieure. Le data_source_id champ est déconseillé. Mise à niveau pour éviter les erreurs lorsque l’API de sources de données déconseillée est désactivée.