deployment_resources

Creates, updates, deletes, gets or lists a deployment_resources resource.

Overview

Name	deployment_resources
Type	Resource
Id	databricks_workspace.bundledeployments.deployment_resources

Fields

The following fields are returned by SELECT queries:

list

Name	Datatype	Description
name	string	Resource name. Format: deployments/{deployment_id}/resources/{resource_key}
last_version_id	string	The version_id of the last version where this resource was updated.
resource_id	string	ID that references the actual resource in the workspace (e.g. the job ID, pipeline ID).
▶dashboard_metadata	object	Dashboard-specific metadata; set only for dashboard resources.
last_action_type	string	The action performed on this resource during the last version. (OPERATION_ACTION_TYPE_BIND, OPERATION_ACTION_TYPE_BIND_AND_UPDATE, OPERATION_ACTION_TYPE_CREATE, OPERATION_ACTION_TYPE_DELETE, OPERATION_ACTION_TYPE_INITIAL_REGISTER, OPERATION_ACTION_TYPE_RECREATE, OPERATION_ACTION_TYPE_RESIZE, OPERATION_ACTION_TYPE_UPDATE, OPERATION_ACTION_TYPE_UPDATE_WITH_ID)
resource_key	string	Resource identifier within the bundle (e.g. "jobs.foo", "pipelines.bar", "jobs.foo.permissions").
resource_type	string	The type of the deployment resource. (DEPLOYMENT_RESOURCE_TYPE_ALERT, DEPLOYMENT_RESOURCE_TYPE_APP, DEPLOYMENT_RESOURCE_TYPE_CATALOG, DEPLOYMENT_RESOURCE_TYPE_CLUSTER, DEPLOYMENT_RESOURCE_TYPE_DASHBOARD, DEPLOYMENT_RESOURCE_TYPE_DATABASE_CATALOG, DEPLOYMENT_RESOURCE_TYPE_DATABASE_INSTANCE, DEPLOYMENT_RESOURCE_TYPE_EXPERIMENT, DEPLOYMENT_RESOURCE_TYPE_EXTERNAL_LOCATION, DEPLOYMENT_RESOURCE_TYPE_JOB, DEPLOYMENT_RESOURCE_TYPE_MODEL, DEPLOYMENT_RESOURCE_TYPE_MODEL_SERVING_ENDPOINT, DEPLOYMENT_RESOURCE_TYPE_PIPELINE, DEPLOYMENT_RESOURCE_TYPE_POSTGRES_BRANCH, DEPLOYMENT_RESOURCE_TYPE_POSTGRES_ENDPOINT, DEPLOYMENT_RESOURCE_TYPE_POSTGRES_PROJECT, DEPLOYMENT_RESOURCE_TYPE_QUALITY_MONITOR, DEPLOYMENT_RESOURCE_TYPE_REGISTERED_MODEL, DEPLOYMENT_RESOURCE_TYPE_SCHEMA, DEPLOYMENT_RESOURCE_TYPE_SECRET_SCOPE, DEPLOYMENT_RESOURCE_TYPE_SQL_WAREHOUSE, DEPLOYMENT_RESOURCE_TYPE_SYNCED_DATABASE_TABLE, DEPLOYMENT_RESOURCE_TYPE_VOLUME)
state	object	Serialized local config state (what the CLI deployed).
update_time	string (date-time)	When the last operation that updated this resource's recorded state was applied. Pairs with last_action_type and last_version_id (all three advance together on that write).

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	parent, deployment_name	page_size, page_token	Lists resources under a deployment.

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)
parent	string	The parent deployment. Format: deployments/{deployment_id}
page_size	integer	The maximum number of resources to return. The service may return fewer than this value. If unspecified, at most 50 resources will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
page_token	string	A page token, received from a previous ListResources call. Provide this to retrieve the subsequent page.

SELECT examples

list

Lists resources under a deployment.

SELECT
name,
last_version_id,
resource_id,
dashboard_metadata,
last_action_type,
resource_key,
resource_type,
state,
update_time
FROM databricks_workspace.bundledeployments.deployment_resources
WHERE parent = '{{ parent }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;