groups

Operations on a groups resource.

Overview

Name	groups
Type	Resource
Id	databricks_workspace.iam.groups

Fields

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

Methods

Name	Accessible by	Required Params	Description
get	SELECT	id, 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.
delete	DELETE	id, deployment_name	Deletes a group from the Databricks workspace.
patch	UPDATE	id, deployment_name	Partially updates the details of a group.
update	UPDATE	id, deployment_name	Updates the details of a group by replacing the entire group entity.

SELECT examples

groups (list)

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

groups (get)

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

INSERT example

Use the following StackQL query and manifest file to create a new groups resource.

groups

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

Manifest

- name: your_resource_model_name
  props:
  - name: schemas
    value:
    - urn:ietf:params:scim:schemas:core:2.0:Group
  - name: displayName
    value: string
  - name: members
    value:
    - $ref: string
      value: string
      display: string
      primary: true
      type: string
  - name: groups
    value:
    - $ref: string
      value: string
      display: string
      primary: true
      type: string
  - name: roles
    value:
    - $ref: string
      value: string
      display: string
      primary: true
      type: string
  - name: entitlements
    value:
    - $ref: string
      value: string
      display: string
      primary: true
      type: string
  - name: externalId
    value: string

UPDATE example

Updates a groups resource.

patch

/*+ update */
-- replace field1, field2, etc. with the fields you want to update        
UPDATE databricks_workspace.iam.groups
SET field1 = '{{ value1 }}',
field2 = '{{ value2 }}', ...
WHERE id = '{{ id }}' AND
deployment_name = '{{ deployment_name }}';

update

/*+ update */
-- replace field1, field2, etc. with the fields you want to update        
UPDATE databricks_workspace.iam.groups
SET field1 = '{{ value1 }}',
field2 = '{{ value2 }}', ...
WHERE id = '{{ id }}' AND
deployment_name = '{{ deployment_name }}';

DELETE example

Deletes a groups resource.

/*+ delete */
DELETE FROM databricks_workspace.iam.groups
WHERE id = '{{ id }}' AND
deployment_name = '{{ deployment_name }}';