Databricks CLI-Befehle

Note

Diese Informationen gelten für die Databricks CLI-Version 0.205 und höhere Versionen. Die Databricks CLI befindet sich in der öffentlichen Vorschau.

Die Verwendung von Databricks CLI unterliegt der Datenbricks-Lizenz - und Databricks-Datenschutzerklärung, einschließlich der Bestimmungen zu Nutzungsdaten.

Dieser Artikel enthält Informationen zu verfügbaren Databricks CLI-Befehlen. Diese Informationen ergänzen die Befehlszeilenhilfe. Weitere Informationen zum Installieren und Verwenden der Databricks CLI finden Sie unter Installieren oder Aktualisieren der Databricks CLI und Was ist die Databricks CLI?.

Die Databricks CLI enthält die in den folgenden Tabellen aufgeführten Befehlsgruppen. Befehlsgruppen enthalten zusammengehörige Befehle, die auch Unterbefehle enthalten können. So geben Sie Verwendungs- und Syntaxinformationen für eine Befehlsgruppe, einen einzelnen Befehl oder einen Unterbefehl aus:

• databricks <command-group> -h
• databricks <command-group> <command-name> -h
• databricks <command-group> <command-name> <subcommand-name> -h

Viele CLI-Befehle sind Vorgängen zugeordnet, die in der REST-API-Referenz für Azure Databricks dokumentiert sind.

Arbeitsbereichsbefehle

Group	Beschreibung und Befehle
fs	Befehle zum Verwalten von Dateien und Dateisystem: cat, , cpls, , mkdirrm
git-credentials	Befehle zum Registrieren von persönlichen Zugriffstoken für Databricks zum Ausführen von Vorgängen im Namen des Benutzers: create, , deleteget, , listupdate
repos	Befehle, mit denen Benutzer ihre Git-Repositorys verwalten können: create, , deleteget, , listupdate get-permission-levels get-permissions set-permissions update-permissions
secrets	Befehle zum Verwalten von Geheimnissen, Geheimnisbereichen und Zugriffsberechtigungen: create-scope, delete-acl, delete-scopedelete-secretget-aclget-secret, list-acls, , list-scopes, , , list-secretsput-aclput-secret
workspace	Befehle zum Auflisten, Importieren, Exportieren und Löschen von Notebooks und Ordnern im Arbeitsbereich: delete, , exportexport-dir, get-status, import, import-dir, , listmkdirs get-permission-levels get-permissions set-permissions update-permissions

Berechnen von Befehlen

Group	Beschreibung und Befehle
Clusterrichtlinien	Befehle zum Steuern der Fähigkeit der Benutzer, Cluster basierend auf einer Reihe von Regeln zu konfigurieren: create, , deleteedit, , getlist get-permission-levels get-permissions set-permissions update-permissions
clusters	Befehle, mit denen Sie Cluster erstellen, starten, bearbeiten, auflisten, beenden und löschen können: change-owner, create, , delete, edit, events, getlist, , list-node-types, ,list-zonespermanent-deletepinresizerestartspark-versionsstartunpin get-permission-levels get-permissions set-permissions update-permissions
global-init-scripts	Befehle, mit denen Arbeitsbereichsadministratoren globale Initialisierungsskripts für ihren Arbeitsbereich konfigurieren können: create, , deleteget, , listupdate
Instanzpools	Befehle zum Erstellen, Bearbeiten, Löschen und Auflisten von Instanzpools mit einsatzbereiten Cloudinstanzen, wodurch die Start und automatische Skalierung für Cluster beschleunigt werden: create, , deleteedit, , getlist get-permission-levels get-permissions set-permissions update-permissions
Instanzprofile	Befehle, mit denen Administratoren Instanzprofile hinzufügen, auflisten und entfernen können, durch die Benutzer Cluster starten können: add edit list remove
Bibliotheken	Befehle zum Installieren, Deinstallieren und Abrufen des Status von Bibliotheken in einem Cluster: all-cluster-statuses cluster-status install uninstall
Richtlinienfamilien	Befehle zum Anzeigen verfügbarer Richtlinienfamilien: get, list

Befehle "Aufträge"

Group	Beschreibung und Befehle
jobs	Befehle zum Verwalten von Aufträgen: cancel-all-runs, cancel-run, create, deletedelete-runexport-rungetget-runget-run-outputlistlist-runsrepair-runresetrun-nowsubmitupdate get-permission-levels get-permissions set-permissions update-permissions

Lakeflow Spark Declarative Pipelines-Befehle

Group	Beschreibung und Befehle
pipelines	Befehle zum Erstellen, Bearbeiten, Löschen, Starten und Anzeigen von Details zu Pipelines: create, delete, , getget-update, list-pipeline-events, list-pipelines, list-updates, , , start-update, , stopupdate get-permission-levels get-permissions set-permissions update-permissions

Machine-Learning-Befehle

Group	Beschreibung und Befehle
experiments	Befehle für die Interaktion mit Experimenten, die die primäre Organisationseinheit in MLflow sind. Alle MLflow-Ausführungen gehören zu einem Experiment: create-experiment, create-run, , delete-experiment, delete-rundelete-runsdelete-tagget-by-nameget-experiment, get-historyget-runGetlist-artifactslist-experimentslog-batchlog-inputslog-metriclog-modellog-param, , restore-experimentrestore-runrestore-runssearch-experimentssearch-runsset-experiment-tagset-tagupdate-experimentupdate-run get-permission-levels get-permissions set-permissions update-permissions
Feature-Engineering	Befehle für die Interaktion mit Features im Databricks Feature Store, die eine zentrale Registrierung für Features bereitstellt, die in Ihren KI- und ML-Modellen verwendet werden. create-feature, , delete-featureget-feature, , list-featuresupdate-feature
Modellregistrierung	Befehle für die Arbeitsbereichsmodellregistrierung: approve-transition-request, create-comment, , create-model, create-model-versioncreate-transition-requestcreate-webhookdelete-commentdelete-model,delete-model-tagdelete-model-versiondelete-model-version-tagdelete-transition-requestdelete-webhookget-latest-versionsget-modelget-model-version, get-model-version-download-uri, , list-modelslist-transition-requestslist-webhooksreject-transition-requestrename-modelsearch-model-versionssearch-modelsset-model-tagset-model-version-tagtest-registry-webhooktransition-stageupdate-commentupdate-modelupdate-model-versionupdate-webhook get-permission-levels get-permissions set-permissions update-permissions

Echtzeitbereitstellungsbefehle

Group	Beschreibung und Befehle
Dienstendpunkte	Befehle zum Erstellen, Aktualisieren und Löschen von Endpunkten des Modells: build-logs, create, deleteexport-metricsgetlist, logs, , patch, , , putqueryupdate-config get-permission-levels get-permissions set-permissions update-permissions

Identitäts- und Zugriffsverwaltungsbefehle

Group	Beschreibung und Befehle
account	Befehle zum Verwalten von Databricks-Konten: Identität und Zugriff: access-control, groups, service-principals, users, workspace-assignment Unity-Katalog: metastore-assignments, metastoresstorage-credentials Einstellungen: ip-access-lists, , network-connectivitysettings Bereitstellung: credentials, encryption-keys, networks, private-access, storage, vpc-endpoints, workspaces Abrechnung: billable-usage, log-delivery OAuth: custom-app-integration, o-auth-published-apps, published-app-integrationservice-principal-secrets
auth	Befehle für die Authentifizierung: describe, , envlogin, , profilestoken
aktueller Benutzer	Befehle zum Abrufen von Informationen zu aktuell authentifizierten Benutzern oder Dienstprinzipalen: me
groups	Befehle für Gruppen, die die Identitätsverwaltung vereinfachen und das Zuweisen des Zugriffs auf Databricks-Arbeitsbereiche, -Daten und andere sicherungsfähige Objekte erleichtern: create, delete, get, , list, patch, update
permissions	Befehle zum Erstellen von Lese-, Schreib-, Bearbeitungs-, Aktualisierungs- und Verwaltungszugriff für verschiedene Benutzer auf verschiedenen Objekte und Endpunkte: get, setupdate get-permission-levels
Dienstprinzipale	Befehle für Identitäten für die Verwendung mit Aufträgen, automatisierten Tools und Systemen wie Skripts, Apps und CI/CD-Plattformen: create, delete, get, , list, patch, update
users	Befehle für Benutzeridentitäten, die von Databricks erkannt und durch E-Mail-Adressen dargestellt werden: create, delete, get, , list, patch, update get-permission-levels get-permissions set-permissions update-permissions

SQL-bezogene Befehle

Group	Beschreibung und Befehle
alerts	Befehle zum Ausführen von Vorgängen für Warnungen: create, , deleteget, , listupdate
Alerts-Legacy	Befehle zum Ausführen von Vorgängen bei veralteten Warnungen: create, , deleteget, , listupdate
Datenquellen	Befehle zum Erstellen neuer Abfrageobjekte: list
queries	Befehle zum Ausführen von Vorgängen für Abfragedefinitionen: create, delete, get, , list, restore, update
Abfragen-Legacy	Befehle zum Ausführen von Vorgängen für ältere Abfragedefinitionen: create, delete, get, , list, restore, update
Abfrageverlauf	Befehle für den Zugriff auf den Verlauf der Abfragen über SQL-Warehouses: list
Lagerhäuser	Befehle zum Verwalten von SQL-Warehouses, bei denen es sich um eine Computeressource handelt, mit der Sie SQL-Befehle für Datenobjekte in Databricks SQL ausführen können: create, delete, , editget, get-workspace-warehouse-config, list, set-workspace-warehouse-config, , startstop get-permission-levels get-permissions set-permissions update-permissions

Unity Catalog-Befehle

Group	Beschreibung und Befehle
Artifact-Allowlists	Befehle zum Verwalten von Positivlisten für Artefakte. In Databricks Runtime 13.3 und höher können Sie Bibliotheken und Initskripts zur Zulassungsliste in UC hinzufügen, damit Benutzer diese Artefakte für die Berechnung nutzen können, die mit dem Standardzugriffsmodus konfiguriert ist: get, update
catalogs	Befehle zum Verwalten von Katalogen, der ersten Ebene des dreistufigen Namespaces von Unity Catalog: create, , deleteget, , listupdate
Beglaubigungsschreiben	Befehle zum Verwalten von Anmeldeinformationen, die der Authentifizierungs- und Autorisierungsmechanismus für den Zugriff auf Dienste in Ihrem Cloudmandanten sind. Jede Anmeldeinformation unterliegt den Zugriffssteuerungsrichtlinien des Unity-Katalogs, die steuern, welche Benutzer und Gruppen auf die Anmeldeinformationen zugreifen können. create-credential, , delete-credentialgenerate-temporary-service-credential, get-credential, list-credentials, , update-credentialvalidate-credential
connections	Befehle zum Herstellen einer Verbindung mit einer externen Datenquelle: create, , deleteget, , listupdate
external-locations	Befehle zum Verwalten externer Speicherorte, die einen Cloudspeicherpfad mit Speicheranmeldeinformationen kombinieren, die den Zugriff auf den Cloudspeicherpfad autorisieren: create, , deleteget, , listupdate
functions	Befehle zum Verwalten von benutzerdefinierten Funktionen (UDFs) im Unity-Katalog : create, , deleteget, , listupdate
grants	Befehle zum Gewähren des Zugriffs auf Daten in Unity Catalog: get, get-effectiveupdate
Metastores	Befehle zum Verwalten von Metastores, die der Objektcontainer der obersten Ebene in Unity Catalog sind: assign, create, , currentdelete, get, list, summary, , , unassign, , updateupdate-assignment
Modellversionen	Befehle zum Verwalten von Modellversionen. Databricks stellt eine gehostete Version der MLflow-Modellregistrierung in Unity Catalog bereit. delete, , getget-by-alias, , listupdate
Onlinetabellen	Befehle zum Verwalten von Onlinetabellen, die eine niedrigere Latenz und einen höheren QPS-Zugriff auf Daten aus Deltatabellen bieten: create, deleteget
Qualitätsmonitore	Befehle zum Verwalten von Monitoren, die Daten- oder Modellqualitätsmetriken für eine Tabelle im Laufe der Zeit berechnen und überwachen: create, , deleteget, get-refresh, list-refreshes, , run-refreshupdate
registrierte Modelle	Befehle zum Verwalten registrierter Modelle. Databricks stellt eine gehostete Version der MLflow-Modellregistrierung in Unity Catalog bereit. create, , deletedelete-alias, get, list, , set-aliasupdate
Ressourcenkontingente	Befehle zum Verwalten von Ressourcenkontingenten, die vom Unity-Katalog für alle sicherungsfähigen Objekte erzwungen werden, wodurch die Anzahl der ressourcen begrenzt wird, die erstellt werden können. get-quota, list-quotas
schemas	Befehle zum Verwalten von Schemas, die die zweite Ebene des dreistufigen Namespaces von Unity Catalog sind: create, , deleteget, , listupdate
Speicheranmeldeinformationen	Befehle zum Verwalten von Speicheranmeldeinformationen, bei denen es sich um einen Authentifizierungs- und Autorisierungsmechanismus für den Zugriff auf Daten handelt, die in Ihrem Cloudmandanten gespeichert sind: create, delete, get, , list, update, validate
Systemschemas	Befehle zum Verwalten von Systemschemas, bei denen es sich um Schemas handelt, die sich im Systemkatalog befinden: disable, enablelist
Tabelleneinschränkungen	Befehle zum Verwalten von Primärschlüssel- und Fremdschlüsseleinschränkungen, die Beziehungen zwischen Feldern in Tabellen codieren: create, delete
tables	Befehle zum Verwalten von Tabellen, die sich auf der dritten Ebene des dreistufigen Namespaces von Unity Catalog befinden: delete, , existsget, , listlist-summaries
temporäre Tabellenanmeldeinformationen	Befehle zum Verwalten temporärer Tabellenanmeldeinformationen, das sind kurzlebige, eingeschränkte Anmeldeinformationen, die für den Zugriff auf Cloudspeicherorte verwendet werden, an denen Tabellendaten in Databricks gespeichert sind. generate-temporary-table-credentials
volumes	Befehle zum Verwalten von Volumes, bei denen es sich um eine UC-Funktion (Unity Catalog) für den Zugriff auf und das Speichern, Verwalten, Organisieren und Verarbeiten von Dateien handelt: create, , deletelist, , readupdate
Arbeitsbereichsbindungen	Befehle zum Verwalten sicherungsfähiger Arbeitsbereichsbindungen. Sicherungsfähige Objekte in Databricks können als OPEN oder ISOLATED konfiguriert werden. get get-bindings update update-bindings

Deltafreigabebefehle

Group	Beschreibung und Befehle
providers	Befehle zum Verwalten von Datenanbietern, die Organisationen darstellen, die Daten freigeben: create, delete, get, , list, list-shares, update
Empfängeraktivierung	Befehle zum Verwalten der Empfängeraktivierung, die nur im offenen Freigabemodell anwendbar ist, in dem das Empfängerobjekt den TOKEN-Authentifizierungstyp aufweist: get-activation-url-info, retrieve-token
recipients	Befehle zum Verwalten von Empfängern, die Sie mithilfe von :method:recipients/create erstellen, um eine Organisation zu repräsentieren, der Sie den Zugriff auf Freigaben erteilen möchten: create, delete, get, , list, rotate-token, update share-permissions
Aktien	Befehle zum Verwalten von Freigaben, bei denen es sich um Container handelt, die mit :method:shares/create instanziiert werden: create, delete, get, , list, list-shares, update share-permissions, update-permissions

Einstellungsbefehle

Group	Beschreibung und Befehle
IP-Zugriffslisten	Befehle zum Gestatten der Konfiguration von IP-Zugriffslisten durch Administratoren: create, delete, get, , list, replace, update
Benachrichtigungsziele	Befehle zum Verwalten der Benachrichtigungsziele eines Arbeitsbereichs: create, , deleteget, , listupdate
settings	Befehle zum Gestatten der Verwaltung von Einstellungen auf Arbeitsbereichsebene durch Benutzer: automatic-cluster-update, , csp-enablementdefault-namespace, , esm-enablementrestrict-workspace-admins
Tokenverwaltung	Befehle zum Gestatten des Abrufs aller Token und des Löschens von Token für andere Benutzer durch Administratoren: create-obo-token delete get list get-permission-levels get-permissions set-permissions update-permissions
Token	Befehle zum Erstellen, Auflisten und Widerrufen von Token, die zum Authentifizieren und Zugreifen auf Databricks-REST-APIs verwendet werden können: create, deletelist
workspace-conf	Befehle zum Aktualisieren der Arbeitsbereichseinstellungen: get-status, set-status

Befehle für Entwicklertools

Group	Beschreibung und Befehle
bundle	Befehle zum Verwalten von Databricks-Ressourcenbundles, mit denen Sie Ihre Databricks-Projekte als Code ausdrücken können: deploy, deployment, destroy, generate, init, open, plan, run, schema, summary, sync, validate
sync	Synchronisiert ein lokales Verzeichnis mit einem Arbeitsbereichsverzeichnis

Vektorsuchbefehle

Group	Beschreibung und Befehle
Vektorsuchendpunkte	Befehle zum Verwalten von Vektorsuchendpunkten, die die Computeressourcen zum Hosten von Vektorsuchindizes darstellen: create-endpoint delete-endpoint get-endpoint list-endpoints
Vektorsuchindizes	Befehle zum Verwalten von Vektorsuchindizes, einer effizienten Darstellung Ihrer Einbettungsvektoren, die Echtzeit- und effiziente ANN-Suchabfragen (Approximate Nearest Neighbor) unterstützen: create-index, , delete-data-vector-indexdelete-index, get-index, list-indexes, query-index, , sync-indexupsert-data-vector-index

Dashboardbefehle

Group	Beschreibung und Befehle
dashboards	Befehle zum Ändern von Legacy-Dashboards: create, delete, get, , list, restore, update
genie	Befehle zum Ändern von Genie, die eine codefreie Erfahrung für Geschäftsbenutzer bieten, die von AI/BI unterstützt werden: create-message, execute-message-attachment-query, get-message, , get-message-attachment-query-result, get-spaced, start-conversation
Lakeview	Befehle, die bestimmte Verwaltungsvorgänge für AI/BI-Dashboards bereitstellen: create, create-schedule, , create-subscription, delete-schedule, delete-subscriptiongetget-published, get-schedule, , get-subscriptionlistlist-scheduleslist-subscriptionsmigratepublishtrashunpublishupdateupdate-schedule

Marketplace-Befehle

Group	Beschreibung und Befehle
Verbrauchererfüllungen	Befehle zum Verwalten von Erfüllungen, also Einheiten, mit denen Verbraucher Installationen als Vorschau anzeigen lassen können. get, list
Consumer-Installationen	Befehle zum Verwalten von Installationen, bei denen es sich um Entitäten handelt, mit denen Verbraucher mit Databricks Marketplace-Einträgen interagieren können. create, , deletelist, , list-listing-installationsupdate
Verbraucherauflistungen	Befehle zum Verwalten von Databricks Marketplace-Verbraucherauflistungen: batch-get get list search
Consumer-Personalisierungsanforderungen	Befehle zum Verwalten von Personalisierungsanforderungen, mit denen Kunden mit dem individualisierten Marketplace-Eintragsfluss interagieren können. create, getlist
Consumeranbieter	Befehle zum Verwalten von Anbietern, bei denen es sich um entitäten handelt, die Einträge auf dem Marketplace veröffentlichen. batch-get, getlist
Anbieteraustauschfilter	Befehle zum Verwalten von Marketplace-Austausch-Filtern, die festlegen, welche Gruppen Zugriff auf einen Austausch haben. create delete list update
Anbieteraustausch	Befehle für die Verwaltung von Marketplace-Börsen, mit denen Anbieter ihre Angebote mit einer kuratierten Gruppe von Kunden teilen können. add-listing-to-exchange, create, , deletedelete-listing-from-exchange, get, list, list-exchanges-for-listing, , list-listings-for-exchangeupdate
Anbieterdateien	Befehle zum Verwalten von Marketplace-Dateien, z. B. Vorschaunotizbücher und Anbietersymbole. create delete get list
Anbieterauflistungen	Befehle zum Verwalten von Anbieterauflistungen: create, , deleteget, , listupdate
Anbieterpersonalisierungsanforderungen	Befehle zum Verwalten von Personalisierungsanforderungen, die eine Alternative zu sofort verfügbaren Einträgen sind. list, update
Provider-Provider-Analytics-Dashboards	Befehle zum Verwalten der vorlagenbasierten Analyse für Anbieter: create get get-latest-version update
Anbieteranbieter	Befehle zum Verwalten von Anbietern, die Objekte in Marketplace verwalten. create, , deleteget, , listupdate

Apps-Befehle

Group	Beschreibung und Befehle
apps	Befehle zum Verwalten von Databricks-Apps, die direkt auf Ihrer Databricks-Instanz ausgeführt werden, in Ihre Daten integrieren, Databricks-Dienste verwenden und erweitern und Benutzern die Interaktion über einmaliges Anmelden ermöglichen. create, delete, deploy, get, get-deployment, list, list-deployments, logs, run-local, start, stop, update

Befehle zur Raumreinigung

Group	Beschreibung und Befehle
Reinraumressourcen	Befehle zur Verwaltung von Reinraumressourcen, bei denen es sich um Daten- und Codeobjekte wie Tabellen, Speicherbereiche und Notizbücher handelt, die für den Reinraum freigegeben werden. create, , deleteget, , listupdate
Clean-Room-Task-Runs	Befehle zum Verwalten von Reinraumaufgabenausführungen, also die Ausführung von Notebooks in einem Reinraum. list
Clean-Rooms	Befehle zum Verwalten von Reinräumen. Clean Rooms verwenden Delta Sharing und serverlose Compute, um eine sichere und datenschutzgeschützte Umgebung bereitzustellen, in der mehrere Parteien an vertraulichen Unternehmensdaten zusammenarbeiten können, ohne direkten Zugriff auf die Daten der anderen zu haben. create, create-output-catalog, delete, , get, list, update

Datenbankbefehle

Group

Beschreibung und Befehle

Datenbank

Befehle zum Verwalten von Lakebase-Datenbankinstanzen. create-database-catalog, create-database-instance, create-database-table, create-synced-database-tabledelete-database-catalogdelete-database-instancedelete-database-tabledelete-synced-database-tablefind-database-instance-by-uidgenerate-database-credentialget-database-catalogget-database-instanceget-database-tableget-synced-database-tablelist-database-instancesupdate-database-instance

Zusätzliche Befehle

Group	Beschreibung und Befehle
api	Befehle zum Senden von Anforderungen an die Databricks-REST-API: delete, get, head, , patch, post, put
completion	Befehle zum Generieren des Autovervollständigungsskripts für die angegebene Shell: bash fish powershell zsh
configure	Konfiguriert die Databricks CLI
help	Geben Sie eine Zusammenfassung der Informationen für alle Databricks CLI-Befehle aus.
labs	Befehle zum Verwalten von Databricks Labs-Installationen: clear-cache, , installinstalled, list, show, , uninstallupgrade
version	Ruft die aktuell verwendete CLI-Version ab

Globale Kennzeichnungen

Die folgenden Flags sind für alle Databricks CLI-Befehle verfügbar. Beachten Sie, dass einige Flags für einige Befehle nicht gelten. Ausführliche Informationen zu bestimmten Befehlen und deren Flags finden Sie in der Befehlszeilenhilfe.

--debug

  Gibt an, ob die Debugprotokollierung aktiviert werden soll.

-h oder --help

    Hilfe für die Databricks CLI oder die zugehörige Befehlsgruppe oder den zugehörigen Befehl anzeigen.

--log-file Schnur

    Eine Zeichenfolge, die die Datei darstellt, in die Ausgabeprotokolle geschrieben werden sollen. Wenn dieses Flag nicht angegeben ist, werden Ausgabeprotokolle standardmäßig in stderr geschrieben.

--log-format Format

    Der Protokollformattyp text oder json. Der Standardwert ist text.

--log-level Schnur

    Eine Zeichenfolge, die die Protokollformatebene darstellt. Wenn nicht angegeben, ist die Protokollformatebene deaktiviert.

-o, --output Typ

    Der Befehlsausgabetyp text oder json. Der Standardwert ist text.

-p, --profile Schnur

    Der Name des Profils in der ~/.databrickscfg Datei, das zum Ausführen des Befehls verwendet werden soll. Wenn dieses Flag nicht angegeben ist, aber existiert, wird das Profil DEFAULT verwendet.

--progress-format Format

    Das Format zum Anzeigen von Statusprotokollen: default, , append, inplaceoder json

-t, --target Schnur

    Falls zutreffend, das zu verwendende Bündelziel