databricks_group Data Source

Retrieves information about databricks_group members, entitlements and roles.

-> This data source can be used with an account or workspace-level provider.

Example Usage

Adding user to administrative group

data "databricks_group" "admins" {
  display_name = "admins"
}

resource "databricks_user" "me" {
  user_name = "me@example.com"
}

resource "databricks_group_member" "my_member_a" {
  group_id  = data.databricks_group.admins.id
  member_id = databricks_user.me.id
}

Argument Reference

Data source allows you to pick groups by the following attributes

• display_name - (Required) Display name of the group. The group must exist before this resource can be planned.
• recursive - (Optional) Collect information for all nested groups. Defaults to true.
• api - (Optional) Specifies whether to use account-level or workspace-level API. Valid values are account and workspace. When not set, the API level is inferred from the provider host.
• provider_config - (Optional) Configure the provider for management through account provider. This block consists of the following fields:
  • workspace_id - (Required) Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.

Attribute Reference

Data source exposes the following attributes:

• id - The id for the group object.
• external_id - ID of the group in an external identity provider.
• users - Set of databricks_user identifiers, that can be modified with databricks_group_member resource.
• service_principals - Set of databricks_service_principal identifiers, that can be modified with databricks_group_member resource.
• child_groups - Set of databricks_group identifiers, that can be modified with databricks_group_member resource.
• groups - Set of group identifiers, that can be modified with databricks_group_member resource.
• roles - Set of role ARNs (e.g., instance profile ARNs), that can be modified by databricks_group_instance_profile or databricks_group_role resources.
• instance_profiles - (Deprecated) Set of instance profile ARNs, that can be modified by databricks_group_instance_profile resource. Use roles instead.
• allow_cluster_create - True if group members can create clusters
• allow_instance_pool_create - True if group members can create instance pools
• acl_principal_id - identifier for use in databricks_access_control_rule_set, e.g. groups/Some Group.

Related Resources

The following resources are used in the same context:

• End to end workspace management guide
• databricks_cluster to create Databricks Clusters.
• databricks_directory to manage directories in Databricks Workpace.
• databricks_group_member to attach users and groups as group members.
• databricks_permissions to manage access control in Databricks workspace.
• databricks_user to manage users, that could be added to databricks_group within the workspace.