Konfigurationsreferenz

Dieser Artikel enthält eine Übersicht über Schlüssel, die von der Konfiguration der Databricks Asset Bundles (YAML) unterstützt werden. Weitere Informationen finden Sie unter Was sind Databricks-Ressourcenpakete?.

Vollständige Bundle-Beispiele finden Sie unter Bundle-Konfigurationsbeispiele und im GitHub-Repository bundle-examples.

Artefakt

Definiert die Einstellungen zum Erstellen eines Artefakts.

Schlüssel	Typ	Beschreibung
build	Zeichenfolge	Ein optionaler Satz von Buildbefehlen, die vor der Bereitstellung lokal ausgeführt werden sollen.
executable	Zeichenfolge	Der ausführbare Typ. Gültige Werte sind bash, sh und cmd.
files	Zuordnung	Der relative oder absolute Pfad zu den erstellten Artefaktdateien, die als artifact_filedefiniert sind.
path	Zeichenfolge	Der lokale Pfad des Verzeichnisses für das Artefakt.
type	Zeichenfolge	Erforderlich, wenn es sich bei dem Artefakt um ein Python-Rad handelt. Der Typ des Artefakts. Gültige Werte sind whl und jar.

Artefakte

Definiert die Attribute zum Erstellen von Artefakten, wobei jeder Schlüssel der Name des Artefakts und der Wert eine Map ist, die die Einstellungen für die Erstellung der Artefakte definiert. Informationen zur artifacts-Zuordnung finden Sie unter Artefakte.

Artefakteinstellungen, die auf der obersten Ebene der Bundlekonfiguration definiert sind, können in der targets-Zuordnung überschrieben werden. Weitere Informationen finden Sie unter Definieren von Artefakteinstellungen in Databricks-Ressourcenbundles.

artifacts:
  <artifact-name>:
      <artifact-field-name>: <artifact-field-value>

Beispiel

artifacts:
  default:
    type: whl
    build: poetry build
    path: .

artifact_file

Definiert eine Artefakt-Datei in einem Bundle

Schlüssel	Typ	Beschreibung
source	Zeichenfolge	Erforderlich Die Artefaktquelldatei.

Bundle

Die Attribute des Bundles Weitere Informationen finden Sie unter Bundle.

Schlüssel	Typ	Beschreibung
cluster_id	Zeichenfolge	Die ID eines Clusters, der zum Ausführen des Bundles verwendet werden soll. Weitere Informationen finden Sie unter cluster_id.
databricks_cli_version	Zeichenfolge	Die Databricks CLI-Version, die für das Bundle verwendet werden soll. Weitere Informationen finden Sie unter databricks_cli_version.
deployment	Zuordnung	Die Definition der Bundlebereitstellung Unterstützte Attribute finden Sie unter Bereitstellung und Bereitstellungsmodi für Databricks-Ressourcenbundle.
git	Zuordnung	Die Git-Versionskontrolldetails, die mit Ihrem Bundle verknüpft sind. Unterstützte Attribute finden Sie unter git und git.
name	Zeichenfolge	Erforderlich Der Name des Bundles
uuid	Zeichenfolge	Reserviert Ein eindeutiger Bezeichner (UUID) für das Bundle, der das Bundle in internen Databricks-Systemen eindeutig identifiziert. Dieser wird generiert, wenn ein Bundle-Projekt mithilfe einer Databricks-Vorlage (mithilfe des Befehls databricks bundle init) initialisiert wird.

Bereitstellung

Definiert Bundlelbereitstellungsattribute

Schlüssel	Typ	Beschreibung
fail_on_active_runs	Boolean	Gibt an, ob bei aktiven Ausführungen ein Fehler auftritt. Wenn dies auf true gesetzt ist, kann eine laufende Bereitstellung unterbrochen werden.
lock	Zuordnung	Die Attribute der Bereitstellungssperre Weitere Informationen finden Sie unter Sperre.

experimentell

Definiert Attribute für experimentelle Features.

Schlüssel	Typ	Beschreibung
python_wheel_wrapper	Boolean	Ob ein Python-Wheel-Wrapper verwendet werden soll
scripts	Befehl (Zeichenfolge)	Auszuführende Befehle
use_legacy_run_as	Boolean	Gibt an, ob das Legacy-Run_As-Verhalten verwendet werden soll

Git

Definiert die Git-Versionssteuerungsdetails, die dem Bundle zugeordnet sind. Weitere Informationen finden Sie unter git.

Schlüssel	Typ	Beschreibung
origin_url	Zeichenfolge	Die Ursprungs-URL des Repositorys. Weitere Informationen finden Sie unter git.
branch	Zeichenfolge	Der Git-Branchname Weitere Informationen finden Sie unter Git.

Zuweisung

Definiert den Zugriff auf Unity-Katalogobjekte. Weitere Informationen finden Sie unter Herstellen einer Verbindung mit Cloudobjektspeichern und -diensten mithilfe von Unity Catalog.

Schlüssel	Typ	Beschreibung
principal	Zeichenfolge	Erforderlich Der Name des Prinzipals, dem Berechtigungen erteilt werden
privileges	Zeichenfolge	Erforderlich Die Berechtigungen, die der angegebenen Entität gewährt werden sollen.

Beispiel

Im folgenden Beispiel wird ein Unity-Katalogschema mit Zuweisungen definiert:

resources:
  schemas:
    my_schema:
      name: test-schema
      grants:
        - principal: users
          privileges:
            - CAN_MANAGE
        - principal: my_team
          privileges:
            - CAN_READ
      catalog_name: main
      comment: "my schema with grants"

Sperre

Definiert die Sperrattribute der Bundlebereitstellung

Schlüssel	Typ	Beschreibung
enabled	Boolean	Gibt an, ob diese Sperre aktiviert ist.
force	Boolean	Gibt an, ob diese Sperre erzwungen werden soll, wenn sie aktiviert ist.

Berechtigung

Definiert eine Berechtigung für eine bestimmte Entität Weitere Informationen finden Sie unter Berechtigungen und Festlegen von Berechtigungen für Ressourcen in Databricks-Ressourcenbundles.

Schlüssel	Typ	Beschreibung
group_name	Zeichenfolge	Der Name der Gruppe, für die die Berechtigung in level festgelegt ist
level	Zeichenfolge	Erforderlich Die zulässige Berechtigung für Benutzende, Gruppe, Dienstprinzipal, der für diese Berechtigung definiert ist
service_principal_name	Zeichenfolge	Der Name des Dienstprinzipals, der die Berechtigung in level festgelegt hat.
user_name	Zeichenfolge	Der Name des Benutzers, dem die Berechtigung in levelzugewiesen ist.

Berechtigungen

Eine Sequenz, die die Berechtigungen definiert, die für Experimente, Aufträge, Pipelines und Modelle gelten sollen, die im Bundle definiert sind, wobei jedes Element in der Sequenz eine Berechtigung für eine bestimmte Entität ist.

Weitere Informationen finden Sie unter Berechtigungen und Festlegen von Berechtigungen für Ressourcen in Databricks-Ressourcenbundles.

Beispiel

permissions:
  - level: CAN_VIEW
    group_name: test-group
  - level: CAN_MANAGE
    user_name: someone@example.com
  - level: CAN_RUN
    service_principal_name: 123456-abcdef

Voreinstellungen

Definiert die Voreinstellungen der Bundlebereitstellung Weitere Informationen finden Sie unter Benutzerdefinierte Voreinstellungen.

Schlüssel	Typ	Beschreibung
jobs_max_concurrent_runs	Integer	Die maximalen gleichzeitigen Ausführungen für einen Auftrag
name_prefix	Zeichenfolge	Das Präfix für Auftragsausführungen des Bundles
pipelines_development	Boolesch	Gibt an, ob Pipelinebereitstellungen im Entwicklungsmodus gesperrt werden sollen
source_linked_deployment	Boolesch	Gibt an, ob die Bereitstellung mit der Bundlequelle verknüpft werden soll.
tags	Zuordnung	Die Tags für die Bereitstellung des Bundles
trigger_pause_status	Zeichenfolge	Ein Pausenstatus, der auf alle Auftragsauslöser und -zeitpläne angewendet werden soll. Gültige Werte sind PAUSED und UNPAUSED.

Ressourcen

Eine Zuordnung, die die Ressourcen für das Bundle definiert, wobei jeder Schlüssel der Name der Ressource ist und jeder Wert eine Zuordnung, die die Ressource definiert Weitere Informationen zu unterstützten Ressourcen und Ressourcendefinitionsreferenzen für Databricks-Ressourcenbundles finden Sie unter Ressourcen zu Databricks-Ressourcenbundles.

resources:
  <resource-type>s:
    <resource-name>:
      <resource-field-name>: <resource-field-value>

Schlüssel	Typ	Beschreibung
clusters	Zuordnung	Die Clusterdefinitionen für das Bundle, wobei jeder Schlüssel der Name eines Clusters ist Weitere Informationen finden Sie unter Cluster.
dashboards	Zuordnung	Die Dashboarddefinitionen für das Bundle, wobei jeder Schlüssel der Name des Dashboards ist. Weitere Informationen finden Sie unter Dashboard.
experiments	Zuordnung	Die Experimentdefinitionen für das Bündel, wobei jeder Schlüssel der Name des Experiments ist. Weitere Informationen finden Sie unter Experiment.
jobs	Zuordnung	Die Auftragsdefinitionen für das Bundle, wobei jeder Schlüssel der Name des Auftrags ist Weitere Informationen finden Sie unter Auftrag.
model_serving_endpoints	Zuordnung	Die Modellausführungs-Endpunktdefinitionen für das Bundle, wobei jeder Schlüssel der Name des Modellausführungsendpunkts ist. Weitere Informationen finden Sie unter model_serving_endpoint.
models	Zuordnung	Die Modelldefinitionen für das Bundle, wobei jeder Schlüssel der Name des Modells ist. Siehe Modell (alt)
pipelines	Zuordnung	Die Pipelinedefinitionen für das Bundle, wobei jeder Schlüssel der Name der Pipeline ist Weitere Informationen finden Sie unter Pipeline.
quality_monitors	Zuordnung	Die Definitionen der Qualitätsmonitore für das Bundle, wobei jeder Schlüssel der Name eines Qualitätsmonitors ist. Weitere Informationen finden Sie unter quality_monitor (Unity Catalog).
registered_models	Zuordnung	Die registrierten Modelldefinitionen für das Bundle, wobei jeder Schlüssel der Name des registrierten Unity Catalog-Modells ist. Weitere Informationen finden Sie unter registered_model (Unity-Katalog).
schemas	Zuordnung	Die Schemadefinitionen für das Bundle, wobei jeder Schlüssel der Name des Schemas ist Weitere Informationen finden Sie unter Schema (Unity Catalog).
volumes	Zuordnung	Die Volumedefinitionen für das Bundle, wobei jeder Schlüssel der Name des Volumes ist Weitere Informationen finden Sie unter Volumen (Unity-Katalog).

run_as

Die Identität, die beim Ausführen von Databricks-Ressourcenbundle-Workflows verwendet werden soll. Weitere Informationen finden Sie unter Angeben einer Ausführungsidentität für einen Databricks-Ressourcenbundle-Workflow.

Schlüssel	Typ	Beschreibung
service_principal_name	Zeichenfolge	Die Anwendungs-ID eines aktiven Dienstprinzipals Das Festlegen dieses Felds erfordert die Rolle servicePrincipal/user.
user_name	Zeichenfolge	Die E-Mail-Adresse eines aktiven Arbeitsbereichsbenutzers. Benutzer, die keine Administratoren sind, können dieses Feld nur auf ihre eigene E-Mail-Adresse festlegen.

Sync

Die Dateien und Dateipfade, die in das Bundle eingeschlossen oder davon ausgeschlossen werden sollen. Weitere Informationen finden Sie unter Sync.

Schlüssel	Typ	Beschreibung
exclude	Sequenz	Eine Liste von Dateien oder Ordnern, die vom Bundle ausgeschlossen werden sollen.
include	Sequenz	Eine Liste der Dateien oder Ordner, die in das Bundle aufgenommen werden sollen.
paths	Sequenz	Lokale Ordnerpfade, die sich möglicherweise außerhalb des Bundlestamms befinden, um beim Bereitstellen des Bundles mit dem Arbeitsbereich synchronisiert zu werden

Ziel

Definiert Bereitstellungsziele für das Bundle. Weitere Informationen finden Sie unter Ziele.

Schlüssel	Typ	Beschreibung
artifacts	Zuordnung	Die Artefakte, die in die Zielbereitstellung einbezogen werden sollen Weitere Informationen finden Sie unter Artefakte.
bundle	Zuordnung	Die Bundleattribute beim Bereitstellen für dieses Ziel
cluster_id	Zeichenfolge	Die ID des Clusters, der für dieses Ziel verwendet werden soll.
compute_id	Zeichenfolge	Veraltet Die ID des Computes, der für dieses Ziel verwendet werden soll.
default	Boolean	Gibt an, ob es sich bei diesem Ziel um das Standardziel handelt.
git	Zuordnung	Die Git-Versionssteuerungseinstellungen für das Ziel Weitere Informationen finden Sie unter git.
mode	Zeichenfolge	Der Bereitstellungsmodus für das Ziel Gültige Werte sind development und production. Weitere Informationen finden Sie unter Bereitstellungsmodi für Databricks-Ressourcenbundle.
permissions	Sequenz	Die Berechtigungen für die Bereitstellung und Ausführung des Bundles im Ziel Weitere Informationen finden Sie unter Berechtigungen.
presets	Zuordnung	Die Bereitstellungsvoreinstellungen für das Ziel Weitere Informationen finden Sie unter Voreinstellungen.
resources	Zuordnung	Die Ressourcendefinitionen für das Ziel. Weitere Informationen finden Sie unter Ressourcen.
run_as	Zuordnung	Die Identität, die zum Ausführen des Bundles verwendet werden soll. Weitere Informationen finden Sie unter run_as und Angeben einer Ausführungsidentität für einen Databricks Ressourcenbundle-Workflow.
sync	Zuordnung	Die lokalen Pfade, die mit dem Zielarbeitsbereich synchronisiert werden sollen, wenn ein Bundle ausgeführt oder bereitgestellt wird. Weitere Informationen finden Sie unter Sync.
variables	Zuordnung	Die benutzerdefinierten Variablendefinitionen für das Ziel. Weitere Informationen finden Sie unter Variablen und Ersetzungen und Variablen in Databricks-Ressourcenbundles.
workspace	Zuordnung	Der Databricks-Arbeitsbereich für das Ziel Arbeitsbereich

Variablen

Eine Abbildung, die die benutzerdefinierten Variablen für das Bündel definiert, wobei jeder Schlüssel der Name der Variablen ist und der Wert eine Abbildung, die die Variable definiert. Weitere Informationen finden Sie unter Ersetzungen und Variablen in Databricks-Ressourcenbundles.

Schlüssel	Typ	Beschreibung
variable-name	Zuordnung	Die Definition einer Variablen. Weitere Informationen finden Sie unter variable-name.

variable-name

Jede Variablendefinition weist die folgenden Attribute auf:

Schlüssel	Typ	Beschreibung
description	Zeichenfolge	Die Variablenbeschreibung
lookup	Zeichenfolge	Der Name des Objekts alert, cluster_policy, cluster, dashboard, instance_pool, job, metastore, pipeline, query, service_principal oder warehouse, für das eine ID abgerufen werden soll
type	Zeichenfolge	Der Typ der Variablen Gültige Werte sind complex.

Arbeitsbereich

Definiert den Databricks-Arbeitsbereich für das Bundle. Weitere Informationen finden Sie unter Arbeitsbereich.

Schlüssel	Typ	Beschreibung
artifact_path	Zeichenfolge	Der Artefaktpfad, der innerhalb des Arbeitsbereichs für Bereitstellungen und Workflowausführungen verwendet werden soll
auth_type	Zeichenfolge	Der Authentifizierungstyp
azure_client_id	Zeichenfolge	Die Azure Client-ID
azure_environment	Zeichenfolge	Die Azure-Umgebung
azure_login_app_id	Zeichenfolge	Die Azure Anmelde-App-ID
azure_tenant_id	Zeichenfolge	Die Azure Mandanten-ID
azure_use_msi	Boolean	Gibt an, ob MSI für Azure verwendet werden soll.
azure_workspace_resource_id	Zeichenfolge	Die Ressourcen-ID des Azure-Arbeitsbereichs
client_id	Zeichenfolge	Die Client-ID für den Arbeitsbereich
file_path	Zeichenfolge	Der im Arbeitsbereich zu verwendende Dateipfad für sowohl Bereitstellungen als auch Workflow-Abläufe.
google_service_account	Zeichenfolge	Der Name des Google-Dienstkontos
host	Zeichenfolge	Die Host-URL des Databricks-Arbeitsbereichs
profile	Zeichenfolge	Der Profilname des Databricks-Arbeitsbereichs
resource_path	Zeichenfolge	{WORKSPACE_RESOURCE_PATH}
root_path	Zeichenfolge	Der Stammpfad des Databricks-Arbeitsbereichs
state_path	Zeichenfolge	Der Statuspfad des Arbeitsbereichs