App
laktory.models.resources.databricks.App
¤
Bases: AppBase
Databricks App
Examples:
import io
from laktory import models
app_yaml = '''
name: stocks-dash
description: A dashboard app for visualizing stock prices.
resources:
- name: sql-warehouse
sql_warehouse:
id: warehouse_id
permission: CAN_USE
access_controls:
- group_name: account users
permission_level: CAN_USE
'''
app = models.resources.databricks.App.model_validate_yaml(io.StringIO(app_yaml))
References
| BASE | DESCRIPTION |
|---|---|
budget_policy_id
|
The Budget Policy ID set for this resource
TYPE:
|
compute_max_instances
|
TYPE:
|
compute_min_instances
|
TYPE:
|
compute_size
|
A string specifying compute size for the App. Possible values are
TYPE:
|
description
|
The description of the resource
TYPE:
|
git_repository
|
Git repository configuration.
TYPE:
|
name
|
The name of the app to grant permission on
TYPE:
|
no_compute
|
TYPE:
|
provider_config
|
TYPE:
|
resources
|
A list of resources that the app has access to.
TYPE:
|
space
|
TYPE:
|
telemetry_export_destinations
|
Telemetry export destinations.
TYPE:
|
usage_policy_id
|
The Usage Policy ID set for this resource
TYPE:
|
user_api_scopes
|
A list of api scopes granted to the user access token. See REST API docs for full list of supported scopes
TYPE:
|
| LAKTORY | DESCRIPTION |
|---|---|
access_controls
|
Access controls list
TYPE:
|
name_prefix
|
Prefix added to the app name
TYPE:
|
name_suffix
|
Suffix added to the app name
TYPE:
|
| ATTRIBUTE | DESCRIPTION |
|---|---|
additional_core_resources |
TYPE:
|
additional_core_resources
property
¤
- permissions
laktory.models.resources.databricks.app.AppGitRepository
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
provider
|
Git provider (e.g. gitHub).
TYPE:
|
url
|
URL of the Git repository.
TYPE:
|
laktory.models.resources.databricks.app.AppProviderConfig
¤
laktory.models.resources.databricks.app.AppResource
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
app
|
App resource reference.
TYPE:
|
database
|
Database resource reference.
TYPE:
|
description
|
Description of the resource.
TYPE:
|
experiment
|
MLflow experiment resource reference.
TYPE:
|
genie_space
|
Genie space resource reference.
TYPE:
|
job
|
Databricks job resource reference.
TYPE:
|
name
|
Name used to refer to this resource inside the app.
TYPE:
|
postgres
|
Postgres resource reference.
TYPE:
|
secret
|
Secret resource reference.
TYPE:
|
serving_endpoint
|
Serving endpoint resource reference.
TYPE:
|
sql_warehouse
|
SQL warehouse resource reference.
TYPE:
|
uc_securable
|
Unity Catalog securable resource reference.
TYPE:
|
laktory.models.resources.databricks.app.AppResourceApp
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
name
|
Name of the app resource.
TYPE:
|
permission
|
Permission to grant.
TYPE:
|
laktory.models.resources.databricks.app.AppResourceDatabase
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
database_name
|
Name of the database.
TYPE:
|
instance_name
|
Name of the database instance.
TYPE:
|
permission
|
Permission to grant.
TYPE:
|
laktory.models.resources.databricks.app.AppResourceExperiment
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
experiment_id
|
ID of the MLflow experiment.
TYPE:
|
permission
|
Permission to grant.
TYPE:
|
laktory.models.resources.databricks.app.AppResourceGenieSpace
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
name
|
Name of the Genie space.
TYPE:
|
permission
|
Permission to grant.
TYPE:
|
space_id
|
ID of the Genie space.
TYPE:
|
laktory.models.resources.databricks.app.AppResourceJob
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
id
|
ID of the Databricks job.
TYPE:
|
permission
|
Permission to grant.
TYPE:
|
laktory.models.resources.databricks.app.AppResourcePostgres
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
branch
|
Branch name.
TYPE:
|
database
|
Database name.
TYPE:
|
permission
|
Permission to grant.
TYPE:
|
laktory.models.resources.databricks.app.AppResourceSecret
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
key
|
Secret key.
TYPE:
|
permission
|
Permission to grant.
TYPE:
|
scope
|
Secret scope.
TYPE:
|
laktory.models.resources.databricks.app.AppResourceServingEndpoint
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
name
|
Name of the serving endpoint.
TYPE:
|
permission
|
Permission to grant.
TYPE:
|
laktory.models.resources.databricks.app.AppResourceSqlWarehouse
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
id
|
ID of the SQL warehouse.
TYPE:
|
permission
|
Permission to grant.
TYPE:
|
laktory.models.resources.databricks.app.AppResourceUcSecurable
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
permission
|
Permission to grant.
TYPE:
|
securable_full_name
|
Full name of the UC securable.
TYPE:
|
securable_type
|
Type of the UC securable.
TYPE:
|
laktory.models.resources.databricks.app.AppResources
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
app
|
TYPE:
|
database
|
The resource path of a specific database within the branch to grant permission on (e.g.
TYPE:
|
description
|
The description of the resource
TYPE:
|
experiment
|
TYPE:
|
genie_space
|
TYPE:
|
job
|
TYPE:
|
name
|
The name of the app to grant permission on
TYPE:
|
postgres
|
TYPE:
|
secret
|
TYPE:
|
serving_endpoint
|
TYPE:
|
sql_warehouse
|
TYPE:
|
uc_securable
|
TYPE:
|
laktory.models.resources.databricks.app.AppResourcesApp
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
name
|
The name of the app to grant permission on
TYPE:
|
permission
|
Permission to grant on the experiment. Supported permissions are:
TYPE:
|
laktory.models.resources.databricks.app.AppResourcesDatabase
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
database_name
|
The name of database
TYPE:
|
instance_name
|
The name of database instance
TYPE:
|
permission
|
Permission to grant on the experiment. Supported permissions are:
TYPE:
|
laktory.models.resources.databricks.app.AppResourcesExperiment
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
experiment_id
|
The ID of the MLflow experiment to grant permission on
TYPE:
|
permission
|
Permission to grant on the experiment. Supported permissions are:
TYPE:
|
laktory.models.resources.databricks.app.AppResourcesGenieSpace
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
name
|
The name of the app to grant permission on
TYPE:
|
permission
|
Permission to grant on the experiment. Supported permissions are:
TYPE:
|
space_id
|
The unique ID of Genie Space. *
TYPE:
|
laktory.models.resources.databricks.app.AppResourcesJob
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
id
|
The unique identifier of the app. *
TYPE:
|
permission
|
Permission to grant on the experiment. Supported permissions are:
TYPE:
|
laktory.models.resources.databricks.app.AppResourcesPostgres
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
branch
|
The resource path of the Lakebase Autoscaling branch to grant permission on (e.g.
TYPE:
|
database
|
The resource path of a specific database within the branch to grant permission on (e.g.
TYPE:
|
permission
|
Permission to grant on the experiment. Supported permissions are:
TYPE:
|
laktory.models.resources.databricks.app.AppResourcesSecret
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
key
|
Key of the secret to grant permission on
TYPE:
|
permission
|
Permission to grant on the experiment. Supported permissions are:
TYPE:
|
scope
|
Scope of the secret to grant permission on
TYPE:
|
laktory.models.resources.databricks.app.AppResourcesServingEndpoint
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
name
|
The name of the app to grant permission on
TYPE:
|
permission
|
Permission to grant on the experiment. Supported permissions are:
TYPE:
|
laktory.models.resources.databricks.app.AppResourcesSqlWarehouse
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
id
|
The unique identifier of the app. *
TYPE:
|
permission
|
Permission to grant on the experiment. Supported permissions are:
TYPE:
|
laktory.models.resources.databricks.app.AppResourcesUcSecurable
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
permission
|
Permission to grant on the experiment. Supported permissions are:
TYPE:
|
securable_full_name
|
The full name of UC securable, i.e.
TYPE:
|
securable_type
|
The type of UC securable. Supported values are
TYPE:
|
laktory.models.resources.databricks.app.AppTelemetryExportDestination
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
unity_catalog
|
Unity Catalog telemetry destination.
TYPE:
|
laktory.models.resources.databricks.app.AppTelemetryExportDestinationUnityCatalog
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
logs_table
|
Full name of the Unity Catalog table for logs.
TYPE:
|
metrics_table
|
Full name of the Unity Catalog table for metrics.
TYPE:
|
traces_table
|
Full name of the Unity Catalog table for traces.
TYPE:
|
laktory.models.resources.databricks.app.AppTelemetryExportDestinations
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
unity_catalog
|
TYPE:
|
laktory.models.resources.databricks.app.AppTelemetryExportDestinationsUnityCatalog
¤
Bases: BaseModel
| PARAMETER | DESCRIPTION |
|---|---|
logs_table
|
Full name of the Unity Catalog table for OpenTelemetry logs
TYPE:
|
metrics_table
|
Full name of the Unity Catalog table for OpenTelemetry metrics
TYPE:
|
traces_table
|
Full name of the Unity Catalog table for OpenTelemetry traces (spans)
TYPE:
|