secret_acls

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

Overview

Name	secret_acls
Type	Resource
Id	databricks_workspace.workspace.secret_acls

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
permission	string	The permission level applied to the principal. (MANAGE, READ, WRITE)
principal	string	The principal in which the permission is applied.

list

Name	Datatype	Description
permission	string	The permission level applied to the principal. (MANAGE, READ, WRITE)
principal	string	The principal in which the permission is applied.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	scope, principal, deployment_name, workspace_domain		Describes the details about the given ACL, such as the group and permission.
list	select	scope, deployment_name, workspace_domain		Lists the ACLs set on the given scope.
put	insert	deployment_name, workspace_domain, scope, principal, permission		Creates or overwrites the ACL associated with the given principal (user or group) on the specified
delete	exec	deployment_name, workspace_domain, scope, principal		Deletes the given ACL on the given 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: 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)
principal	string	The principal to fetch ACL information for.
scope	string	The name of the scope to fetch ACL information from.
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"}})

SELECT examples

get

Describes the details about the given ACL, such as the group and permission.

SELECT
permission,
principal
FROM databricks_workspace.workspace.secret_acls
WHERE scope = '{{ scope }}' -- required
AND principal = '{{ principal }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
AND workspace_domain = '{{ workspace_domain }}' -- required
;

list

Lists the ACLs set on the given scope.

SELECT
permission,
principal
FROM databricks_workspace.workspace.secret_acls
WHERE scope = '{{ scope }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
AND workspace_domain = '{{ workspace_domain }}' -- required
;

INSERT examples

put

Creates or overwrites the ACL associated with the given principal (user or group) on the specified

INSERT INTO databricks_workspace.workspace.secret_acls (
scope,
principal,
permission,
deployment_name,
workspace_domain
)
SELECT 
'{{ scope }}' /* required */,
'{{ principal }}' /* required */,
'{{ permission }}' /* required */,
'{{ deployment_name }}',
'{{ workspace_domain }}'
;

Manifest

# Description fields are for documentation purposes
- name: secret_acls
props:
  - name: deployment_name
    value: "{{ deployment_name }}"
    description: Required parameter for the secret_acls resource.
  - name: workspace_domain
    value: "{{ workspace_domain }}"
    description: Required parameter for the secret_acls resource.
  - name: scope
    value: "{{ scope }}"
    description: |
      The name of the scope to apply permissions to.
  - name: principal
    value: "{{ principal }}"
    description: |
      The principal in which the permission is applied.
  - name: permission
    value: "{{ permission }}"
    description: |
      The permission level applied to the principal.

Lifecycle Methods

delete

Deletes the given ACL on the given scope.

EXEC databricks_workspace.workspace.secret_acls.delete 
@deployment_name='{{ deployment_name }}' --required, 
@workspace_domain='{{ workspace_domain }}' --required 
@@json=
'{
"scope": "{{ scope }}", 
"principal": "{{ principal }}"
}'
;