Grundlegende Nutzung der Databricks-CLI

Note

Diese Informationen gelten für Databricks CLI-Versionen 0.205 und höher. 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.

Auf dieser Seite erfahren Sie, wie Sie Databricks CLI-Befehlsgruppen und -Befehle auflisten, die Cli-Hilfe für Databricks anzeigen und mit der Cli-Ausgabe von Databricks arbeiten. Weitere Informationen finden Sie unter Was ist die Databricks-CLI?.

Informationen zum Installieren und Konfigurieren der Authentifizierung für die Databricks CLI finden Sie im Databricks CLI-Lernprogramm.

Auflisten verfügbarer CLI-Befehle

Um die verfügbaren CLI-Befehlsgruppen aufzulisten, verwenden Sie die --help oder -h Option, z. B.:

databricks -h

Wenn Sie die Befehle für eine beliebige Befehlsgruppe auflisten möchten, verwenden Sie die --help Oder-Option -h . So listen Sie beispielsweise die clusters-Befehle auf:

databricks clusters -h

Anzeigen der Hilfe zum CLI-Befehl

Um Verwendungsinformationen für einen Befehl anzuzeigen, verwenden Sie die Option --help oder die Option -h mit dem Befehl. So zeigen Sie beispielsweise die Hilfe für den Befehl clusters list an:

databricks clusters list -h

Eine Befehlsreferenz ist verfügbar. Weitere Informationen unter Databricks CLI-Befehle.

Ausführen eines Befehls

Vollständige Verwendungsinformationen und Syntax für einzelne Befehle finden Sie in der Befehlszeilenhilfe und -Referenz, aber Databricks CLI-Befehle entsprechen in der Regel der folgenden Syntax:

databricks <command-group> <command-name> <subcommand-name> [command-argument-value1] [--<flag1-name> <flag1-value>]

Nicht jeder Befehl verfügt über zusätzliche Unterbefehle. Globale Flags sind verfügbar, und einige Befehle verfügen über zusätzliche Flags. Beispielsweise gibt der folgende Befehl verfügbare Cluster mithilfe eines befehlsspezifischen Flags aus:

databricks clusters list --can-use-client JOBS

Tip

Sie können Databricks CLI-Befehle in einem Databricks-Arbeitsbereich mithilfe des Webterminals ausführen. Das Arbeitsbereich-Webterminal kann von vielen Benutzern auf einem Compute verwendet werden und erfordert nicht, dass Sie die Authentifizierung konfigurieren. Siehe Ausführen von Shellbefehlen im Azure Databricks-Webterminal.

JSON-Eingabe und -Ausgabe

Einige Databricks CLI-Befehle verfügen über ein --json Flag oder andere Optionen, die JSON-Zeichenfolgeneingaben akzeptieren. Darüber hinaus geben einige Befehle eine JSON-Zeichenfolge aus.

Zeichenfolgenformatierung

Das Format von JSON-Zeichenfolgen hängt vom Betriebssystem ab:

Linux oder macOS

Schließen Sie JSON-Zeichenfolgenparameter in doppelte Anführungszeichen ein und schließen Sie die gesamte JSON-Nutzlast in einfache Anführungszeichen ein. Beispiel:

'{"cluster_id": "1234-567890-abcde123"}'

'["20230323", "Amsterdam"]'

Windows

Schließen Sie JSON-Zeichenfolgenparameter und die gesamte JSON-Nutzlast in doppelte Anführungszeichen ein, und setzen Sie einen umgekehrten Schrägstrich vor die doppelten Anführungszeichen innerhalb der JSON-Nutzlast (\). Beispiel:

"{\"cluster_id\": \"1234-567890-abcde123\"}"

"[\"20230323\", \"Amsterdam\"]"

Festlegen von Feldern in einer JSON-Zeichenfolge

Mit dem --json Flag für viele Befehle können Sie Objektfelder festlegen, die möglicherweise nicht als CLI-Befehle oder -Optionen verfügbar sind. Mit dem folgenden Aufruf wird beispielsweise ein Benutzer mit der ID 9ddddddd-1eee-4eee-a666-8fff7c111111 zur Gruppe mit der ID 7eeeeeee-9ccc-4aaa-b777-1aaaaaaaaaahinzugefügt:

Linux oder macOS

databricks account groups patch 7eeeeeee-9ccc-4aaa-b777-1aaa2eeeee6f --json '{
  "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
  "Operations": [
    {
      "op": "add",
      "path": "members",
      "value": [
        {
        "value": "9ddddddd-1eee-4eee-a666-8fff7c111111"
        }
      ]
    }
  ]
}'

Windows

databricks account groups patch 7eeeeeee-9ccc-4aaa-b777-1aaa2eeeee6f --json "{
  \"schemas\": [\"urn:ietf:params:scim:api:messages:2.0:PatchOp\"],
  \"Operations\": [
    {
      \"op\": \"add\",
      \"path\": \"members\",
      \"value\": [
        {
            \"value\": \"9ddddddd-1eee-4eee-a666-8fff7c111111\"
        }
      ]
    }
  ]
}"

JSON-Ausgabe filtern mit jq

Für Databricks CLI-Befehle, die JSON ausgeben, können Sie den jq-Befehlszeilenprozessor verwenden, um die Ausgabe zu filtern. Wenn Sie beispielsweise nur den Anzeigenamen eines Azure Databricks-Clusters mit der angegebenen Cluster-ID auflisten möchten:

databricks clusters get 1234-567890-abcde123 | jq -r .cluster_name

My-11.3-LTS-Cluster

Sie können jq unter macOS mithilfe von Homebrew (brew install jq) oder unter Windows mithilfe von Chocolatey (choco install jq) installieren. Weitere Informationen zu jq finden Sie im Leitfaden zu jq.

Proxyserverkonfiguration

Um Databricks CLI-Anforderungen und -Antworten über einen Proxyserver weiterzuleiten, legen Sie die HTTPS_PROXY Umgebungsvariable auf dem Computer fest, auf dem die Databricks CLI auf der URL des Proxyservers installiert ist.

Informationen zum Festlegen von Umgebungsvariablen finden Sie in der Dokumentation Ihres Betriebssystems.