groups

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

Overview

Name	groups
Type	Resource
Id	databricks_account.iam.groups

Fields

The following fields are returned by SELECT queries:

get

Group information was returned successfully.

Name	Datatype	Description
id	string
displayName	string
externalId	string
members	array
roles	array

list

List groups operation was succesful.

Name	Datatype	Description
id	string
displayName	string
externalId	string
members	array
roles	array

Methods

The following methods are available for this resource:

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

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

SELECT examples

get

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

SELECT
id,
displayName,
externalId,
members,
roles
FROM databricks_account.iam.groups;

list

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

SELECT
id,
displayName,
externalId,
members,
roles
FROM databricks_account.iam.groups;

INSERT examples

create

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

INSERT INTO databricks_account.iam.groups (
data__id,
data__displayName,
data__externalId,
data__members,
data__roles
)
SELECT 
{{ id }},
'{{ displayName }}',
'{{ externalId }}',
'{{ members }}',
'{{ roles }}'
;

Manifest

# Description fields are for documentation purposes
- name: groups
  props:
    - name: id
      value: integer
    - name: displayName
      value: string
    - name: externalId
      value: string
    - name: members
      value: Array of object
    - name: roles
      value: Array of object

UPDATE examples

patch

Partially updates the details of a group.

UPDATE databricks_account.iam.groups
SET 
data__schemas = '{{ schemas }}',
data__Operations = '{{ Operations }}'
WHERE 
;

REPLACE examples

update

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

REPLACE databricks_account.iam.groups
SET 
data__id = {{ id }},
data__displayName = '{{ displayName }}',
data__externalId = '{{ externalId }}',
data__members = '{{ members }}',
data__roles = '{{ roles }}'
WHERE 
;

DELETE examples

delete

Deletes a group from the Databricks account.

DELETE FROM databricks_account.iam.groups;