app_updates

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

Overview

Name	app_updates
Type	Resource
Id	databricks_workspace.apps.app_updates

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
budget_policy_id	string
usage_policy_id	string
compute_size	string	Create a collection of name/value pairs.<br /><br />Example enumeration:<br /><br />&gt;&gt;&gt; class Color(Enum):<br />... RED = 1<br />... BLUE = 2<br />... GREEN = 3<br /><br />Access them by:<br /><br />- attribute access::<br /><br />&gt;&gt;&gt; Color.RED<br />&lt;Color.RED: 1&gt;<br /><br />- value lookup:<br /><br />&gt;&gt;&gt; Color(1)<br />&lt;Color.RED: 1&gt;<br /><br />- name lookup:<br /><br />&gt;&gt;&gt; Color['RED']<br />&lt;Color.RED: 1&gt;<br /><br />Enumerations can be iterated over, and know how many members they have:<br /><br />&gt;&gt;&gt; len(Color)<br />3<br /><br />&gt;&gt;&gt; list(Color)<br />[&lt;Color.RED: 1&gt;, &lt;Color.BLUE: 2&gt;, &lt;Color.GREEN: 3&gt;]<br /><br />Methods can be added to enumerations, and members can have their own<br />attributes -- see the documentation for details. (LARGE, MEDIUM)
description	string
▶git_repository	object	Git repository configuration specifying the location of the repository.
▶resources	array
▶status	object
user_api_scopes	array

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	app_name, deployment_name		Gets the status of an app update.
create	insert	app_name, deployment_name, update_mask		Creates an app update and starts the update process. The update process is asynchronous and the status

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
app_name	string	:param update_mask: str The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (.) to navigate sub-fields (e.g., author.given_name). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names. A field mask of * indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using * wildcards, as it can lead to unintended results if the API changes in the future.
deployment_name	string	The Databricks Workspace Deployment Name (default: dbc-abcd0123-a1bc)

SELECT examples

get

Gets the status of an app update.

SELECT
budget_policy_id,
usage_policy_id,
compute_size,
description,
git_repository,
resources,
status,
user_api_scopes
FROM databricks_workspace.apps.app_updates
WHERE app_name = '{{ app_name }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
;

INSERT examples

create

Creates an app update and starts the update process. The update process is asynchronous and the status

INSERT INTO databricks_workspace.apps.app_updates (
update_mask,
app,
app_name,
deployment_name
)
SELECT 
'{{ update_mask }}' /* required */,
'{{ app }}',
'{{ app_name }}',
'{{ deployment_name }}'
RETURNING
budget_policy_id,
usage_policy_id,
compute_size,
description,
git_repository,
resources,
status,
user_api_scopes
;

Manifest

# Description fields are for documentation purposes
- name: app_updates
props:
  - name: app_name
    value: "{{ app_name }}"
    description: Required parameter for the app_updates resource.
  - name: deployment_name
    value: "{{ deployment_name }}"
    description: Required parameter for the app_updates resource.
  - name: update_mask
    value: "{{ update_mask }}"
  - name: app
    description: |
      :returns: Long-running operation waiter for :class:`AppUpdate`. See :method:wait_get_update_app_succeeded for more details.
    value:
      name: "{{ name }}"
      active_deployment:
        command:
          - "{{ command }}"
        create_time: "{{ create_time }}"
        creator: "{{ creator }}"
        deployment_artifacts:
          source_code_path: "{{ source_code_path }}"
        deployment_id: "{{ deployment_id }}"
        env_vars:
          - name: "{{ name }}"
            value: "{{ value }}"
            value_from: "{{ value_from }}"
        git_source:
          branch: "{{ branch }}"
          commit: "{{ commit }}"
          git_repository:
            url: "{{ url }}"
            provider: "{{ provider }}"
          resolved_commit: "{{ resolved_commit }}"
          source_code_path: "{{ source_code_path }}"
          tag: "{{ tag }}"
        mode: "{{ mode }}"
        source_code_path: "{{ source_code_path }}"
        status:
          message: "{{ message }}"
          state: "{{ state }}"
        update_time: "{{ update_time }}"
      app_status:
        message: "{{ message }}"
        state: "{{ state }}"
      budget_policy_id: "{{ budget_policy_id }}"
      compute_size: "{{ compute_size }}"
      compute_status:
        active_instances: {{ active_instances }}
        message: "{{ message }}"
        state: "{{ state }}"
      create_time: "{{ create_time }}"
      creator: "{{ creator }}"
      default_source_code_path: "{{ default_source_code_path }}"
      description: "{{ description }}"
      effective_budget_policy_id: "{{ effective_budget_policy_id }}"
      effective_usage_policy_id: "{{ effective_usage_policy_id }}"
      effective_user_api_scopes:
        - "{{ effective_user_api_scopes }}"
      git_repository:
        url: "{{ url }}"
        provider: "{{ provider }}"
      id: "{{ id }}"
      oauth2_app_client_id: "{{ oauth2_app_client_id }}"
      oauth2_app_integration_id: "{{ oauth2_app_integration_id }}"
      pending_deployment:
        command:
          - "{{ command }}"
        create_time: "{{ create_time }}"
        creator: "{{ creator }}"
        deployment_artifacts:
          source_code_path: "{{ source_code_path }}"
        deployment_id: "{{ deployment_id }}"
        env_vars:
          - name: "{{ name }}"
            value: "{{ value }}"
            value_from: "{{ value_from }}"
        git_source:
          branch: "{{ branch }}"
          commit: "{{ commit }}"
          git_repository:
            url: "{{ url }}"
            provider: "{{ provider }}"
          resolved_commit: "{{ resolved_commit }}"
          source_code_path: "{{ source_code_path }}"
          tag: "{{ tag }}"
        mode: "{{ mode }}"
        source_code_path: "{{ source_code_path }}"
        status:
          message: "{{ message }}"
          state: "{{ state }}"
        update_time: "{{ update_time }}"
      resources:
        - name: "{{ name }}"
          database:
            instance_name: "{{ instance_name }}"
            database_name: "{{ database_name }}"
            permission: "{{ permission }}"
          description: "{{ description }}"
          experiment:
            experiment_id: "{{ experiment_id }}"
            permission: "{{ permission }}"
          genie_space:
            name: "{{ name }}"
            space_id: "{{ space_id }}"
            permission: "{{ permission }}"
          job:
            id: "{{ id }}"
            permission: "{{ permission }}"
          secret:
            scope: "{{ scope }}"
            key: "{{ key }}"
            permission: "{{ permission }}"
          serving_endpoint:
            name: "{{ name }}"
            permission: "{{ permission }}"
          sql_warehouse:
            id: "{{ id }}"
            permission: "{{ permission }}"
          uc_securable:
            securable_full_name: "{{ securable_full_name }}"
            securable_type: "{{ securable_type }}"
            permission: "{{ permission }}"
      service_principal_client_id: "{{ service_principal_client_id }}"
      service_principal_id: {{ service_principal_id }}
      service_principal_name: "{{ service_principal_name }}"
      update_time: "{{ update_time }}"
      updater: "{{ updater }}"
      url: "{{ url }}"
      usage_policy_id: "{{ usage_policy_id }}"
      user_api_scopes:
        - "{{ user_api_scopes }}"