apps_settings

Creates, updates, deletes, gets or lists an apps_settings resource.

Overview

Name	apps_settings
Type	Resource
Id	databricks_workspace.apps.apps_settings

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string
creator	string
description	string	The description of the template.
git_provider	string	The Git provider of the template.
git_repo	string	The Git repository URL that the template resides in.
▶manifest	object	The manifest of the template. It defines fields and default values when installing the template.
path	string	The path to the template within the Git repository.

list

Name	Datatype	Description
name	string
creator	string
description	string	The description of the template.
git_provider	string	The Git provider of the template.
git_repo	string	The Git repository URL that the template resides in.
▶manifest	object	The manifest of the template. It defines fields and default values when installing the template.
path	string	The path to the template within the Git repository.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	name, deployment_name		Gets the custom template with the specified name.
list	select	deployment_name	page_size, page_token	Lists all custom templates in the workspace.
create	insert	deployment_name, template		Creates a custom template.
replace	replace	name, deployment_name, template		Updates the custom template with the specified name. Note that the template name cannot be updated.
delete	delete	name, deployment_name		Deletes the custom template with the specified name.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
deployment_name	string	The Databricks Workspace Deployment Name (default: dbc-abcd0123-a1bc)
name	string	The name of the custom template.
page_size	integer	Upper bound for items returned.
page_token	string	Pagination token to go to the next page of custom templates. Requests first page if absent.

SELECT examples

get

Gets the custom template with the specified name.

SELECT
name,
creator,
description,
git_provider,
git_repo,
manifest,
path
FROM databricks_workspace.apps.apps_settings
WHERE name = '{{ name }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
;

list

Lists all custom templates in the workspace.

SELECT
name,
creator,
description,
git_provider,
git_repo,
manifest,
path
FROM databricks_workspace.apps.apps_settings
WHERE deployment_name = '{{ deployment_name }}' -- required
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;

INSERT examples

create

Creates a custom template.

INSERT INTO databricks_workspace.apps.apps_settings (
template,
deployment_name
)
SELECT 
'{{ template }}' /* required */,
'{{ deployment_name }}'
RETURNING
name,
creator,
description,
git_provider,
git_repo,
manifest,
path
;

Manifest

# Description fields are for documentation purposes
- name: apps_settings
props:
  - name: deployment_name
    value: "{{ deployment_name }}"
    description: Required parameter for the apps_settings resource.
  - name: template
    description: |
      :returns: :class:`CustomTemplate`
    value:
      name: "{{ name }}"
      git_repo: "{{ git_repo }}"
      path: "{{ path }}"
      manifest:
        version: {{ version }}
        name: "{{ name }}"
        description: "{{ description }}"
        resource_specs:
          - name: "{{ name }}"
            description: "{{ description }}"
            experiment_spec:
              permission: "{{ permission }}"
            job_spec:
              permission: "{{ permission }}"
            secret_spec:
              permission: "{{ permission }}"
            serving_endpoint_spec:
              permission: "{{ permission }}"
            sql_warehouse_spec:
              permission: "{{ permission }}"
            uc_securable_spec:
              securable_type: "{{ securable_type }}"
              permission: "{{ permission }}"
      git_provider: "{{ git_provider }}"
      creator: "{{ creator }}"
      description: "{{ description }}"

REPLACE examples

replace

Updates the custom template with the specified name. Note that the template name cannot be updated.

REPLACE databricks_workspace.apps.apps_settings
SET 
template = '{{ template }}'
WHERE 
name = '{{ name }}' --required
AND deployment_name = '{{ deployment_name }}' --required
AND template = '{{ template }}' --required
RETURNING
name,
creator,
description,
git_provider,
git_repo,
manifest,
path;

DELETE examples

delete

Deletes the custom template with the specified name.

DELETE FROM databricks_workspace.apps.apps_settings
WHERE name = '{{ name }}' --required
AND deployment_name = '{{ deployment_name }}' --required
;