sandbox_directories

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

Overview

Name	sandbox_directories
Type	Resource
Id	databricks_workspace.sandbox.sandbox_directories

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
create	insert	sandbox_id, deployment_name, workspace_domain, path		Creates a directory in a sandbox, including missing parents by default.

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: the host prefix of the workspace URL (dbc-abcd0123-a1bc on AWS, adb-1234567890123456.7 on Azure, 1234567890123456.7 on GCP). Set DATABRICKS_DEPLOYMENT_NAME to default it for the session. (default: dbc-abcd0123-a1bc, x-stackQL-envVar: DATABRICKS_DEPLOYMENT_NAME)
sandbox_id	string	The sandbox_id segment of the parent resource name (sandboxes/{sandbox_id}).
workspace_domain	string	The Databricks workspace domain suffix for the cloud. Selected by DATABRICKS_CLOUD (aws, azure or gcp; default aws). (default: cloud.databricks.com, x-stackQL-envVarSelector: {"envVar":"DATABRICKS_CLOUD","default":"aws","values":{"aws":"cloud.databricks.com","azure":"azuredatabricks.net","gcp":"gcp.databricks.com"}})

INSERT examples

create

Creates a directory in a sandbox, including missing parents by default.

INSERT INTO databricks_workspace.sandbox.sandbox_directories (
path,
parents,
sandbox_id,
deployment_name,
workspace_domain
)
SELECT 
'{{ path }}' /* required */,
{{ parents }},
'{{ sandbox_id }}',
'{{ deployment_name }}',
'{{ workspace_domain }}'
;

Manifest

# Description fields are for documentation purposes
- name: sandbox_directories
props:
  - name: sandbox_id
    value: "{{ sandbox_id }}"
    description: Required parameter for the sandbox_directories resource.
  - name: deployment_name
    value: "{{ deployment_name }}"
    description: Required parameter for the sandbox_directories resource.
  - name: workspace_domain
    value: "{{ workspace_domain }}"
    description: Required parameter for the sandbox_directories resource.
  - name: path
    value: "{{ path }}"
    description: |
      Absolute UTF-8 path of the directory.
  - name: parents
    value: {{ parents }}
    description: |
      Defaults to true, which also succeeds when the directory already exists.