groups

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

Overview

Name	groups
Type	Resource
Id	databricks_workspace.iam.groups

Fields

The following fields are returned by SELECT queries:

get

Group information was returned successfully.

Name	Datatype	Description
id	string
displayName	string
entitlements	array
externalId	string
groups	array
members	array
roles	array
schemas	array

list

List groups operation was succesful.

Name	Datatype	Description
id	string
displayName	string
entitlements	array
externalId	string
groups	array
members	array
roles	array
schemas	array

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	deployment_name		Gets the information for a specific group in the Databricks workspace.
list	select	deployment_name		Gets all details of the groups associated with the Databricks workspace.
create	insert	deployment_name		Creates a group in the Databricks workspace with a unique name, using the supplied group details.
update	update	deployment_name		Updates the details of a group by replacing the entire group entity.
patch	update	deployment_name		Partially updates the details of a group.
delete	delete	deployment_name		Deletes a group from the Databricks workspace.

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

get

Gets the information for a specific group in the Databricks workspace.

SELECT
id,
displayName,
entitlements,
externalId,
groups,
members,
roles,
schemas
FROM databricks_workspace.iam.groups
WHERE deployment_name = '{{ deployment_name }}' -- required;

list

Gets all details of the groups associated with the Databricks workspace.

SELECT
id,
displayName,
entitlements,
externalId,
groups,
members,
roles,
schemas
FROM databricks_workspace.iam.groups
WHERE deployment_name = '{{ deployment_name }}' -- required;

INSERT examples

create

Creates a group in the Databricks workspace with a unique name, using the supplied group details.

INSERT INTO databricks_workspace.iam.groups (
data__schemas,
data__id,
data__displayName,
data__externalId,
data__members,
data__groups,
data__roles,
data__entitlements,
deployment_name
)
SELECT 
'{{ schemas }}',
{{ id }},
'{{ displayName }}',
'{{ externalId }}',
'{{ members }}',
'{{ groups }}',
'{{ roles }}',
'{{ entitlements }}',
'{{ deployment_name }}'
;

Manifest

# Description fields are for documentation purposes
- name: groups
  props:
    - name: deployment_name
      value: string
      description: Required parameter for the groups resource.
    - name: schemas
      value: Array of string
    - name: id
      value: integer
    - name: displayName
      value: string
    - name: externalId
      value: string
    - name: members
      value: Array of object
    - name: groups
      value: Array of object
    - name: roles
      value: Array of object
    - name: entitlements
      value: Array of object

UPDATE examples

update

Updates the details of a group by replacing the entire group entity.

UPDATE databricks_workspace.iam.groups
SET 
data__schemas = '{{ schemas }}',
data__id = {{ id }},
data__displayName = '{{ displayName }}',
data__externalId = '{{ externalId }}',
data__members = '{{ members }}',
data__groups = '{{ groups }}',
data__roles = '{{ roles }}',
data__entitlements = '{{ entitlements }}'
WHERE 
deployment_name = '{{ deployment_name }}' --required;

patch

Partially updates the details of a group.

UPDATE databricks_workspace.iam.groups
SET 
data__schemas = '{{ schemas }}',
data__Operations = '{{ Operations }}'
WHERE 
deployment_name = '{{ deployment_name }}' --required;

DELETE examples

delete

Deletes a group from the Databricks workspace.

DELETE FROM databricks_workspace.iam.groups
WHERE deployment_name = '{{ deployment_name }}' --required;