Référence des clés API des paramètres
Cette page répertorie les paramètres disponibles via l'API publique Databricks Settings, regroupés par portée. Chaque paramètre est identifié par un nom de paramètre (clé) stable. Pour savoir comment découvrir, lire et mettre à jour ces paramètres, consultez Gérer les paramètres via l'API Settings.
Les aperçus de fonctionnalités sont également gérés via l’API Settings, mais ne sont pas répertoriés ici car ils sont temporaires et finissent par atteindre leur fin de vie. Découvrez les aperçus actuellement à votre disposition via l’ endpoint settings-metadata.
Paramètres disponibles
Les paramètres suivants sont disponibles via l’API Settings publique, regroupés par périmètre. Cette liste est générée périodiquement ; pour obtenir l’ensemble des paramètres faisant autorité et toujours à jour ainsi que leurs liens de documentation, appelez l’ endpoint settings-metadata, qui renvoie name, description, type et docs_link pour chaque paramètre.
Paramètres du compte
Paramètres qui s'appliquent à l'ensemble du compte.
Paramètre | Nom de la clé | Description |
|---|---|---|
| Désactiver les fonctionnalités héritées pour les nouveaux workspaces Databricks. Pour les nouveaux Workspace créés : 1. Désactive l'utilisation de la racine et des montages DBFS. 2. Le Hive Metastore ne sera pas provisionné. 3. Désactive l'utilisation des « clusters sans isolation ». 4. Désactive les versions de Databricks Runtime antérieures à 13.3LTS. | |
| Détermine si les modèles optimisés par des partenaires sont activés ou non. Ce paramètre est disponible au niveau du compte et au niveau du workspace | |
Appliquer les fonctionnalités d'IA optimisées par des partenaires |
| Détermine si le paramètre d’application des fonctionnalités optimisées par des partenaires est activé. Lorsque cette option est activée, la valeur définie au niveau du compte pour les fonctionnalités optimisées par des partenaires remplace toute valeur de remplacement définie au niveau du Workspace. |
| Le paramètre Restrict Workspace Admins vous permet de contrôler les capacités des administrateurs de workspace. Avec le statut du paramètre défini sur ALLOW_ALL, les administrateurs de workspace peuvent créer des jetons d'accès personnel de Service Principal au nom de n'importe quel Service Principal dans leur workspace. Les administrateurs de workspace peuvent également changer le propriétaire d'un job pour n'importe quel utilisateur de leur workspace. Ils peuvent également modifier le paramètre run_as du job pour n'importe quel utilisateur de leur workspace ou pour un Service Principal pour lequel ils disposent du rôle d'utilisateur de Service Principal. Avec le statut du paramètre défini sur RESTRICT_TOKENS_AND_JOB_RUN_AS, les administrateurs de Workspace peuvent uniquement créer des jetons d'accès personnel au nom des Service Principal pour lesquels ils disposent du rôle d'utilisateur de Service Principal. Ils peuvent également uniquement changer le propriétaire d'un job pour eux-mêmes. Ils peuvent également modifier le paramètre run_as du job pour eux-mêmes ou pour un Service Principal pour lequel ils disposent du rôle d'utilisateur de Service Principal. | |
Profil de sécurité de conformité pour les nouveaux Workspace |
| Détermine si le profil de sécurité de la conformité est activé par default pour les nouveaux Workspace créés dans le compte. Le profil de sécurité de la conformité fournit une base de référence hautement sécurisée (monitoring supplémentaire, image de compute renforcée, types d'instances imposés et autres contrôles) qui facilite le respect et la gestion des normes de conformité applicables. Lorsqu'il est activé par default au niveau du compte, le monitoring de sécurité amélioré et la mise à jour automatique du cluster sont également activés pour les nouveaux workspaces. |
Monitoring de sécurité renforcé pour les nouveaux workspaces |
| Détermine si le monitoring de sécurité renforcé est activé par default pour les nouveaux workspaces créés dans le compte. Le monitoring de sécurité renforcé fournit une image de compute durcie et des agents de monitoring de sécurité supplémentaires qui génèrent des lignes de logs vérifiables. Si le profil de sécurité de la conformité est activé pour les nouveaux workspaces, ce paramètre est appliqué de façon permanente. Le monitoring de sécurité renforcé au niveau du compte est pris en charge uniquement sur AWS et GCP. |
Paramètres du workspace
Paramètres qui s'appliquent à un seul workspace.
Paramètre | Nom de la clé | Description |
|---|---|---|
| Détermine si l’intégration des tableaux de bord publiés AI/BI est activée, activée sous condition ou désactivée au niveau du workspace. Par default, ce paramètre est activé sous condition (ALLOW_APPROVED_DOMAINS). | |
Domaines approuvés pour l’intégration des tableaux de bord AI/BI |
| Contrôle la liste des domaines approuvés pour héberger les tableaux de bord AI/BI intégrés. La liste des domaines approuvés ne peut pas être modifiée lorsque la politique d’accès actuelle n’est pas définie sur ALLOW_APPROVED_DOMAINS. |
Restreindre les portées OAuth des applications aux valeurs sélectionnées |
| Restreignez les périmètres OAuth que les développeurs d’applications peuvent demander lorsqu’ils agissent au nom des utilisateurs. Spécifiez une liste de périmètres autorisés, ou utilisez « * » pour autoriser tous les périmètres pris en charge. Une liste vide désactive effectivement l'autorisation utilisateur pour les applications. |
| La mise à jour automatique des clusters garantit que tous les clusters d’un workspace sont périodiquement mis à jour vers la dernière image de système d’exploitation hôte et les dernières mises à jour de sécurité. Les administrateurs de compte peuvent planifier la fréquence de la fenêtre de maintenance, la date de start et l’heure de start. S’applique au compute classique (clusters, Pool, SQL Warehouse classiques, Model Serving hérité) ; cela ne s’applique pas au compute Serverless. L’activation de cette fonctionnalité ajoute le module complémentaire Enhanced Security and Compliance et nécessite le niveau Tarifs Premium. | |
| Contrôle quelles plateformes de collaboration externes (Slack et/ou Microsoft Teams) peuvent se connecter à cet Workspace. La valeur par défaut est ALLOW_ALL. | |
Autoriser les messages publics sur les plateformes de collaboration |
| Lorsque cette option est activée, les utilisateurs peuvent choisir si les réponses de l'application Databricks dans Slack sont visibles dans le canal. Lorsque cette option est désactivée, toutes les réponses seront obligatoirement privées pour l'utilisateur demandeur. |
| Une heure spécifique après laquelle le personnel de Databricks ne peut plus se connecter à votre workspace. L'heure est formatée comme suit : | |
| L’API de paramètre d’espace de noms default permet aux utilisateurs de configurer l’espace de noms default pour un Workspace Databricks. | |
| « Disabling legacy access » a les impacts suivants : 1. Désactive l’accès direct aux Hive Metastores depuis le workspace (l’accès via la fédération Hive Metastore n’est pas affecté). 2. Désactive le mode fallback sur l’accès aux emplacements externes depuis le workspace. 3. Désactive les versions de Databricks Runtime antérieures à 13.3LTS. Important : ce paramètre ne peut pas être activé tant que le catalogue par default du Workspace est défini sur un catalogue hérité (hive_metastore ou spark_catalog). Changez d’abord le catalogue default pour un Unity Catalog catalog. | |
| La désactivation de l’ancien DBFS a les deux conséquences suivantes : 1. L’accès à la racine et aux montages DBFS est interdit (tout comme la création de nouveaux montages). 2. Désactive les versions de Databricks Runtime antérieures à 13.3LTS. Lorsque le paramètre est désactivé, toutes les fonctionnalités DBFS sont activées et aucune restriction n’est imposée sur les versions de Databricks Runtime. Il faut compter jusqu’à 20 minutes pour que la modification de ce paramètre prenne effet. Les clusters de compute multifonction et les SQL Warehouses doivent être redémarrés manuellement. | |
Autoriser uniquement les déploiements d’applications à partir de Git |
| Lorsque ce paramètre est activé, les applications de ce workspace ne peuvent être déployées qu’à partir de Git. |
| Détermine si les modèles optimisés par des partenaires sont activés ou non. Ce paramètre est disponible au niveau du compte et au niveau du workspace | |
| Fournit les plus hauts niveaux de résilience opérationnelle et de sécurité pour les charges de travail critiques. Inclut la reprise après sinistre ainsi que la sécurité et la conformité renforcées. | |
| Destinataire supplémentaire pour les e-mails opérationnels de ce workspace. Lorsque ce paramètre est défini, Databricks envoie ces e-mails à la fois aux administrateurs du workspace et à cette adresse. Disponible sur AWS et GCP. | |
| Le paramètre Restrict Workspace Admins vous permet de contrôler les capacités des administrateurs de workspace. Avec le statut du paramètre défini sur ALLOW_ALL, les administrateurs de workspace peuvent créer des jetons d'accès personnel de Service Principal au nom de n'importe quel Service Principal dans leur workspace. Les administrateurs de workspace peuvent également changer le propriétaire d'un job pour n'importe quel utilisateur de leur workspace. Ils peuvent également modifier le paramètre run_as du job pour n'importe quel utilisateur de leur workspace ou pour un Service Principal pour lequel ils disposent du rôle d'utilisateur de Service Principal. Avec le statut du paramètre défini sur RESTRICT_TOKENS_AND_JOB_RUN_AS, les administrateurs de Workspace peuvent uniquement créer des jetons d'accès personnel au nom des Service Principal pour lesquels ils disposent du rôle d'utilisateur de Service Principal. Ils peuvent également uniquement changer le propriétaire d'un job pour eux-mêmes. Ils peuvent également modifier le paramètre run_as du job pour eux-mêmes ou pour un Service Principal pour lequel ils disposent du rôle d'utilisateur de Service Principal. | |
| Contrôle si le profil de sécurité de la conformité est activé pour ce workspace. Le profil de sécurité de la conformité fournit une base de référence hautement sécurisée (monitoring supplémentaire, image de compute durcie, types d'instances imposés pour le chiffrement inter-nœuds et autres contrôles) qui facilite le respect et la gestion des normes de conformité applicables. Son activation active également de façon permanente le monitoring de sécurité renforcé et la mise à jour automatique des clusters sur le Workspace, et ajoute le module complémentaire Enhanced Security and conformité. | |
| Contrôle si le monitoring de sécurité renforcé est activé pour ce workspace. Le monitoring de sécurité renforcé fournit une image de compute durcie et des agents de monitoring de sécurité supplémentaires (monitoring de l'intégrité des fichiers, antivirus et analyse des vulnérabilités) qui génèrent des lignes de logs consultables. Cela s'applique uniquement aux ressources du plan de compute classique, et non au serverless. Si le profil de sécurité de la conformité est activé sur le workspace, ce paramètre est appliqué de façon permanente. |
Préférences de l'utilisateur
Paramètres qui s'appliquent à un utilisateur dans un compte.
Paramètre | Nom de la clé | Description |
|---|---|---|
Création automatique d'une session lors de l'interaction avec l'éditeur |
| Détermine si une session est automatiquement créée lors de l’interaction avec l’éditeur. |
Lancement et association automatiques |
| Contrôle si les notebooks se lancent et s'associent automatiquement aux clusters. |
Confirmer la suppression d'une commande |
| Détermine si une confirmation est requise avant la suppression d'une commande. |
Créer de nouveaux assets dans le dossier Brouillons |
| Contrôle si les nouveaux assets sont créés dans le dossier Brouillons. |
Préférence de création et de conversion de requêtes à l'ouverture dans l'éditeur SQL unifié Databricks |
| Ce paramètre contrôle le comportement de création et de conversion de query dans l'éditeur SQL unifié. |
Unité d'indentation Python default |
| Contrôle l’unité d’indentation Python default. Valeurs autorisées : |
Thème sombre personnalisé de l'éditeur |
| Contrôle le thème sombre personnalisé de l'éditeur. Valeurs autorisées : |
Thème lumineux personnalisé de l'éditeur |
| Contrôle le thème clair personnalisé de l'éditeur. Valeurs autorisées : |
Taille de la police de l’éditeur |
| Contrôle la taille de la police dans l’éditeur. Valeurs autorisées : plage d’entiers de 10 à 30. |
Activer la solution rapide en ligne automatique |
| Détermine si les corrections rapides en ligne sont suggérées automatiquement. |
Activer l’exclusion de la correction rapide en ligne automatique |
| Contrôle de désactivation pour les corrections rapides automatiques en ligne. |
Activer le diagnostic de trigger automatique |
| Détermine si les diagnostics sont Trigger automatiquement. |
Activer l’option de désactivation du diagnostic automatique par Trigger |
| Contrôle de désinscription pour les diagnostics automatiques. |
Activer le layout centré |
| Détermine si l'éditeur utilise un Layout centré. |
Activer les raccourcis classiques |
| Contrôle le mode des raccourcis clavier. Valeurs autorisées : |
Activer les numéros de commande |
| Détermine si les numéros de commande sont affichés dans les notebooks. |
Activer la saisie semi-automatique au fur et à mesure |
| Contrôle si les suggestions de saisie semi-automatique apparaissent au fur et à mesure de votre saisie. |
Activer le clignotement du curseur |
| Détermine si le curseur clignote dans l’éditeur. |
Activer le Mode sombre |
| Contrôle le mode de thème. Valeurs autorisées : |
Activer la touche Entrée pour accepter les suggestions |
| Détermine si l'appui sur la touche Entrée accepte les suggestions de saisie semi-automatique. |
Activer le survol pour l’éditeur |
| Détermine si les info-bulles au survol sont affichées dans l'éditeur. |
Activer l'option de désactivation de la suggestion en ligne au fur et à mesure de la saisie |
| Contrôle de désactivation des suggestions en ligne au fur et à mesure de votre saisie. |
Activer les numéros de ligne |
| Détermine si les numéros de ligne sont affichés dans l'éditeur. |
Activer les numéros de ligne V2 |
| Détermine si les numéros de ligne sont affichés dans l’éditeur (v2). |
Activer le retour à la ligne |
| Détermine si le texte passe à la ligne suivante dans l'éditeur. |
Activer le multi-curseur Monaco |
| Détermine la touche de modification pour la sélection de plusieurs curseurs. Valeurs autorisées : |
Activer l'exclusion du débogueur de Notebook |
| Contrôle de désactivation pour le débogueur de notebook. |
Activer le bouton d'observabilité Serverless |
| Option d'adhésion utilisateur pour une observabilité Serverless améliorée dans les Jobs lorsque l'aperçu du workspace est activé. |
Activer l'affichage des statistiques de commande dans la nouvelle interface cellule |
| Ce paramètre permet de définir si les statistiques de commande sont affichées dans la nouvelle interface utilisateur de cellule. |
Activer l'affichage des titres de cellules promus |
| Contrôle l'affichage des titres de cellules promus. |
Activer les guillemets intelligents |
| Détermine si les guillemets intelligents sont activés dans l’éditeur. |
Activer les Soft tab pour les Notebooks et les fichiers |
| Contrôle si les tab sont convertis en espaces dans les notebooks et les fichiers. |
Activer la mise en évidence des erreurs de syntaxe SQL |
| Contrôle si les erreurs de syntaxe SQL sont mises en surbrillance. |
Activer le passage en mode Commande après l'exécution |
| Détermine si l’éditeur passe en mode commande après l’exécution d’une cellule. |
Activer l’explorateur d’arborescence de fichiers unifié |
| Contrôle si l’explorateur d’arborescence de fichiers unifié est activé. |
Focus |
| Contrôle si l’explorateur d’arborescence du navigateur de schéma unifié est activé. |
Activer le moteur de rendu Vega Lite |
| Contrôle si le moteur de rendu Vega-Lite est activé pour les visualisations. |
Activer la désinscription du moteur de rendu Vega Lite |
| Contrôle de désactivation pour le moteur de rendu Vega-Lite. |
Activer le tag d'aperçu du moteur de rendu Vega Lite |
| Contrôle l’affichage du tag d’aperçu du moteur de rendu Vega-Lite. |
Panneau inférieur étendu |
| Contrôle si le panneau inférieur étendu est affiché. |
Nouvelle interface utilisateur de monitoring des pipelines Lakeflow |
| Contrôle si la nouvelle interface utilisateur de **LakeFlow Pipelines** monitoring est activée. |
Format d'exportation Default du Notebook |
| Contrôle le format d'exportation par default pour les notebooks. Valeurs autorisées : |
Mode raccourci Option + flèche |
| Contrôle le comportement des raccourcis clavier Option + flèche. Valeurs autorisées : |
Création de pipelines multifichiers |
| Contrôle si la création multifichier est activée pour les pipelines. |
Envoyer des notifications par e-mail pour les commentaires |
| Contrôle si les notifications par e-mail sont envoyées pour les commentaires. |
Afficher la minimap d’exécution des cellules |
| Contrôle l'affichage de la mini-carte d'exécution des cellules. |
Afficher l’invite du panneau Environnement pour Pip |
| Détermine s’il faut afficher l’invite pip vers le panneau Environnement. |
Afficher Spark Advisor |
| Détermine si les suggestions d’optimisation Spark sont affichées. |
Afficher les conseils d'erreur Spark |
| Contrôle l’affichage des conseils utiles pour les erreurs Spark. |
L'utilisateur active la mise en surbrillance des erreurs de format Python |
| Contrôle si les erreurs de formatage Python sont mises en surbrillance. |
L'utilisateur désactive la mise en surbrillance des erreurs de syntaxe Python |
| Contrôle de désactivation pour la mise en surbrillance des erreurs de syntaxe Python. |
L'utilisateur active la vérification de type Python |
| Contrôle si la vérification du type Python est activée. |
L'utilisateur active la restauration de snapshot |
| Contrôle si la fonctionnalité de restauration d'instantané est activée. |
Limite par default de 1 000 pour les nouvelles query |
| Contrôle la limite automatique par default pour les requêtes SQL dans l’éditeur. |