Paramètres : Référence des clés API

Cette page liste les paramètres disponibles via l’API publique Azure Databricks Settings, regroupés par périmètre. Chaque réglage est identifié par un nom stable (clé). Pour savoir comment découvrir, lire et mettre à jour ces paramètres, consultez Gérer les paramètres via l’API des Paramètres.

Les aperçus de fonctionnalités sont également gérés via l’API Paramètres mais ne sont pas listés ici, car ils sont transitoires et atteignent finalement leur fin de vie. Découvrez les aperçus actuellement disponibles via le point de terminaison paramètres-métadonnées.

Paramètres disponibles

Les paramètres suivants sont disponibles via l’API publique des Réglages, regroupés par périmètre. Cette liste est générée périodiquement ; Pour l’ensemble autoritaire et toujours actuel des paramètres et leurs liens de documentation, appelez le point de terminaison Settings-Metadata, qui retourne les nameparamètres de chaque paramètre , description, type, et docs_link.

Paramètres du compte

Paramètres qui s’appliquent à l’ensemble du compte.

Setting Nom de clé Description
Désactiver les fonctionnalités héritées disable_legacy_features Désactivez les fonctionnalités héritées pour les nouveaux espaces de travail Databricks. Pour les espaces de travail nouvellement créés : 1. Désactive l’utilisation de la racine et des montures DBFS. 2. Le Métastore de Ruche ne sera pas provisionné. 3. Désactive l’utilisation des « clusters sans isolation ». 4. Désactive Databricks Les versions d’exécution antérieures à la 13.3LTS.
Appliquer Unity Gateway enforce_ai_gateway_v3_only Contrôle si tout l’accès aux modèles de fondation doit passer par Unity Gateway. Une fois activés, les permissions d’accès au modèle, les budgets IA et les politiques de sécurité sont gérés de manière centralisée avec Unity Gateway, et tout le trafic du modèle de fondation doit passer par celle-ci. Le modèle de fondation hérité desservant les points de terminaison contournant la passerelle Unity rejette le trafic.
Fonctionnalités d’IA optimisées par les partenaires llm_proxy_partner_powered Détermine si les modèles alimentés par le partenaire sont activés ou non. Ce paramètre est disponible à la fois au niveau du compte et de l’espace de travail
Faire respecter des fonctionnalités d’IA alimentées par les partenaires llm_proxy_partner_powered_enforce Détermine si le paramètre d’application du partenaire est activé. Lorsqu’elle est activée, la valeur au niveau du compte et alimentée par le partenaire prime sur toute dérogation au niveau de l’espace de travail.
Restreindre les administrateurs de l’espace de travail restrict_workspace_admins Le paramètre Restreindre les administrateurs d’espace de travail vous permet de contrôler les fonctionnalités des administrateurs d’espace de travail. Avec le statut de paramètre réglé sur ALLOW_ALL, les administrateurs de l’espace de travail peuvent créer des jetons d’accès personnels pour les principaux de service au nom de n’importe quel principal de service dans leur espace de travail. Les administrateurs d’espace de travail peuvent également modifier un propriétaire de travail en n’importe quel utilisateur de son espace de travail. Et ils peuvent modifier le paramètre de la tâche run_as pour n’importe quel utilisateur de leur espace de travail ou vers un principal de service sur lequel ils ont le rôle d’Utilisateur principal de service. Avec le statut de paramètre réglé sur RESTRICT_TOKENS_AND_JOB_RUN_AS, les administrateurs de l’espace de travail ne peuvent créer des jetons d’accès personnels qu’au nom des responsables de service sur lesquels ils ont le rôle d’Utilisateur Principal du Service. Ils ne peuvent également modifier le propriétaire d’un travail que sur eux-mêmes. Et ils peuvent changer le poste run_as le cadre pour eux-mêmes ou pour un principal de service sur lequel ils ont le rôle d’Utilisateur Principal du Service.

Paramètres de l’espace de travail

Paramètres qui s’appliquent à un seul espace de travail.

Setting Nom de clé Description
Politique d’Intégration d’Accès du Tableau de Bord AI/BI aibi_dash_embed_ws_acc_policy Contrôle si l’intégration de tableau de bord publiée par l’IA/BI est activée, conditionnellement ou désactivée au niveau de l’espace de travail. Par défaut, ce paramètre est activé sous condition (ALLOW_APPROVED_DOMAINS).
Intégration des domaines approuvés par le tableau de bord IA/BI aibi_dash_embed_ws_apprvd_domains Contrôle la liste des domaines approuvés pour héberger les tableaux de bord IA/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 réglée sur ALLOW_APPROVED_DOMAINS.
Restreindre les champs OAuth des applications à des valeurs sélectionnées allowedAppsUserApiScopes Limitez les champs d’application OAuth que les développeurs d’applications peuvent demander lorsqu’ils agissent au nom des utilisateurs. Spécifiez une liste de longescopes autorisés, ou utilisez « * » pour autoriser tous les longinets pris en charge. Une liste vide désactive effectivement l’autorisation utilisateur pour les applications.
Mise à jour automatique du cluster automatic_cluster_update La mise à jour automatique de clusters veille à ce que tous les clusters d’un espace de travail soient périodiquement mis à jour vers les dernières mises à jour de sécurité et de l’image du système d’exploitation hôte. Les administrateurs de compte peuvent planifier la fréquence de la fenêtre de maintenance, la date de début et l’heure de début. S’applique au calcul classique (clusters, pools, entrepôts SQL classiques, service de modèle hérité) ; Cela ne s’applique pas au calcul serverless. Activer cette fonctionnalité ajoute l’extension Sécurité et Conformité Améliorées et nécessite le tarif Premium.
Plateformes de collaboration autorisées collaboration_platform_connectivity Contrôle quelles plateformes de collaboration externes (Slack et/ou Microsoft Teams) peuvent se connecter à cet espace de travail. Par défaut, c’est ALLOW_ALL.
Autoriser les messages publics sur les plateformes de collaboration collaboration_platform_message_visibility Une fois activé, les utilisateurs peuvent choisir si les réponses de l’application Databricks dans Slack ou Microsoft Teams sont visibles sur le canal. Une fois désactivées, toutes les réponses doivent rester privées pour l’utilisateur demandant.
Accès aux espaces de travail pour le personnel Databricks customerApprovedWSLoginExpirationTime Un moment précis après lequel le personnel Databricks ne peut plus se connecter à votre espace de travail. L’heure est formatée en YYYY-MM-DDTHH:MM:SSZ. Vous pouvez complètement désactiver l’accès en le mettant sur un horodatage dans le passé, comme 1998-01-01T00:00:00.000Z. Activez l’accès indéfiniment en utilisant une chaîne vide ou la valeur indefinitespéciale .
Espace de noms par défaut default_namespace_ws L’API de réglage par défaut de l’espace de noms permet aux utilisateurs de configurer l’espace de noms par défaut pour un espace de travail Databricks.
Désactiver l’accès hérité disable_legacy_access « Désactiver l’accès aux hérités » a les impacts suivants : 1. Désactive l’accès direct aux Métastores de Ruche depuis l’espace de travail (l’accès via la fédération des Métastores de Ruche n’est pas affecté). 2. Désactive le mode de repli pour l’accès à un emplacement externe depuis l’espace de travail. 3. Désactive Databricks Les versions d’exécution antérieures à la 13.3LTS. Important : ce paramètre ne peut pas être activé tant que le catalogue par défaut de l’espace de travail est défini sur un catalogue hérité (hive_metastore ou spark_catalog). Changez d’abord le catalogue par défaut en catalogue Unity.
Désactiver la racine DBFS et les points de montage disable_legacy_dbfs Désactiver le DBFS hérité a les deux implications suivantes : 1. L’accès aux montages racine et DBFS DBFS est interdit (ainsi que la création de nouveaux montages). 2. Désactive Databricks Les versions d’exécution antérieures à la 13.3LTS. Lorsque le paramètre est désactivé, toutes les fonctionnalités DBFS sont activées et aucune restriction n’est imposée aux versions d’exécution de Databricks. Ce réglage peut prendre jusqu’à 20 minutes pour s’appliquer et nécessite un redémarrage manuel des clusters de calcul polyvalents et des entrepôts SQL.
Activez les types de nœuds auto-flexibles enableAutoNodeTypeFlexibility Lorsqu’ils sont activés, les clusters de cet espace de travail peuvent se lancer automatiquement sur d’autres types de nœuds lorsque le type de nœud demandé n’est pas disponible, améliorant ainsi la fiabilité du lancement lors de pénuries de capacité.
Exportation de notebooks enableExportNotebook Contrôle si les utilisateurs peuvent exporter des blocs-notes et des fichiers à partir de l’interface utilisateur de l’espace de travail. Par défaut, ce paramètre est activé.
Fonctionnalités du tableau des résultats enableNotebookTableClipboard Contrôle la possibilité pour les utilisateurs de copier des données tabulaires des tables de résultats vers le presse-presse. Par défaut, ce paramètre est activé.
Téléchargement des résultats du carnet enableResultsDownloading Détermine si les utilisateurs peuvent télécharger les résultats du notebook. Par défaut, ce paramètre est activé.
Téléverser les données via l’interface utilisateur enableUploadDataUis Contrôle si les utilisateurs peuvent télécharger des données dans l’espace de travail via l’interface utilisateur. Ce paramètre ne contrôle pas les téléchargements vers les volumes du catalogue Unity, qui sont régis par les autorisations du catalogue unité.
Appliquer Unity Gateway enforce_ai_gateway_v3_only Contrôle si tout l’accès aux modèles de fondation doit passer par Unity Gateway. Une fois activés, les permissions d’accès au modèle, les budgets IA et les politiques de sécurité sont gérés de manière centralisée avec Unity Gateway, et tout le trafic du modèle de fondation doit passer par celle-ci. Le modèle de fondation hérité desservant les points de terminaison contournant la passerelle Unity rejette le trafic.
N’autoriser les déploiements d’applications que depuis Git enforceGitAppDeployments Une fois activées, les applications de cet espace de travail ne peuvent être déployées que depuis Git.
Fonctionnalités d’IA optimisées par les partenaires llm_proxy_partner_powered Détermine si les modèles alimentés par le partenaire sont activés ou non. Ce paramètre est disponible à la fois au niveau du compte et de l’espace de travail
Mission critique mission_critical Offre 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.
Autoriser les dépôts à exporter la sortie IPYNB reposIpynbResultsExportPermissions Contrôle si les utilisateurs peuvent valider les sorties des notebooks .ipynb dans des dépôts Git distants dans l’espace de travail.
Restreindre les administrateurs de l’espace de travail restrict_workspace_admins Le paramètre Restreindre les administrateurs d’espace de travail vous permet de contrôler les fonctionnalités des administrateurs d’espace de travail. Avec le statut de paramètre réglé sur ALLOW_ALL, les administrateurs de l’espace de travail peuvent créer des jetons d’accès personnels pour les principaux de service au nom de n’importe quel principal de service dans leur espace de travail. Les administrateurs d’espace de travail peuvent également modifier un propriétaire de travail en n’importe quel utilisateur de son espace de travail. Et ils peuvent modifier le paramètre de la tâche run_as pour n’importe quel utilisateur de leur espace de travail ou vers un principal de service sur lequel ils ont le rôle d’Utilisateur principal de service. Avec le statut de paramètre réglé sur RESTRICT_TOKENS_AND_JOB_RUN_AS, les administrateurs de l’espace de travail ne peuvent créer des jetons d’accès personnels qu’au nom des responsables de service sur lesquels ils ont le rôle d’Utilisateur Principal du Service. Ils ne peuvent également modifier le propriétaire d’un travail que sur eux-mêmes. Et ils peuvent changer le poste run_as le cadre pour eux-mêmes ou pour un principal de service sur lequel ils ont le rôle d’Utilisateur Principal du Service.
Profil de sécurité de conformité shield_csp_enablement_ws_db Contrôle si le profil de sécurité de conformité est activé pour cet espace de travail. Le profil de sécurité de conformité fournit une base de référence hautement sécurisée (surveillance supplémentaire, image de calcul renforcée, 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. Cette activation permet également une surveillance de sécurité renforcée et une mise à jour automatique du cluster sur l’espace de travail, et ajoute l’extension Sécurité et Conformité Renforcées.
Surveillance renforcée de la sécurité shield_esm_enablement_ws_db Contrôle si la surveillance de sécurité renforcée est activée pour cet espace de travail. La surveillance de sécurité renforcée fournit une image de calcul renforcée et des agents de surveillance de sécurité supplémentaires (surveillance de l’intégrité des fichiers, antivirus et analyse des vulnérabilités) qui génèrent des lignes de journaux vérifiables. Cela s’applique uniquement aux ressources classiques du plan de calcul, pas au serverless. Si le profil de sécurité de conformité est activé sur l’espace de travail, ce paramètre est appliqué de façon permanente.
Étiquette de l’espace de travail workspace_label Une étiquette personnalisée et un badge couleur affichés à côté du nom de l’espace de travail dans la navigation supérieure de la console Databricks. Les administrateurs d’espaces de travail peuvent utiliser ce paramètre pour distinguer visuellement les espaces de travail selon les environnements. La valeur est un objet avec un label champ (chaîne de texte) et un color champ (l’un des suivants : coral, lemon, lime, turquoiseindigo, , purple, ). pink Les deux champs sont des chaînes vides lorsqu’aucune étiquette n’est posée.

Préférences utilisateur

Paramètres qui s’appliquent à un utilisateur dans un compte.

Setting Nom de clé Description
Création automatique de session lors de l’interaction avec l’éditeur autoCreateSessionOnEditorInteraction Contrôle si une session est automatiquement créée lors de l’interaction avec l’éditeur.
Lancement et attache automatiques autoLaunchAndAttach Contrôle si les notebooks se lancent et se connectent automatiquement aux clusters.
Confirmer la commande Supprimer confirmCommandDelete Contrôle si une confirmation est requise avant de supprimer une commande.
Créer de nouveaux assets dans le dossier Brouillons createNewAssetsInDraftsFolder Contrôle si de nouveaux éléments sont créés dans le dossier brouillons.
Databricks Unified SQL Editor : créer et convertir des requêtes sur Open Pref databricks-unified-sql-editor-create-and-convert-queries-on-open-pref Contrôle le comportement de création et de conversion des requêtes dans l’éditeur SQL unifié.
Unité d’indentation Python par défaut defaultPythonIndentUnit Contrôle l’unité dent Python par défaut. Valeurs autorisées : 2, 4, ou « (chaîne vide par défaut).
Thème sombre personnalisé de l’éditeur editorCustomDarkTheme Contrôle le thème sombre personnalisé de l’éditeur. Valeurs autorisées : defaultTheme, Atom-One-Dark, Ayu-Dark, Blackboard, Dracula, GitHub-Dark, Monokai, One-Dark-Pro, . Winter-is-Coming-Dark
Thème de lumière personnalisé pour éditeur editorCustomLightTheme Contrôle le thème de lumière personnalisé pour l’éditeur. Valeurs autorisées : defaultTheme, , Active4DAtom-One-Light, Ayu-LightGitHub-LightTomorrow, , Winter-is-Coming-Light.
Taille de police de l’éditeur editorFontSize Contrôle la taille de la police dans l’éditeur. Valeurs autorisées : plage d’entiers de 10 à 30.
Activer la réparation rapide automatique en ligne enableAutoInlineQuickFix On peut automatiser des solutions rapides en ligne qui permettent de régler les solutions rapides.
Activer la solution rapide automatique en ligne Désinscription enableAutoInlineQuickFixOptOut Contrôle de désinscription pour des solutions rapides automatiques en ligne.
Activer le diagnostic automatique des déclencheurs enableAutoTriggerDiagnose Contrôle si les diagnostics sont automatiquement déclenchés.
Activer le diagnostic automatique des déclencheurs Désabonnement enableAutoTriggerDiagnoseOptOut Contrôle de désinscription pour les diagnostics automatiques.
Activez la disposition centrée enableCenteredLayout Contrôle si l’éditeur utilise une mise en page centrée.
Activer les raccourcis classiques enableClassicShortcuts Contrôle le mode raccourcis clavier. Valeurs autorisées : default, classic.
Activer les numéros de commande enableCommandNumbers Contrôle si les numéros de commande sont affichés dans les carnets.
Activez les complétions au fur et à mesure que vous tapez enableCompletionsAsYouType Contrôle si les suggestions d’autocomplétion apparaissent au moment de la saisie.
Activer le clignement du curseur enableCursorBlink Contrôle si le curseur clignote dans l’éditeur.
Activer le mode sombre enableDarkMode Contrôle le mode thème. Valeurs autorisées : light, dark, system.
Activer Entrer accepte les suggestions enableEnterAcceptsSuggestions Contrôle si appuyer sur Entrée accepte les suggestions d’autocomplétion.
Activer le survol pour l’éditeur enableHoverForEditor Contrôle si les infobulles survolent l’affichage dans l’éditeur.
Activez la suggestion en ligne en tapant votre désinscription enableInlineSuggestionAsYouTypeOptOut Désinscrivez-vous du contrôle pour les suggestions en ligne au fur et à mesure que vous écrivez.
Activer les numéros de ligne enableLineNumbers Contrôle si les numéros de ligne sont affichés dans l’éditeur.
Activer les numéros de ligne v2 enableLineNumbersV2 Contrôle si les numéros de ligne sont affichés dans l’éditeur (v2).
Activer le Line Wrap enableLineWrap Contrôle si le texte passe à la ligne suivante dans l’éditeur.
Activer le curseur multi Monaco enableMonacoMultiCursor Contrôle la touche modificatrice multi-curseurs. Valeurs autorisées : alt, ctrlCmd.
Activer la désactivation du débogueur du notebook enableNotebookDebuggerOptOut Contrôle de désabonnement pour le débogueur de notebook.
Activer le bouton d’observabilité sans serveur enableServerlessObservabilityToggle L’utilisateur s’inscrit pour une observabilité sans serveur améliorée dans les emplois lorsque l’aperçu de l’espace de travail est activé.
Activer les statistiques de Afficher la commande dans l’interface de la nouvelle cellule enableShowCommandStatsInNewCellUi Contrôle si les statistiques de commandes sont affichées dans la nouvelle interface de la cellule.
Activer les titres de cellules promus pour afficher enableShowPromotedCellTitles Contrôle l’affichage des titres de cellules promues.
Activez les devis intelligents enableSmartQuotes Contrôle si les devis intelligents sont activés dans l’éditeur.
Activez les onglets logiciels pour les carnets et fichiers enableSoftTabsForNotebooksAndFiles Contrôle si les tabulations sont converties en espaces dans les carnets et fichiers.
Activer la surlignage d’erreurs de syntaxe SQL enableSqlSyntaxErrorHighlighting Contrôle si les erreurs de syntaxe SQL sont mises en évidence.
Activer le passage en mode commande après l’exécution enableSwitchToCommandModeAfterExecution Contrôle si l’éditeur passe en mode commande après l’exécution de la cellule.
Activer l’Explorateur unifié d’arbre de fichiers enableUnifiedFileTreeExplorer Contrôle si l’explorateur d’arbre de fichiers unifié est activé.
Concentration enableUnifiedSchemaBrowserTreeExplorer Contrôle si l’explorateur d’arbre du navigateur de schémas unifié est activé.
Activer le moteur de rendu Vega Lite enableVegaLiteRenderer Contrôle si le rendu Vega-Lite est activé pour les visualisations.
Activer le moteur de rendu Vega Lite Désabonnement enableVegaLiteRendererOptOut Contrôle désapprouvé pour le moteur de rendu Vega-Lite.
Activer le balise d’aperçu du moteur de rendu Vega Lite enableVegaLiteRendererPreviewTag Contrôle si la balise de prévisualisation du Vega-Lite du moteur de rendu est affichée.
Panneau inférieur étendu extendedBottomPanel Contrôle si le panneau inférieur étendu est affiché.
Interface de surveillance des nouveaux pipelines de l’écoulement du lac lakeflowNewPipelinesMonitoringUi Contrôle si l’interface de surveillance des pipelines Lakeflow est activée.
Format d’exportation par défaut du notebook notebookDefaultExportFormat Contrôle le format d’export par défaut pour les notebooks. Valeurs autorisées : SOURCE, JUPYTER.
Mode raccourci à flèche d’option optionArrowShortcutMode Contrôle le comportement des raccourcis clavier Option+Flèches. Valeurs autorisées : navigate, move.
Création multifichiers Pipelines pipelinesMultifileAuthoring Contrôle si l’authoring multifichier est activé pour les pipelines.
Envoyer des notifications par email de commentaire sendCommentEmailNotifications Contrôle si les notifications par email sont envoyées pour les commentaires.
Afficher la mini-carte d’exécution de la cellule showCellExecutionMinimap Contrôle si la mini-carte d’exécution de la cellule est affichée.
Invite du panneau Afficher le pip vers l’environnement showPipToEnvironmentPanelPrompt Contrôle s’il faut afficher un pip au panneau d’environnement.
Conseiller Show Spark showSparkAdvisor Contrôle si les suggestions d’optimisation Spark sont affichées.
Conseils d’erreur pour afficher l’étincelle showSparkErrorTips Contrôle si des conseils utiles sont affichés pour les erreurs de Spark.
L’utilisateur active la mise en surbrillance d’erreur du format Python userActivatesPythonFormatErrorHighlighting Contrôle si les erreurs de mise en forme Python sont mises en évidence.
L’utilisateur active une erreur de syntaxe Python en surligne, se désinscrire userActivatesPythonSyntaxErrorHighlightingOptOut Contrôle de désinscription pour la surlignée d’erreur de syntaxe Python.
L’utilisateur active la vérification des types Python userActivatesPythonTypeChecking Contrôle si la vérification des types Python est activée.
L’utilisateur active la restauration d’instantanés userActivatesSnapshotRestore Contrôle si la fonctionnalité de restauration d’instantané est activée.
Limite par défaut de 1000 pour les nouvelles requêtes usqleDefaultQueryAutoLimit Contrôle la limite automatique par défaut pour les requêtes SQL dans l’éditeur.

Ressources additionnelles

  • Dernière mise à jour :