Skip to main content

default_base_environment

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

Overview

Namedefault_base_environment
TypeResource
Iddatabricks_workspace.compute.default_base_environment

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
idstring
namestring
creator_user_idinteger
last_updated_user_idinteger
base_environment_cachearray
base_environment_typestringIf changed, also update estore/namespaces/defaultbaseenvironments/latest.proto (CPU, GPU)
created_timestampinteger
environmentobjectNote: we made ``environment`` non-internal because we need to expose its ``client`` field. All other fields should be treated as internal.
filepathstring
is_defaultboolean
last_updated_timestampinteger
messagestring
principal_idsarray
statusstringCreate 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. (CREATED, EXPIRED, FAILED, INVALID, PENDING, REFRESHING)

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectid, deployment_nametrace_idReturn the default base environment details for a given ID.

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.

NameDatatypeDescription
deployment_namestringThe Databricks Workspace Deployment Name (default: dbc-abcd0123-a1bc)
idstring
trace_idstringDeprecated: use ctx.requestId instead

SELECT examples

Return the default base environment details for a given ID.

SELECT
id,
name,
creator_user_id,
last_updated_user_id,
base_environment_cache,
base_environment_type,
created_timestamp,
environment,
filepath,
is_default,
last_updated_timestamp,
message,
principal_ids,
status
FROM databricks_workspace.compute.default_base_environment
WHERE id = '{{ id }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
AND trace_id = '{{ trace_id }}'
;