Docs Packages
  1. Packages
  2. Databricks
  3. API Docs
  4. Group
Databricks v1.35.0 published on Friday, Mar 29, 2024 by Pulumi
pulumi/pulumi-databricks

databricks.Group

Explore with Pulumi AI

databricks logo
Databricks v1.35.0 published on Friday, Mar 29, 2024 by Pulumi
pulumi/pulumi-databricks

    This resource allows you to manage both account groups and workspace-local groups. You can use the databricks.GroupMember resource to assign Databricks users, service principals as well as other groups as members of the group. This is useful if you are using an application to sync users & groups with SCIM API.

    Note To assign an account level group to a workspace use databricks_mws_permission_assignment.

    Note Entitlements, like, allow_cluster_create, allow_instance_pool_create, databricks_sql_access, workspace_access applicable only for workspace-level groups. Use databricks.Entitlements resource to assign entitlements inside a workspace to account-level groups.

    To create account groups in the Databricks account, the provider must be configured accordingly. On AWS deployment with host = "https://accounts.cloud.databricks.com" and account_id = "00000000-0000-0000-0000-000000000000". On Azure deployments host = "https://accounts.azuredatabricks.net", account_id = "00000000-0000-0000-0000-000000000000" and using AAD tokens as authentication.

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

    Example Usage

    Creating some group

    import * as pulumi from "@pulumi/pulumi";
import * as databricks from "@pulumi/databricks";

const _this = new databricks.Group("this", {
    allowClusterCreate: true,
    allowInstancePoolCreate: true,
});

    import pulumi
import pulumi_databricks as databricks

this = databricks.Group("this",
    allow_cluster_create=True,
    allow_instance_pool_create=True)

    package main

import (
	"github.com/pulumi/pulumi-databricks/sdk/go/databricks"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := databricks.NewGroup(ctx, "this", &databricks.GroupArgs{
			AllowClusterCreate:      pulumi.Bool(true),
			AllowInstancePoolCreate: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Databricks = Pulumi.Databricks;

return await Deployment.RunAsync(() => 
{
    var @this = new Databricks.Group("this", new()
    {
        AllowClusterCreate = true,
        AllowInstancePoolCreate = true,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.databricks.Group;
import com.pulumi.databricks.GroupArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var this_ = new Group("this", GroupArgs.builder()        
            .allowClusterCreate(true)
            .allowInstancePoolCreate(true)
            .build());

    }
}

    resources:
  this:
    type: databricks:Group
    properties:
      allowClusterCreate: true
      allowInstancePoolCreate: true

    Adding databricks.User as databricks.GroupMember of some group

    import * as pulumi from "@pulumi/pulumi";
import * as databricks from "@pulumi/databricks";

const thisGroup = new databricks.Group("thisGroup", {
    allowClusterCreate: true,
    allowInstancePoolCreate: true,
});
const thisUser = new databricks.User("thisUser", {userName: "someone@example.com"});
const vipMember = new databricks.GroupMember("vipMember", {
    groupId: thisGroup.id,
    memberId: thisUser.id,
});

    import pulumi
import pulumi_databricks as databricks

this_group = databricks.Group("thisGroup",
    allow_cluster_create=True,
    allow_instance_pool_create=True)
this_user = databricks.User("thisUser", user_name="someone@example.com")
vip_member = databricks.GroupMember("vipMember",
    group_id=this_group.id,
    member_id=this_user.id)

    package main

import (
	"github.com/pulumi/pulumi-databricks/sdk/go/databricks"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		thisGroup, err := databricks.NewGroup(ctx, "thisGroup", &databricks.GroupArgs{
			AllowClusterCreate:      pulumi.Bool(true),
			AllowInstancePoolCreate: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		thisUser, err := databricks.NewUser(ctx, "thisUser", &databricks.UserArgs{
			UserName: pulumi.String("someone@example.com"),
		})
		if err != nil {
			return err
		}
		_, err = databricks.NewGroupMember(ctx, "vipMember", &databricks.GroupMemberArgs{
			GroupId:  thisGroup.ID(),
			MemberId: thisUser.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Databricks = Pulumi.Databricks;

return await Deployment.RunAsync(() => 
{
    var thisGroup = new Databricks.Group("thisGroup", new()
    {
        AllowClusterCreate = true,
        AllowInstancePoolCreate = true,
    });

    var thisUser = new Databricks.User("thisUser", new()
    {
        UserName = "someone@example.com",
    });

    var vipMember = new Databricks.GroupMember("vipMember", new()
    {
        GroupId = thisGroup.Id,
        MemberId = thisUser.Id,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.databricks.Group;
import com.pulumi.databricks.GroupArgs;
import com.pulumi.databricks.User;
import com.pulumi.databricks.UserArgs;
import com.pulumi.databricks.GroupMember;
import com.pulumi.databricks.GroupMemberArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var thisGroup = new Group("thisGroup", GroupArgs.builder()        
            .allowClusterCreate(true)
            .allowInstancePoolCreate(true)
            .build());

        var thisUser = new User("thisUser", UserArgs.builder()        
            .userName("someone@example.com")
            .build());

        var vipMember = new GroupMember("vipMember", GroupMemberArgs.builder()        
            .groupId(thisGroup.id())
            .memberId(thisUser.id())
            .build());

    }
}

    resources:
  thisGroup:
    type: databricks:Group
    properties:
      allowClusterCreate: true
      allowInstancePoolCreate: true
  thisUser:
    type: databricks:User
    properties:
      userName: someone@example.com
  vipMember:
    type: databricks:GroupMember
    properties:
      groupId: ${thisGroup.id}
      memberId: ${thisUser.id}

    Creating group in AWS Databricks account:

    import * as pulumi from "@pulumi/pulumi";
import * as databricks from "@pulumi/databricks";

// initialize provider at account-level
const mws = new databricks.Provider("mws", {
    host: "https://accounts.cloud.databricks.com",
    accountId: "00000000-0000-0000-0000-000000000000",
    clientId: _var.client_id,
    clientSecret: _var.client_secret,
});
const _this = new databricks.Group("this", {}, {
    provider: databricks.mws,
});

    import pulumi
import pulumi_databricks as databricks

# initialize provider at account-level
mws = databricks.Provider("mws",
    host="https://accounts.cloud.databricks.com",
    account_id="00000000-0000-0000-0000-000000000000",
    client_id=var["client_id"],
    client_secret=var["client_secret"])
this = databricks.Group("this", opts=pulumi.ResourceOptions(provider=databricks["mws"]))

    package main

import (
	"github.com/pulumi/pulumi-databricks/sdk/go/databricks"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// initialize provider at account-level
		_, err := databricks.NewProvider(ctx, "mws", &databricks.ProviderArgs{
			Host:         pulumi.String("https://accounts.cloud.databricks.com"),
			AccountId:    pulumi.String("00000000-0000-0000-0000-000000000000"),
			ClientId:     pulumi.Any(_var.Client_id),
			ClientSecret: pulumi.Any(_var.Client_secret),
		})
		if err != nil {
			return err
		}
		_, err = databricks.NewGroup(ctx, "this", nil, pulumi.Provider(databricks.Mws))
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Databricks = Pulumi.Databricks;

return await Deployment.RunAsync(() => 
{
    // initialize provider at account-level
    var mws = new Databricks.Provider("mws", new()
    {
        Host = "https://accounts.cloud.databricks.com",
        AccountId = "00000000-0000-0000-0000-000000000000",
        ClientId = @var.Client_id,
        ClientSecret = @var.Client_secret,
    });

    var @this = new Databricks.Group("this", new()
    {
    }, new CustomResourceOptions
    {
        Provider = databricks.Mws,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.databricks.Provider;
import com.pulumi.databricks.ProviderArgs;
import com.pulumi.databricks.Group;
import com.pulumi.databricks.GroupArgs;
import com.pulumi.resources.CustomResourceOptions;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var mws = new Provider("mws", ProviderArgs.builder()        
            .host("https://accounts.cloud.databricks.com")
            .accountId("00000000-0000-0000-0000-000000000000")
            .clientId(var_.client_id())
            .clientSecret(var_.client_secret())
            .build());

        var this_ = new Group("this", GroupArgs.Empty, CustomResourceOptions.builder()
            .provider(databricks.mws())
            .build());

    }
}

    resources:
  # initialize provider at account-level
  mws:
    type: pulumi:providers:databricks
    properties:
      host: https://accounts.cloud.databricks.com
      accountId: 00000000-0000-0000-0000-000000000000
      clientId: ${var.client_id}
      clientSecret: ${var.client_secret}
  this:
    type: databricks:Group
    options:
      provider: ${databricks.mws}

    Creating group in Azure Databricks account:

    import * as pulumi from "@pulumi/pulumi";
import * as databricks from "@pulumi/databricks";

// initialize provider at Azure account-level
const azureAccount = new databricks.Provider("azureAccount", {
    host: "https://accounts.azuredatabricks.net",
    accountId: "00000000-0000-0000-0000-000000000000",
    authType: "azure-cli",
});
const _this = new databricks.Group("this", {}, {
    provider: databricks.azure_account,
});

    import pulumi
import pulumi_databricks as databricks

# initialize provider at Azure account-level
azure_account = databricks.Provider("azureAccount",
    host="https://accounts.azuredatabricks.net",
    account_id="00000000-0000-0000-0000-000000000000",
    auth_type="azure-cli")
this = databricks.Group("this", opts=pulumi.ResourceOptions(provider=databricks["azure_account"]))

    package main

import (
	"github.com/pulumi/pulumi-databricks/sdk/go/databricks"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// initialize provider at Azure account-level
		_, err := databricks.NewProvider(ctx, "azureAccount", &databricks.ProviderArgs{
			Host:      pulumi.String("https://accounts.azuredatabricks.net"),
			AccountId: pulumi.String("00000000-0000-0000-0000-000000000000"),
			AuthType:  pulumi.String("azure-cli"),
		})
		if err != nil {
			return err
		}
		_, err = databricks.NewGroup(ctx, "this", nil, pulumi.Provider(databricks.Azure_account))
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Databricks = Pulumi.Databricks;

return await Deployment.RunAsync(() => 
{
    // initialize provider at Azure account-level
    var azureAccount = new Databricks.Provider("azureAccount", new()
    {
        Host = "https://accounts.azuredatabricks.net",
        AccountId = "00000000-0000-0000-0000-000000000000",
        AuthType = "azure-cli",
    });

    var @this = new Databricks.Group("this", new()
    {
    }, new CustomResourceOptions
    {
        Provider = databricks.Azure_account,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.databricks.Provider;
import com.pulumi.databricks.ProviderArgs;
import com.pulumi.databricks.Group;
import com.pulumi.databricks.GroupArgs;
import com.pulumi.resources.CustomResourceOptions;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var azureAccount = new Provider("azureAccount", ProviderArgs.builder()        
            .host("https://accounts.azuredatabricks.net")
            .accountId("00000000-0000-0000-0000-000000000000")
            .authType("azure-cli")
            .build());

        var this_ = new Group("this", GroupArgs.Empty, CustomResourceOptions.builder()
            .provider(databricks.azure_account())
            .build());

    }
}

    resources:
  # initialize provider at Azure account-level
  azureAccount:
    type: pulumi:providers:databricks
    properties:
      host: https://accounts.azuredatabricks.net
      accountId: 00000000-0000-0000-0000-000000000000
      authType: azure-cli
  this:
    type: databricks:Group
    options:
      provider: ${databricks.azure_account}

    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: Optional[GroupArgs] = None,
          opts: Optional[ResourceOptions] = None)

@overload
def Group(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          acl_principal_id: Optional[str] = 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)
    func NewGroup(ctx *Context, name string, args *GroupArgs, opts ...ResourceOption) (*Group, error)
    public Group(string name, GroupArgs? args = null, 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.

    Example

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

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

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

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

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

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

    type: databricks:Group
properties:
    aclPrincipalId: string
    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

    The Group resource accepts the following input properties:

    AclPrincipalId string
    identifier for use in databricks_access_control_rule_set, e.g. groups/Some 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.
    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.
    AclPrincipalId string
    identifier for use in databricks_access_control_rule_set, e.g. groups/Some 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.
    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.
    aclPrincipalId String
    identifier for use in databricks_access_control_rule_set, e.g. groups/Some 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.
    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.
    aclPrincipalId string
    identifier for use in databricks_access_control_rule_set, e.g. groups/Some 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.
    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.
    acl_principal_id str
    identifier for use in databricks_access_control_rule_set, e.g. groups/Some 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.
    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.
    aclPrincipalId String
    identifier for use in databricks_access_control_rule_set, e.g. groups/Some 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.
    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.

    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,
        acl_principal_id: Optional[str] = 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)
    Resource lookup is not supported in YAML
    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:
    AclPrincipalId string
    identifier for use in databricks_access_control_rule_set, e.g. groups/Some 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.
    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.
    AclPrincipalId string
    identifier for use in databricks_access_control_rule_set, e.g. groups/Some 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.
    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.
    aclPrincipalId String
    identifier for use in databricks_access_control_rule_set, e.g. groups/Some 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.
    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.
    aclPrincipalId string
    identifier for use in databricks_access_control_rule_set, e.g. groups/Some 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.
    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.
    acl_principal_id str
    identifier for use in databricks_access_control_rule_set, e.g. groups/Some 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.
    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.
    aclPrincipalId String
    identifier for use in databricks_access_control_rule_set, e.g. groups/Some 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.
    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 following:

    bash

    $ 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
    Databricks v1.35.0 published on Friday, Mar 29, 2024 by Pulumi
    pulumi/pulumi-databricks