Yapılandırma referansı

Bu makale, Databricks Varlık Paketleri yapılandırması (YAML) tarafından desteklenen anahtarlar için bir referans sağlar. Bkz. Databricks Varlık Paketleri nedir?.

Tam paket örnekleri için bkz. Paket yapılandırma örnekleri ve paket örnekleri GitHub deposu.

Yapı

Type: Map

Yapıt oluşturmak için öznitelikleri tanımlar; burada her anahtar yapıtın adıdır ve değer yapıt derleme ayarlarını tanımlayan bir Eşlem'dir. artifacts eşlemesi hakkında bilgi için artefaktlarınabakın.

Paket yapılandırmasının en üst düzeyinde tanımlanan yapıt ayarları, targets eşlemesinde geçersiz kılınabilir. Hedef ayarlarla geçersiz kılma ifadesine bakın.

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

Anahtar	Tür	Açıklama
build	Dize	Dağıtımdan önce yerel olarak çalıştırılacak isteğe bağlı bir derleme komutları kümesi.
dynamic_version	Boolyen	Whl dosyasının zaman damgasına göre wheel sürümünü dinamik olarak yama yapmak. Bu true olarak ayarlanırsa, setup.py veya pyproject.toml'de sürümü güncelleştirmek zorunda kalmadan yeni kod dağıtılabilir. Ayar yalnızca typewhl olarak ayarlandığında geçerlidir. Bkz. yapıtları.
executable	Dize	Yürütülebilir dosya türü. Geçerli değerler bash, shve cmd.
files	Sıra	Oluşturulmuş artifakt dosyalarının göreli veya mutlak yolu. Bkz: yapıtlar.name.files.
path	Dize	Yapıtın dizininin yerel yolu.
type	Dize	Yapıt bir Python tekerleğiyse gereklidir. Yapıtın türü. Geçerli değerler: whl ve jar.

Örnek

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

Yapı. name.files

Type: Sequence

Oluşturulmuş artifakt dosyalarının göreli veya mutlak yolu.

Anahtar	Tür	Açıklama
source	Dize	Gerekli. Yapıt kaynak dosyası.

paket

Type: Map

Bu hedefe dağıtım yapılırken paket özellikleri.

Anahtar	Tür	Açıklama
cluster_id	Dize	Paketi çalıştırmak için kullanılacak kümenin kimliği. Bkz. cluster_id.
compute_id	Dize	Kullanım dışı. Paketi çalıştırmak için kullanılacak hesaplama biriminin kimliği.
databricks_cli_version	Dize	Paket için kullanılacak Databricks CLI sürümü. bkz. databricks_cli_version.
deployment	Harita	Paket dağıtımının tanımı. Desteklenen öznitelikler için bkz. Databricks Varlık Paketi dağıtım modları. Bkz. bundle.deployment.
git	Harita	Paketinizle ilişkili Git sürüm denetimi ayrıntıları. Desteklenen öznitelikler için bkz. git. Bkz. git.
name	Dize	Paketin adı.
uuid	Dize	Rezerve Edildi Databricks sistemlerinin içindeki paketi benzersiz bir şekilde tanımlayan paket için Evrensel Benzersiz Tanımlayıcı (UUID). Bu, bir paket projesi Databricks şablonu (databricks bundle init komutu kullanılarak) kullanılarak başlatıldığında oluşturulur.

paket.dağıtımı

Type: Map

Paket dağıtımının tanımı

Anahtar	Tür	Açıklama
fail_on_active_runs	Boolyen	Aktif çalıştırmalarda başarısız olup olmayacağı. Eğer bu doğru olarak ayarlanırsa, çalışmakta olan bir dağıtım kesilebilir.
lock	Harita	Dağıtım kilidi öznitelikleri. Bkz bundle.deployment.lock.

paket.kurulum.kilit

Type: Map

Dağıtım kilidi öznitelikleri.

Anahtar	Tür	Açıklama
enabled	Boolyen	Bu kilidin etkinleştirilip etkinleştirilmediği.
force	Boolyen	Bu kilidin etkinleştirilmişse zorlanıp zorlanmayacağı.

Deneysel

Type: Map

Deneysel özelliklerin özniteliklerini tanımlar.

Anahtar	Tür	Açıklama
python	Harita	Kullanım dışı. Bunun yerine en üst düzey python eşlemesini kullanın.
python_wheel_wrapper	Boolyen	Python tekerlek sarmalayıcının kullanılıp kullanılmaymayacağı.
scripts	Harita	Çalıştırılacak komutlar.
use_legacy_run_as	Boolyen	Eski run_as davranışının kullanılıp kullanılmaymayacağı.

içermek

Type: Sequence

Pakete eklenecek yapılandırma dosyalarını içeren yol globlarının listesini belirtir. Bkz. ekleme.

izinler

Type: Sequence

Pakette tanımlanan kaynaklara uygulanacak izinleri tanımlayan bir Sıra, burada dizideki her öğe belirli bir varlık için bir izindir.

Bakınız izinleri ve Databricks Varlık Paketleri'nde kaynaklar için izinleri ayarlama .

Anahtar	Tür	Açıklama
group_name	Dize	İzin düzeyi ayarlanmış olan grubun adı.
level	Dize	Bu izin, kullanıcı, grup ve hizmet sorumlusu için tanımlanan yetkilendirmeleri kapsamaktadır. Bu anahtar için geçerli değerler, izinlerin paketin en üst düzeyinde mi yoksa belirli bir kaynak için mi tanımlandığına bağlı olarak farklılık gösterir. Bkz. Databricks Varlık Paketlerindeki kaynaklar için izinleri ayarlama.
service_principal_name	Dize	Düzeyinde ayarlanmış izni olan hizmet sorumlusunun adı.
user_name	Dize	Düzeyinde ayarlanmış izinlere sahip olan kullanıcının adı.

Örnek

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

Önayarları

Type: Map

Paket dağıtım ön ayarlarını tanımlar. Bkz. Özel ön ayarlar.

Anahtar	Tür	Açıklama
jobs_max_concurrent_runs	Tam sayı	Bir iş için maksimum eşzamanlı çalıştırma sayısı.
name_prefix	Dize	paketin iş yürütmeleri için ön ek.
pipelines_development	Boolyen	İşlem hattı dağıtımlarının geliştirme modunda kilitlenmesi gerekip gerekmediği.
source_linked_deployment	Boolyen	Dağıtımın paket kaynağına bağlanıp bağlanmayacağı.
tags	Harita	Paket dağıtımının etiketleri.
trigger_pause_status	Dize	Tüm iş tetikleyicilerine ve zamanlamalarına uygulanacak duraklatma durumu. Geçerli değerler PAUSED veya UNPAUSED'dir.

piton

Type: Map

databricks-bundles paketiyle tanımlanan Python kodunun yüklenmesini yapılandırılır. Daha fazla bilgi için bkz . Python'da paket yapılandırması.

Anahtar	Tür	Açıklama
mutators	Sıra	Mutators, [my_project.mutators:add_default_cluster] gibi mutator işlevlerine yönelik tam niteleyici işlev yollarının bir listesini içerir.
resources	Sıra	Kaynaklar, Python kodunda tanımlanan kaynakları yüklemek için tam işlev yollarının bir listesini içerir, örneğin ["my_project.resources:load_resources"]
venv_path	Dize	Sanal ortamın yolu. Etkinleştirilirse Python kodu bu ortamda yürütülür. Devre dışı bırakılırsa varsayılan olarak geçerli kabukta bulunan Python yorumlayıcısını kullanır.

Kaynaklar

Type: Map

Paket için kaynakları tanımlayan bir Harita; burada her anahtar kaynağın adını, her değer ise kaynağı tanımlayan bir Harita içerir. Databricks Varlık Paketleri tarafından desteklenen kaynaklar ve kaynak tanımı rehberi hakkında daha fazla bilgi için bkz. Databricks Varlık Paketleri kaynakları.

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

Anahtar	Tür	Açıklama
alerts	Harita	Paket için uyarı (v2) tanımlarıdır ve burada her anahtar uyarının adıdır. Uyarıya bakın.
apps	Harita	Paketin Databricks uygulama tanımları; burada her anahtar uygulamanın adıdır. Bkz. uygulama.
clusters	Harita	Paketin küme tanımları; burada her anahtar bir kümenin adıdır. Bkz. küme.
dashboards	Harita	Paketin pano tanımları; burada her anahtar panonun adıdır. Bakınız gösterge paneli.
database_catalogs	Harita	Paketin veritabanı kataloğu tanımları; burada her anahtar veritabanı kataloğunun adıdır. Bkz. database_catalog.
database-instances	Harita	Her anahtarın veritabanı örneğinin adı olduğu paket için veritabanı örneği tanımları. Bkz. database_instance.
experiments	Harita	Paketin deneme tanımları; burada her anahtar denemenin adıdır. Bakınız deneme.
jobs	Harita	Paketin iş tanımları; burada her anahtar işin adıdır. İşe bakın.
model_serving_endpoints	Harita	Paket için uç nokta tanımlarını sunan model; burada her anahtar uç noktaya hizmet veren modelin adıdır. bkz. model_serving_endpoint.
models	Harita	Paketin model tanımları; burada her anahtar modelin adıdır. Bkz. model (eski).
pipelines	Harita	Her anahtarın işlem hattının adı olduğu paket için işlem hattı tanımları. Bkz. işlem hattı.
quality_monitors	Harita	Paketin kalite izleyici tanımları; burada her anahtar kalite izleyicisinin adıdır. Bkz. quality_monitor (Unity Kataloğu).
registered_models	Harita	Paketin kayıtlı model tanımları; burada her anahtar Unity Kataloğu kayıtlı modelinin adıdır. Bkz. registered_model (Unity Kataloğu).
schemas	Harita	Paketin şema tanımları; burada her anahtar şemanın adıdır. Bkz. şeması (Unity Kataloğu).
secret_scopes	Harita	Paketin gizli dizi kapsamı tanımlarıdır ve burada her anahtar gizli dizi kapsamının adıdır. Bkz. secret_scope.
sql_warehouses	Harita	Paketin SQL ambar tanımları; burada her anahtar SQL ambarının adıdır. Bkz. sql_warehouse.
synced_database_tables	Harita	Paket için eşitlenmiş veritabanı tablosu tanımları; burada her anahtar veritabanı tablosunun adıdır. Bkz. synced_database_table.
volumes	Harita	Paketin birim tanımları; burada her anahtar birimin adıdır. Bkz. cilt (Unity Kataloğu).

run_as

Type: Map

Databricks Varlık Paketleri iş akışlarını çalıştırırken kullanılacak kimlik. bkz. Databricks Varlık Paketleri iş akışıiçin çalıştırma kimliği belirtme.

Anahtar	Tür	Açıklama
service_principal_name	Dize	Etkin hizmet sorumlusunun uygulama kimliği. Bu alanın ayarlanması için servicePrincipal/user rolü gerekir.
user_name	Dize	Etkin çalışma alanı kullanıcısının e-posta adresi. Yönetici olmayan kullanıcılar bu alanı yalnızca kendi e-postalarına ayarlayabilir.

Komut dosyaları

Type: Map

bundle run kullanılarak çalıştırılabilecek betikler. Bkz. Betikleri yürütme.

scripts:
  <script-name>:
    <script-field-name>: <script-field-value>

Anahtar	Tür	Açıklama
content	Dize	Çalıştırılacak komutlar

Eşitleme

Type: Map

Pakete eklenecek veya hariç tutulacak dosyalar ve dosya yolları. Bkz. eşitleme .

Anahtar	Tür	Açıklama
exclude	Sıra	Paket dışında tutulacak dosya veya klasörlerin listesi.
include	Sıra	Pakete eklenecek dosya veya klasörlerin listesi.
paths	Sıra	Paket dağıtıldığında çalışma alanıyla senkronize edilecek, paket kökü dışında olabilen yerel klasör yolları.

Hedef

Type: Map

Paket için dağıtım hedeflerini tanımlar. Bkz. hedefleri

targets:
  <target-name>:
    <target-field-name>: <target-field-value>

Anahtar	Tür	Açıklama
artifacts	Harita	Hedef dağıtıma eklenecek unsurlar. Bkz. yapıtları.
bundle	Harita	Bu hedefe dağıtım yapılırken paket özellikleri. Bkz. paket.
cluster_id	Dize	Bu hedef için kullanılacak kümenin kimliği.
compute_id	Dize	Kullanım dışı. Bu hedef için kullanılacak hesaplama biriminin kimliği.
default	Boolyen	Bu hedefin varsayılan hedef olup olmadığı.
git	Harita	Hedef için Git sürüm denetimi ayarları. Bkz. git.
mode	Dize	Hedefin dağıtım modu. Geçerli değerler development veya production. Bkz. Databricks Varlık Paketi dağıtım modları.
permissions	Sıra	Paketi hedefte dağıtma ve çalıştırma izinleri. Bkz. izinler.
presets	Harita	Hedef için dağıtım ön ayarları. Ön ayarlara bakın.
resources	Harita	Hedef için kaynak tanımları. Kaynaklara bakın.
run_as	Harita	Paketi çalıştırmak için kullanılacak kimlik, bkz. Databricks Varlık Paketleri iş akışı için çalıştırılacak kimliği belirtme. Bkz. run_as.
sync	Harita	Bir paket çalıştırıldığında veya dağıtıldığında hedef çalışma alanıyla senkronize edilecek yerel yollar. Bkz. eşitleme .
variables	Harita	Hedef için özel değişken tanımları. Bkz . değişkenler.
workspace	Harita	Hedef için Databricks çalışma alanı. Bkz. çalışma alanı.

Değişken

Type: Map

Paket için özel bir değişken tanımlar. Bkz . değişkenler.

variables:
  <variable-name>:
    <variable-field-name>: <variable-field-value>

Anahtar	Tür	Açıklama
default	Herhangi biri	Değişkenin varsayılan değeri.
description	Dize	Değişkenin açıklaması.
lookup	Harita	Kimliği alınacak alert, cluster_policy, cluster, dashboard, instance_pool, job, metastore, pipeline, query, service_principalveya warehouse nesnesinin adı. Bkz. değişkenler.name.lookup.
type	Dize	Değişkenin türü, basit veya karmaşık. Bu anahtarı yalnızca değişken karmaşıksa ayarlayın. Geçerli değerler: complex.

Değişken. name.lookup

Type: Map

Kimliğinin alınacağı uyarı, cluster_policy, küme, pano, instance_pool, iş, meta veri deposu, işlem hattı, sorgu, service_principal veya ambar nesnesinin adı. Arama kullanma hakkında bilgi için bkz. Nesnenin kimlik değerini alma.

Anahtar	Tür	Açıklama
alert	Dize	Kimliği alınacak uyarının adı.
cluster	Dize	Kimlik alınacak kümenin adı.
cluster_policy	Dize	cluster_policy için ID'si alınacak olan ad.
dashboard	Dize	Kimliğinin alınacağı panonun adı.
instance_pool	Dize	Kimlik alınacak instance_pool adı.
job	Dize	Kimliği alınacak işin adı.
metastore	Dize	Kimliği alınacak meta veri deposunun adı.
notification_destination	Dize	Kimlik alınması gereken notification_destination'ın adı.
pipeline	Dize	Kimlik alınacak işlem hattının adı.
query	Dize	Kimlik alınacak sorgunun adı.
service_principal	Dize	ID alınacak olan service_principal adı.
warehouse	Dize	Kimlik alınacak ambarın adı.

çalışma alanı

Type: Map

Paket için Databricks çalışma alanını tanımlar. Bkz. çalışma alanı.

Anahtar	Tür	Açıklama
artifact_path	Dize	Hem dağıtımlar hem de iş akışı çalıştırmaları için çalışma alanında kullanılacak dosya yolu
auth_type	Dize	Kimlik doğrulama türü.
azure_client_id	Dize	Azure istemci kimliği
azure_environment	Dize	Azure ortamı
azure_login_app_id	Dize	Azure oturum açma uygulaması kimliği
azure_tenant_id	Dize	Azure kiracı kimliği
azure_use_msi	Boolyen	Azure için MSI kullanılıp kullanılmaymayacağı
azure_workspace_resource_id	Dize	Azure çalışma alanı kaynak kimliği
client_id	Dize	Çalışma alanının istemci kimliği
file_path	Dize	Hem dağıtımlar hem de iş akışı çalıştırmaları için çalışma alanında kullanılacak dosya yolu
google_service_account	Dize	Google hizmet hesabı adı
host	Dize	Databricks çalışma alanı ana bilgisayar URL'si
profile	Dize	Databricks çalışma alanı profil adı
resource_path	Dize	Çalışma alanı kaynak yolu
root_path	Dize	Databricks çalışma alanı kök yolu
state_path	Dize	Çalışma alanı durum yolu

Ortak nesneler

Git

Type: Map

Git sürüm denetimi ayrıntılarını tanımlar.

Anahtar	Tür	Açıklama
branch	Dize	Git şube adı Bkz. git.
origin_url	Dize	Deponun kaynak URL'si. Bkz. git.