Freigeben über

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.

Artefakte

Type: Map

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

Artefakteinstellungen, die in der obersten Ebene der Paketkonfiguration definiert sind, können in der targets-Zuordnung überschrieben werden. Siehe Mit Zieleinstellungen überschreiben.

artifacts:
  <artifact-name>:
    <artifact-field-name>: <artifact-field-value>
Schlüssel Typ Beschreibung
build Zeichenfolge Ein optionaler Satz von Buildbefehlen, die vor der Bereitstellung lokal ausgeführt werden sollen.
dynamic_version Boolescher Wert Gibt an, ob die Wheel-Version dynamisch basierend auf dem Zeitstempel der WHL-Datei gepatcht werden soll. Wenn dies auf true festgelegt ist, kann neuer Code bereitgestellt werden, ohne die Version in setup.py oder pyproject.toml aktualisieren zu müssen. Diese Einstellung ist nur gültig, wenn type auf whl festgelegt ist. Siehe Artefakte.
executable Zeichenfolge Der ausführbare Typ. Gültige Werte sind bash, sh und cmd.
files Sequenz Der relative oder absolute Pfad zu den erstellten Artefaktdateien. Siehe Artefakte.name.files.
path Zeichenfolge Der lokale Pfad des Artefaktverzeichnisses.
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.

Beispiel

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

artifacts.name.files

Type: Sequence

Der relative oder absolute Pfad zu den erstellten Artefaktdateien.

Schlüssel Typ Beschreibung
source Zeichenfolge Erforderlich Die Artefaktquelldatei.

bundle

Type: Map

Paketattribute für Bereitstellungen in diesem Ziel.

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.
compute_id Zeichenfolge Veraltet. Zum Ausführen des Pakets zu verwendende Compute-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 Definition der Paketbereitstellung Unterstützte Attribute finden Sie unter Databricks Asset Bundle-Bereitstellungsmodi. Siehe bundle.deployment.
git Zuordnung Die Git-Versionskontrolldetails, die mit Ihrem Bundle verknüpft sind. Unterstützte Attribute finden Sie unter Git. Weitere Informationen finden Sie unter git.
name Zeichenfolge 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.

bundle.deployment

Type: Map

Definition der Paketbereitstellung

Schlüssel Typ Beschreibung
fail_on_active_runs Boolescher Wert Gibt an, ob aktive Ausführungen fehlschlagen sollen. Wenn dies auf "true" festgelegt ist, kann ein laufender Einsatz unterbrochen werden.
lock Zuordnung Bereitstellungssperrenattribute. Siehe bundle.deployment.lock.

bundle.deployment.lock

Type: Map

Bereitstellungssperrenattribute.

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

experimentell

Type: Map

Definiert Attribute für experimentelle Features.

Schlüssel Typ Beschreibung
python Zuordnung Veraltet. Verwenden Sie stattdessen die Python-Zuordnung der obersten Ebene.
python_wheel_wrapper Boolescher Wert Gibt an, ob ein Python-Wheel-Wrapper verwendet werden soll.
scripts Zuordnung Auszuführende Befehle.
use_legacy_run_as Boolescher Wert Gibt an, ob das veraltete run_as-Verhalten verwendet werden soll.

include

Type: Sequence

Gibt eine Liste von Pfad-Globs an, die Konfigurationsdateien enthalten, die in das Bundle eingeschlossen werden sollen. Siehe einschließen.

Berechtigungen

Type: Sequence

Eine Sequenz, die die Berechtigungen definiert, die für Ressourcen 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-Ressourcenpaketen.

Schlüssel Typ Beschreibung
group_name Zeichenfolge Name der Gruppe, für die die Berechtigung auf der Ebene aktiviert ist.
level Zeichenfolge Zulässige Berechtigung der für diese Berechtigung definierten Benutzer, Gruppe, Dienstprinzipale. Gültige Werte für diesen Schlüssel unterscheiden sich je nachdem, ob die Berechtigungen auf der obersten Ebene des Bündels oder für eine bestimmte Ressource definiert sind. Weitere Informationen finden Sie unter "Berechtigungen für Ressourcen in Databricks Asset Bundles festlegen".
service_principal_name Zeichenfolge Name des Dienstprinzipals, für den die Berechtigung auf dieser Ebene aktiviert ist.
user_name Zeichenfolge Name des Benutzers, für den die Berechtigung auf dieser Ebene aktiviert ist.

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

Type: Map

Definiert Voreinstellungen für die Paketbereitstellung Weitere Informationen finden Sie unter Benutzerdefinierte Voreinstellungen.

Schlüssel Typ Beschreibung
jobs_max_concurrent_runs Integer Maximale Anzahl gleichzeitiger Ausführungen eines Auftrags.
name_prefix Zeichenfolge Präfix für Auftragsausführungen des Pakets.
pipelines_development Boolescher Wert Gibt an, ob Pipelinebereitstellungen im Entwicklungsmodus gesperrt werden sollen.
source_linked_deployment Boolescher Wert Gibt an, ob die Bereitstellung mit der Paketquelle verknüpft werden soll.
tags Zuordnung Tags für die Paketbereitstellung.
trigger_pause_status Zeichenfolge Ein Pausenstatus, der auf alle Auftragsauslöser und -zeitpläne angewendet werden soll. Gültige Werte sind PAUSED und UNPAUSED.

Python

Type: Map

Konfiguriert das Laden von Python-Code, der mit dem Databricks-Bundles-Paket definiert ist. Weitere Informationen finden Sie unter Bundle-Konfiguration in Python.

Schlüssel Typ Beschreibung
mutators Sequenz Mutatoren enthalten eine Liste vollständig qualifizierter Funktionspfade von Mutatorfunktionen, z. B. [my_project.mutators:add_default_cluster].
resources Sequenz Ressourcen enthalten eine Liste der vollqualifizierten Funktionspfade zum Laden von Ressourcen, die im Python-Code definiert sind, z. B. ["my_project.resources:load_resources"]
venv_path Zeichenfolge Der Pfad zur virtuellen Umgebung. Wenn diese Option aktiviert ist, wird Python-Code in dieser Umgebung ausgeführt. Wenn deaktiviert, wird standardmäßig der Python-Interpreter verwendet, der in der aktuellen Shell verfügbar ist.

Ressourcen

Type: Map

Map-Objekt, das die Ressourcen für das Paket definiert. Dabei gibt jeder Schlüssel den Name der betreffenden Ressource an, während der Wert ein Map-Objekt ist, das die Ressource definiert. Weitere Informationen zu den von Databricks-Ressourcenpaketen unterstützten Ressourcen sowie eine Ressourcendefinitionsreferenz finden Sie unter Ressourcen für Databricks-Ressourcenpakete.

resources:
  <resource-type>:
    <resource-name>:
      <resource-field-name>: <resource-field-value>
Schlüssel Typ Beschreibung
alerts Zuordnung Die Warnungsdefinitionen (v2) für das Bundle, wobei jeder Schlüssel der Name der Warnung ist. Siehe Warnung.
apps Zuordnung Die Databricks-App-Definitionen für das Bundle, wobei jeder Schlüssel der Name der App ist. Weitere Informationen finden Sie unter app.
clusters Zuordnung Die Clusterdefinitionen für das Bundle, wobei jeder Schlüssel der Name eines Clusters ist Siehe Cluster.
dashboards Zuordnung Die Dashboarddefinitionen für das Bundle, wobei jeder Schlüssel der Name des Dashboards ist. Siehe Dashboard.
database_catalogs Zuordnung Die Datenbankkatalogdefinitionen für das Bundle, wobei jeder Schlüssel der Name des Datenbankkatalogs ist. Siehe database_catalog.
database-instances Zuordnung Die Datenbankinstanzdefinitionen für das Bundle, wobei jeder Schlüssel der Name der Datenbankinstanz ist. Siehe database_instance.
experiments Zuordnung Die Experimentdefinitionen für das Bündel, wobei jeder Schlüssel der Name des Experiments ist. Siehe Experiment.
jobs Zuordnung Die Auftragsdefinitionen für das Bundle, wobei jeder Schlüssel der Name des Auftrags ist Siehe job.
model_serving_endpoints Zuordnung Die Modellausführungs-Endpunktdefinitionen für das Bundle, wobei jeder Schlüssel der Name des Modellausführungsendpunkts ist. Siehe model_serving_endpoint.
models Zuordnung Die Modelldefinitionen für das Bundle, wobei jeder Schlüssel der Name des Modells ist. Siehe model (veraltet).
pipelines Zuordnung Die Pipelinedefinitionen für das Bundle, wobei jeder Schlüssel der Name der Pipeline ist Siehe Pipeline.
quality_monitors Zuordnung Die Definitionen der Qualitätsmonitore für das Bundle, wobei jeder Schlüssel der Name eines Qualitätsmonitors ist. Siehe quality_monitor (Unity-Katalog).
registered_models Zuordnung Die registrierten Modelldefinitionen für das Bundle, wobei jeder Schlüssel der Name des registrierten Unity Catalog-Modells ist. Siehe registered_model (Unity-Katalog).
schemas Zuordnung Die Schemadefinitionen für das Bundle, wobei jeder Schlüssel der Name des Schemas ist Siehe Schema (Unity-Katalog).
secret_scopes Zuordnung Die geheimen Bereichsdefinitionen für das Bundle, wobei jeder Schlüssel der Name des geheimen Bereichs ist. Siehe secret_scope.
sql_warehouses Zuordnung Die SQL Warehouse-Definitionen für das Bundle, wobei jeder Schlüssel der Name des SQL Warehouse ist. Siehe sql_warehouse.
synced_database_tables Zuordnung Die synchronisierten Datenbanktabellendefinitionen für das Bundle, wobei jeder Schlüssel der Name der Datenbanktabelle ist. Siehe synced_database_table.
volumes Zuordnung Volumedefinitionen für das Paket. Jeder Schlüssel gibt den Namen des Volumes an. Weitere Informationen finden Sie unter Volumen (Unity-Katalog).

run_as

Type: Map

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 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.

scripts

Type: Map

Die Skripts, die mit bundle runausgeführt werden können. Siehe Ausführen von Skripts.

scripts:
  <script-name>:
    <script-field-name>: <script-field-value>
Schlüssel Typ Beschreibung
content Zeichenfolge Auszuführende Befehle

Sync

Type: Map

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 außerhalb des Paketstamms befinden können und zum Synchronisieren mit dem Arbeitsbereich verwenden werden, wenn das Paket bereitgestellt wird.

Ziele

Type: Map

Definiert Bereitstellungsziele für das Bundle. Siehe targets.

targets:
  <target-name>:
    <target-field-name>: <target-field-value>
Schlüssel Typ Beschreibung
artifacts Zuordnung Artefakte, die in die Zielbereitstellung aufgenommen werden sollen. Siehe Artefakte.
bundle Zuordnung Paketattribute für Bereitstellungen in diesem Ziel. Siehe Bundle.
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 Boolescher Wert 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 Bereitstellungsmodus für das Ziel. Gültige Werte sind development und production. Siehe Bereitstellungsmodi für Databricks-Ressourcenbündel.
permissions Sequenz Berechtigungen für die Bereitstellung und Ausführung des Pakets im Ziel. Weitere Informationen finden Sie unter Berechtigungen.
presets Zuordnung Bereitstellungsvoreinstellungen für das Ziel. Siehe Voreinstellungen.
resources Zuordnung Die Ressourcendefinitionen für das Ziel. Siehe Ressourcen.
run_as Zuordnung Die Identität, die zum Ausführen des Bundles verwendet werden soll, finden Sie unter Angeben einer Ausführungsidentität für einen Databricks Asset Bundles-Workflow. Siehe run_as.
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. Siehe variables.
workspace Zuordnung Databricks-Arbeitsbereich für das Ziel. Siehe workspace.

Variablen

Type: Map

Definiert eine benutzerdefinierte Variable für das Bundle. Siehe variables.

variables:
  <variable-name>:
    <variable-field-name>: <variable-field-value>
Schlüssel Typ Beschreibung
default Beliebig Der Standardwert für die Variable.
description Zeichenfolge Die Variablenbeschreibung
lookup Zuordnung 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 Siehe Variablen.name.lookup.
type Zeichenfolge Der Typ der Variablen, einfach oder komplex. Legen Sie diesen Schlüssel nur fest, wenn die Variable komplex ist. Gültige Werte: complex.

variables.name.lookup

Type: Map

Der Name von Warnung, cluster_policy, Cluster, Dashboard, instance_pool, Auftrag, Metastore, Pipeline, Abfrage, service_principal oder Warehouse-Objekt, für die/den/das eine ID abgerufen werden soll. Informationen zur Verwendung von Lookup finden Sie unter Abrufen des ID-Werts eines Objekts.

Schlüssel Typ Beschreibung
alert Zeichenfolge Der Name der Warnung, für die eine ID abgerufen werden soll.
cluster Zeichenfolge Der Name des Clusters, für den eine ID abgerufen werden soll.
cluster_policy Zeichenfolge Der Name der cluster_policy, für die eine ID abgerufen werden soll.
dashboard Zeichenfolge Der Name des Dashboards, für das eine ID abgerufen werden soll.
instance_pool Zeichenfolge Der Name der instance_pool, für die eine ID abgerufen werden soll.
job Zeichenfolge Der Name des Auftrags, für den eine ID abgerufen werden soll.
metastore Zeichenfolge Der Name des Metastores, für den eine ID abgerufen werden soll.
notification_destination Zeichenfolge Der Name der notification_destination, für die eine ID abgerufen werden soll.
pipeline Zeichenfolge Name der Pipeline, für die eine ID abgerufen werden soll.
query Zeichenfolge Der Name der Abfrage, für die eine ID abgerufen werden soll.
service_principal Zeichenfolge Der Name des Service_Principal, für den eine ID abgerufen werden soll.
warehouse Zeichenfolge Der Name des Lagers, für das eine ID abgerufen werden soll.

Arbeitsbereich

Type: Map

Definiert den Databricks-Arbeitsbereich für das Bundle. Siehe workspace.

Schlüssel Typ Beschreibung
artifact_path Zeichenfolge Artefaktpfad, der im Arbeitsbereich für Bereitstellungen und für Workflowausführungen zu verwenden ist
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 Boolescher Wert 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 Dateipfad, der innerhalb des Arbeitsbereichs für Bereitstellungen und Workflows verwendet werden soll
google_service_account Zeichenfolge Der Name des Google-Dienstkontos
host Zeichenfolge Host-URL des Databricks-Arbeitsbereichs
profile Zeichenfolge Name des Databricks-Arbeitsbereichprofilnamens.
resource_path Zeichenfolge Ressourcenpfad des Arbeitsbereichs
root_path Zeichenfolge Der Stammpfad des Databricks-Arbeitsbereichs
state_path Zeichenfolge Der Arbeitsbereichsstatuspfad

Allgemeine Objekte

Git

Type: Map

Definiert Details zur Git-Versionssteuerung.

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