scopes

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

Overview

Name	scopes
Type	Resource
Id	databricks_workspace.secrets.scopes

Fields

The following fields are returned by SELECT queries:

listscopes

Name	Datatype	Description
name	string
backend_type	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
listscopes	select	deployment_name		Lists all secret scopes available in the workspace.
createscope	insert	deployment_name		The scope name must consist of alphanumeric characters, dashes, underscores, and periods, and may not exceed 128 characters.
deletescope	delete	deployment_name		Deletes a secret scope.

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)

SELECT examples

listscopes

Lists all secret scopes available in the workspace.

SELECT
name,
backend_type
FROM databricks_workspace.secrets.scopes
WHERE deployment_name = '{{ deployment_name }}' -- required;

INSERT examples

createscope

The scope name must consist of alphanumeric characters, dashes, underscores, and periods, and may not exceed 128 characters.

INSERT INTO databricks_workspace.secrets.scopes (
data__scope,
data__initial_manage_principal,
data__scope_backend_type,
deployment_name
)
SELECT 
'{{ scope }}',
'{{ initial_manage_principal }}',
'{{ scope_backend_type }}',
'{{ deployment_name }}'
;

Manifest

# Description fields are for documentation purposes
- name: scopes
  props:
    - name: deployment_name
      value: string
      description: Required parameter for the scopes resource.
    - name: scope
      value: required
    - name: initial_manage_principal
      value: string
    - name: scope_backend_type
      value: string

DELETE examples

deletescope

Deletes a secret scope.

DELETE FROM databricks_workspace.secrets.scopes
WHERE deployment_name = '{{ deployment_name }}' --required;