1. Packages
  2. Packages
  3. Databricks Provider
  4. API Docs
  5. Group
Viewing docs for Databricks v0.4.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-databricks

databricks.Group

databricks logo
Viewing docs for Databricks v0.4.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-databricks

    This resource allows you to manage groups in Databricks Workspace or Account Console (for AWS deployments). You can also associate Databricks users to groups. This is useful if you are using an application to sync users & groups with SCIM API.

    Recommended to use along with Identity Provider SCIM provisioning to populate users into those groups:

    Create Group Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Group(name: string, args: GroupArgs, opts?: CustomResourceOptions);
    @overload
def Group(resource_name: str,
          args: GroupArgs,
          opts: Optional[ResourceOptions] = None)

@overload
def Group(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          display_name: Optional[str] = None,
          allow_cluster_create: Optional[bool] = None,
          allow_instance_pool_create: Optional[bool] = None,
          databricks_sql_access: Optional[bool] = None,
          external_id: Optional[str] = None,
          force: Optional[bool] = None,
          url: Optional[str] = None,
          workspace_access: Optional[bool] = None)
    func NewGroup(ctx *Context, name string, args GroupArgs, opts ...ResourceOption) (*Group, error)
    public Group(string name, GroupArgs args, CustomResourceOptions? opts = null)
    public Group(String name, GroupArgs args)
public Group(String name, GroupArgs args, CustomResourceOptions options)

    type: databricks:Group
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args GroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args GroupArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args GroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GroupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var groupResource = new Databricks.Group("groupResource", new()
{
    DisplayName = "string",
    AllowClusterCreate = false,
    AllowInstancePoolCreate = false,
    DatabricksSqlAccess = false,
    ExternalId = "string",
    Force = false,
    Url = "string",
    WorkspaceAccess = false,
});

    example, err := databricks.NewGroup(ctx, "groupResource", &databricks.GroupArgs{
	DisplayName:             pulumi.String("string"),
	AllowClusterCreate:      pulumi.Bool(false),
	AllowInstancePoolCreate: pulumi.Bool(false),
	DatabricksSqlAccess:     pulumi.Bool(false),
	ExternalId:              pulumi.String("string"),
	Force:                   pulumi.Bool(false),
	Url:                     pulumi.String("string"),
	WorkspaceAccess:         pulumi.Bool(false),
})

    var groupResource = new Group("groupResource", GroupArgs.builder()
    .displayName("string")
    .allowClusterCreate(false)
    .allowInstancePoolCreate(false)
    .databricksSqlAccess(false)
    .externalId("string")
    .force(false)
    .url("string")
    .workspaceAccess(false)
    .build());

    group_resource = databricks.Group("groupResource",
    display_name="string",
    allow_cluster_create=False,
    allow_instance_pool_create=False,
    databricks_sql_access=False,
    external_id="string",
    force=False,
    url="string",
    workspace_access=False)

    const groupResource = new databricks.Group("groupResource", {
    displayName: "string",
    allowClusterCreate: false,
    allowInstancePoolCreate: false,
    databricksSqlAccess: false,
    externalId: "string",
    force: false,
    url: "string",
    workspaceAccess: false,
});

    type: databricks:Group
properties:
    allowClusterCreate: false
    allowInstancePoolCreate: false
    databricksSqlAccess: false
    displayName: string
    externalId: string
    force: false
    url: string
    workspaceAccess: false

    Group Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Group resource accepts the following input properties:

    DisplayName string
    This is the display name for the given group.
    AllowClusterCreate bool
    This is a field to allow the group to have cluster create privileges. More fine grained permissions could be assigned with databricks.Permissions and cluster_id argument. Everyone without allow_cluster_create argument set, but with permission to use Cluster Policy would be able to create clusters, but within boundaries of that specific policy.
    AllowInstancePoolCreate bool
    This is a field to allow the group to have instance pool create privileges. More fine grained permissions could be assigned with databricks.Permissions and instance_pool_id argument.
    DatabricksSqlAccess bool
    This is a field to allow the group to have access to Databricks SQL feature in User Interface and through databricks_sql_endpoint.
    ExternalId string
    ID of the group in an external identity provider.
    Force bool
    Url string
    WorkspaceAccess bool
    This is a field to allow the group to have access to Databricks Workspace.
    DisplayName string
    This is the display name for the given group.
    AllowClusterCreate bool
    This is a field to allow the group to have cluster create privileges. More fine grained permissions could be assigned with databricks.Permissions and cluster_id argument. Everyone without allow_cluster_create argument set, but with permission to use Cluster Policy would be able to create clusters, but within boundaries of that specific policy.
    AllowInstancePoolCreate bool
    This is a field to allow the group to have instance pool create privileges. More fine grained permissions could be assigned with databricks.Permissions and instance_pool_id argument.
    DatabricksSqlAccess bool
    This is a field to allow the group to have access to Databricks SQL feature in User Interface and through databricks_sql_endpoint.
    ExternalId string
    ID of the group in an external identity provider.
    Force bool
    Url string
    WorkspaceAccess bool
    This is a field to allow the group to have access to Databricks Workspace.
    displayName String
    This is the display name for the given group.
    allowClusterCreate Boolean
    This is a field to allow the group to have cluster create privileges. More fine grained permissions could be assigned with databricks.Permissions and cluster_id argument. Everyone without allow_cluster_create argument set, but with permission to use Cluster Policy would be able to create clusters, but within boundaries of that specific policy.
    allowInstancePoolCreate Boolean
    This is a field to allow the group to have instance pool create privileges. More fine grained permissions could be assigned with databricks.Permissions and instance_pool_id argument.
    databricksSqlAccess Boolean
    This is a field to allow the group to have access to Databricks SQL feature in User Interface and through databricks_sql_endpoint.
    externalId String
    ID of the group in an external identity provider.
    force Boolean
    url String
    workspaceAccess Boolean
    This is a field to allow the group to have access to Databricks Workspace.
    displayName string
    This is the display name for the given group.
    allowClusterCreate boolean
    This is a field to allow the group to have cluster create privileges. More fine grained permissions could be assigned with databricks.Permissions and cluster_id argument. Everyone without allow_cluster_create argument set, but with permission to use Cluster Policy would be able to create clusters, but within boundaries of that specific policy.
    allowInstancePoolCreate boolean
    This is a field to allow the group to have instance pool create privileges. More fine grained permissions could be assigned with databricks.Permissions and instance_pool_id argument.
    databricksSqlAccess boolean
    This is a field to allow the group to have access to Databricks SQL feature in User Interface and through databricks_sql_endpoint.
    externalId string
    ID of the group in an external identity provider.
    force boolean
    url string
    workspaceAccess boolean
    This is a field to allow the group to have access to Databricks Workspace.
    display_name str
    This is the display name for the given group.
    allow_cluster_create bool
    This is a field to allow the group to have cluster create privileges. More fine grained permissions could be assigned with databricks.Permissions and cluster_id argument. Everyone without allow_cluster_create argument set, but with permission to use Cluster Policy would be able to create clusters, but within boundaries of that specific policy.
    allow_instance_pool_create bool
    This is a field to allow the group to have instance pool create privileges. More fine grained permissions could be assigned with databricks.Permissions and instance_pool_id argument.
    databricks_sql_access bool
    This is a field to allow the group to have access to Databricks SQL feature in User Interface and through databricks_sql_endpoint.
    external_id str
    ID of the group in an external identity provider.
    force bool
    url str
    workspace_access bool
    This is a field to allow the group to have access to Databricks Workspace.
    displayName String
    This is the display name for the given group.
    allowClusterCreate Boolean
    This is a field to allow the group to have cluster create privileges. More fine grained permissions could be assigned with databricks.Permissions and cluster_id argument. Everyone without allow_cluster_create argument set, but with permission to use Cluster Policy would be able to create clusters, but within boundaries of that specific policy.
    allowInstancePoolCreate Boolean
    This is a field to allow the group to have instance pool create privileges. More fine grained permissions could be assigned with databricks.Permissions and instance_pool_id argument.
    databricksSqlAccess Boolean
    This is a field to allow the group to have access to Databricks SQL feature in User Interface and through databricks_sql_endpoint.
    externalId String
    ID of the group in an external identity provider.
    force Boolean
    url String
    workspaceAccess Boolean
    This is a field to allow the group to have access to Databricks Workspace.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Group resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Group Resource

    Get an existing Group resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: GroupState, opts?: CustomResourceOptions): Group
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allow_cluster_create: Optional[bool] = None,
        allow_instance_pool_create: Optional[bool] = None,
        databricks_sql_access: Optional[bool] = None,
        display_name: Optional[str] = None,
        external_id: Optional[str] = None,
        force: Optional[bool] = None,
        url: Optional[str] = None,
        workspace_access: Optional[bool] = None) -> Group
    func GetGroup(ctx *Context, name string, id IDInput, state *GroupState, opts ...ResourceOption) (*Group, error)
    public static Group Get(string name, Input<string> id, GroupState? state, CustomResourceOptions? opts = null)
    public static Group get(String name, Output<String> id, GroupState state, CustomResourceOptions options)
    resources:  _:    type: databricks:Group    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AllowClusterCreate bool
    This is a field to allow the group to have cluster create privileges. More fine grained permissions could be assigned with databricks.Permissions and cluster_id argument. Everyone without allow_cluster_create argument set, but with permission to use Cluster Policy would be able to create clusters, but within boundaries of that specific policy.
    AllowInstancePoolCreate bool
    This is a field to allow the group to have instance pool create privileges. More fine grained permissions could be assigned with databricks.Permissions and instance_pool_id argument.
    DatabricksSqlAccess bool
    This is a field to allow the group to have access to Databricks SQL feature in User Interface and through databricks_sql_endpoint.
    DisplayName string
    This is the display name for the given group.
    ExternalId string
    ID of the group in an external identity provider.
    Force bool
    Url string
    WorkspaceAccess bool
    This is a field to allow the group to have access to Databricks Workspace.
    AllowClusterCreate bool
    This is a field to allow the group to have cluster create privileges. More fine grained permissions could be assigned with databricks.Permissions and cluster_id argument. Everyone without allow_cluster_create argument set, but with permission to use Cluster Policy would be able to create clusters, but within boundaries of that specific policy.
    AllowInstancePoolCreate bool
    This is a field to allow the group to have instance pool create privileges. More fine grained permissions could be assigned with databricks.Permissions and instance_pool_id argument.
    DatabricksSqlAccess bool
    This is a field to allow the group to have access to Databricks SQL feature in User Interface and through databricks_sql_endpoint.
    DisplayName string
    This is the display name for the given group.
    ExternalId string
    ID of the group in an external identity provider.
    Force bool
    Url string
    WorkspaceAccess bool
    This is a field to allow the group to have access to Databricks Workspace.
    allowClusterCreate Boolean
    This is a field to allow the group to have cluster create privileges. More fine grained permissions could be assigned with databricks.Permissions and cluster_id argument. Everyone without allow_cluster_create argument set, but with permission to use Cluster Policy would be able to create clusters, but within boundaries of that specific policy.
    allowInstancePoolCreate Boolean
    This is a field to allow the group to have instance pool create privileges. More fine grained permissions could be assigned with databricks.Permissions and instance_pool_id argument.
    databricksSqlAccess Boolean
    This is a field to allow the group to have access to Databricks SQL feature in User Interface and through databricks_sql_endpoint.
    displayName String
    This is the display name for the given group.
    externalId String
    ID of the group in an external identity provider.
    force Boolean
    url String
    workspaceAccess Boolean
    This is a field to allow the group to have access to Databricks Workspace.
    allowClusterCreate boolean
    This is a field to allow the group to have cluster create privileges. More fine grained permissions could be assigned with databricks.Permissions and cluster_id argument. Everyone without allow_cluster_create argument set, but with permission to use Cluster Policy would be able to create clusters, but within boundaries of that specific policy.
    allowInstancePoolCreate boolean
    This is a field to allow the group to have instance pool create privileges. More fine grained permissions could be assigned with databricks.Permissions and instance_pool_id argument.
    databricksSqlAccess boolean
    This is a field to allow the group to have access to Databricks SQL feature in User Interface and through databricks_sql_endpoint.
    displayName string
    This is the display name for the given group.
    externalId string
    ID of the group in an external identity provider.
    force boolean
    url string
    workspaceAccess boolean
    This is a field to allow the group to have access to Databricks Workspace.
    allow_cluster_create bool
    This is a field to allow the group to have cluster create privileges. More fine grained permissions could be assigned with databricks.Permissions and cluster_id argument. Everyone without allow_cluster_create argument set, but with permission to use Cluster Policy would be able to create clusters, but within boundaries of that specific policy.
    allow_instance_pool_create bool
    This is a field to allow the group to have instance pool create privileges. More fine grained permissions could be assigned with databricks.Permissions and instance_pool_id argument.
    databricks_sql_access bool
    This is a field to allow the group to have access to Databricks SQL feature in User Interface and through databricks_sql_endpoint.
    display_name str
    This is the display name for the given group.
    external_id str
    ID of the group in an external identity provider.
    force bool
    url str
    workspace_access bool
    This is a field to allow the group to have access to Databricks Workspace.
    allowClusterCreate Boolean
    This is a field to allow the group to have cluster create privileges. More fine grained permissions could be assigned with databricks.Permissions and cluster_id argument. Everyone without allow_cluster_create argument set, but with permission to use Cluster Policy would be able to create clusters, but within boundaries of that specific policy.
    allowInstancePoolCreate Boolean
    This is a field to allow the group to have instance pool create privileges. More fine grained permissions could be assigned with databricks.Permissions and instance_pool_id argument.
    databricksSqlAccess Boolean
    This is a field to allow the group to have access to Databricks SQL feature in User Interface and through databricks_sql_endpoint.
    displayName String
    This is the display name for the given group.
    externalId String
    ID of the group in an external identity provider.
    force Boolean
    url String
    workspaceAccess Boolean
    This is a field to allow the group to have access to Databricks Workspace.

    Import

    You can import a databricks_group resource with the name my_group like the followingbash

     $ pulumi import databricks:index/group:Group my_group <group_id>

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    databricks pulumi/pulumi-databricks
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the databricks Terraform Provider.
    databricks logo
    Viewing docs for Databricks v0.4.0 (Older version)
    published on Monday, Mar 9, 2026 by Pulumi
    Go to latest version
    Schema (JSON)
    pulumi/pulumi-databricks
      Try Pulumi Cloud free. Your team will thank you.