Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Databricks Provider
  4. API Docs
  5. WorkspaceIamGroupV2
Viewing docs for Databricks v1.109.0
published on Tuesday, Sep 8, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-databricks

databricks.WorkspaceIamGroupV2

databricks logo databricks logo
Viewing docs for Databricks v1.109.0
published on Tuesday, Sep 8, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-databricks

    Public Beta

    API Documentation

    Manages a group using a workspace-scoped provider. Creating the resource creates the group; deleting it removes the group.

    When Automatic Identity Management (AIM) is enabled for the account, this resource manages local groups only: a group cannot be created with externalId set. Groups that already have an externalId can still be read through this resource, but only their externalId may be updated — their other fields are sourced from the identity provider.

    Example Usage

    Example usage:

    Creates a group using a workspace-scoped provider. When AIM is enabled, the group cannot be created with externalId set.

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

const _this = new databricks.WorkspaceIamGroupV2("this", {groupName: "data-engineers"});

    import pulumi
import pulumi_databricks as databricks

this = databricks.WorkspaceIamGroupV2("this", group_name="data-engineers")

    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.NewWorkspaceIamGroupV2(ctx, "this", &databricks.WorkspaceIamGroupV2Args{
			GroupName: pulumi.String("data-engineers"),
		})
		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.WorkspaceIamGroupV2("this", new()
    {
        GroupName = "data-engineers",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.databricks.WorkspaceIamGroupV2;
import com.pulumi.databricks.WorkspaceIamGroupV2Args;
import java.util.ArrayList;
import java.util.Arrays;
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 WorkspaceIamGroupV2("this", WorkspaceIamGroupV2Args.builder()
            .groupName("data-engineers")
            .build());

    }
}

    resources:
  this:
    type: databricks:WorkspaceIamGroupV2
    properties:
      groupName: data-engineers

    pulumi {
  required_providers {
    databricks = {
      source = "pulumi/databricks"
    }
  }
}

resource "databricks_workspaceiamgroupv2" "this" {
  group_name = "data-engineers"
}

    Create WorkspaceIamGroupV2 Resource

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

    Constructor syntax

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

@overload
def WorkspaceIamGroupV2(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        external_id: Optional[str] = None,
                        group_name: Optional[str] = None,
                        provider_config: Optional[WorkspaceIamGroupV2ProviderConfigArgs] = None)
    func NewWorkspaceIamGroupV2(ctx *Context, name string, args *WorkspaceIamGroupV2Args, opts ...ResourceOption) (*WorkspaceIamGroupV2, error)
    public WorkspaceIamGroupV2(string name, WorkspaceIamGroupV2Args? args = null, CustomResourceOptions? opts = null)
    public WorkspaceIamGroupV2(String name, WorkspaceIamGroupV2Args args)
public WorkspaceIamGroupV2(String name, WorkspaceIamGroupV2Args args, CustomResourceOptions options)

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


    resource "databricks_workspace_iam_group_v2" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args WorkspaceIamGroupV2Args
    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 WorkspaceIamGroupV2Args
    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 WorkspaceIamGroupV2Args
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WorkspaceIamGroupV2Args
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WorkspaceIamGroupV2Args
    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 workspaceIamGroupV2Resource = new Databricks.WorkspaceIamGroupV2("workspaceIamGroupV2Resource", new()
{
    ExternalId = "string",
    GroupName = "string",
    ProviderConfig = new Databricks.Inputs.WorkspaceIamGroupV2ProviderConfigArgs
    {
        WorkspaceId = "string",
    },
});

    example, err := databricks.NewWorkspaceIamGroupV2(ctx, "workspaceIamGroupV2Resource", &databricks.WorkspaceIamGroupV2Args{
	ExternalId: pulumi.String("string"),
	GroupName:  pulumi.String("string"),
	ProviderConfig: &databricks.WorkspaceIamGroupV2ProviderConfigArgs{
		WorkspaceId: pulumi.String("string"),
	},
})

    resource "databricks_workspace_iam_group_v2" "workspaceIamGroupV2Resource" {
  lifecycle {
    create_before_destroy = true
  }
  external_id = "string"
  group_name  = "string"
  provider_config = {
    workspace_id = "string"
  }
}

    var workspaceIamGroupV2Resource = new WorkspaceIamGroupV2("workspaceIamGroupV2Resource", WorkspaceIamGroupV2Args.builder()
    .externalId("string")
    .groupName("string")
    .providerConfig(WorkspaceIamGroupV2ProviderConfigArgs.builder()
        .workspaceId("string")
        .build())
    .build());

    workspace_iam_group_v2_resource = databricks.WorkspaceIamGroupV2("workspaceIamGroupV2Resource",
    external_id="string",
    group_name="string",
    provider_config={
        "workspace_id": "string",
    })

    const workspaceIamGroupV2Resource = new databricks.WorkspaceIamGroupV2("workspaceIamGroupV2Resource", {
    externalId: "string",
    groupName: "string",
    providerConfig: {
        workspaceId: "string",
    },
});

    type: databricks:WorkspaceIamGroupV2
properties:
    externalId: string
    groupName: string
    providerConfig:
        workspaceId: string

    WorkspaceIamGroupV2 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 WorkspaceIamGroupV2 resource accepts the following input properties:

    ExternalId string
    ExternalId of the group in the customer's IdP
    GroupName string
    Display name of the group
    ProviderConfig WorkspaceIamGroupV2ProviderConfig
    Configure the provider for management through account provider.
    ExternalId string
    ExternalId of the group in the customer's IdP
    GroupName string
    Display name of the group
    ProviderConfig WorkspaceIamGroupV2ProviderConfigArgs
    Configure the provider for management through account provider.
    external_id string
    ExternalId of the group in the customer's IdP
    group_name string
    Display name of the group
    provider_config object
    Configure the provider for management through account provider.
    externalId String
    ExternalId of the group in the customer's IdP
    groupName String
    Display name of the group
    providerConfig WorkspaceIamGroupV2ProviderConfig
    Configure the provider for management through account provider.
    externalId string
    ExternalId of the group in the customer's IdP
    groupName string
    Display name of the group
    providerConfig WorkspaceIamGroupV2ProviderConfig
    Configure the provider for management through account provider.
    external_id str
    ExternalId of the group in the customer's IdP
    group_name str
    Display name of the group
    provider_config WorkspaceIamGroupV2ProviderConfigArgs
    Configure the provider for management through account provider.
    externalId String
    ExternalId of the group in the customer's IdP
    groupName String
    Display name of the group
    providerConfig Property Map
    Configure the provider for management through account provider.

    Outputs

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

    AccountId string
    (string) - The parent account ID for group in Databricks
    GroupId string
    (string) - Internal group ID of the group in Databricks
    Id string
    The provider-assigned unique ID for this managed resource.
    AccountId string
    (string) - The parent account ID for group in Databricks
    GroupId string
    (string) - Internal group ID of the group in Databricks
    Id string
    The provider-assigned unique ID for this managed resource.
    account_id string
    (string) - The parent account ID for group in Databricks
    group_id string
    (string) - Internal group ID of the group in Databricks
    id string
    The provider-assigned unique ID for this managed resource.
    accountId String
    (string) - The parent account ID for group in Databricks
    groupId String
    (string) - Internal group ID of the group in Databricks
    id String
    The provider-assigned unique ID for this managed resource.
    accountId string
    (string) - The parent account ID for group in Databricks
    groupId string
    (string) - Internal group ID of the group in Databricks
    id string
    The provider-assigned unique ID for this managed resource.
    account_id str
    (string) - The parent account ID for group in Databricks
    group_id str
    (string) - Internal group ID of the group in Databricks
    id str
    The provider-assigned unique ID for this managed resource.
    accountId String
    (string) - The parent account ID for group in Databricks
    groupId String
    (string) - Internal group ID of the group in Databricks
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing WorkspaceIamGroupV2 Resource

    Get an existing WorkspaceIamGroupV2 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?: WorkspaceIamGroupV2State, opts?: CustomResourceOptions): WorkspaceIamGroupV2
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_id: Optional[str] = None,
        external_id: Optional[str] = None,
        group_id: Optional[str] = None,
        group_name: Optional[str] = None,
        provider_config: Optional[WorkspaceIamGroupV2ProviderConfigArgs] = None) -> WorkspaceIamGroupV2
    func GetWorkspaceIamGroupV2(ctx *Context, name string, id IDInput, state *WorkspaceIamGroupV2State, opts ...ResourceOption) (*WorkspaceIamGroupV2, error)
    public static WorkspaceIamGroupV2 Get(string name, Input<string> id, WorkspaceIamGroupV2State? state, CustomResourceOptions? opts = null)
    public static WorkspaceIamGroupV2 get(String name, Output<String> id, WorkspaceIamGroupV2State state, CustomResourceOptions options)
    resources:  _:    type: databricks:WorkspaceIamGroupV2    get:      id: ${id}
    import {
  to = databricks_workspace_iam_group_v2.example
  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:
    AccountId string
    (string) - The parent account ID for group in Databricks
    ExternalId string
    ExternalId of the group in the customer's IdP
    GroupId string
    (string) - Internal group ID of the group in Databricks
    GroupName string
    Display name of the group
    ProviderConfig WorkspaceIamGroupV2ProviderConfig
    Configure the provider for management through account provider.
    AccountId string
    (string) - The parent account ID for group in Databricks
    ExternalId string
    ExternalId of the group in the customer's IdP
    GroupId string
    (string) - Internal group ID of the group in Databricks
    GroupName string
    Display name of the group
    ProviderConfig WorkspaceIamGroupV2ProviderConfigArgs
    Configure the provider for management through account provider.
    account_id string
    (string) - The parent account ID for group in Databricks
    external_id string
    ExternalId of the group in the customer's IdP
    group_id string
    (string) - Internal group ID of the group in Databricks
    group_name string
    Display name of the group
    provider_config object
    Configure the provider for management through account provider.
    accountId String
    (string) - The parent account ID for group in Databricks
    externalId String
    ExternalId of the group in the customer's IdP
    groupId String
    (string) - Internal group ID of the group in Databricks
    groupName String
    Display name of the group
    providerConfig WorkspaceIamGroupV2ProviderConfig
    Configure the provider for management through account provider.
    accountId string
    (string) - The parent account ID for group in Databricks
    externalId string
    ExternalId of the group in the customer's IdP
    groupId string
    (string) - Internal group ID of the group in Databricks
    groupName string
    Display name of the group
    providerConfig WorkspaceIamGroupV2ProviderConfig
    Configure the provider for management through account provider.
    account_id str
    (string) - The parent account ID for group in Databricks
    external_id str
    ExternalId of the group in the customer's IdP
    group_id str
    (string) - Internal group ID of the group in Databricks
    group_name str
    Display name of the group
    provider_config WorkspaceIamGroupV2ProviderConfigArgs
    Configure the provider for management through account provider.
    accountId String
    (string) - The parent account ID for group in Databricks
    externalId String
    ExternalId of the group in the customer's IdP
    groupId String
    (string) - Internal group ID of the group in Databricks
    groupName String
    Display name of the group
    providerConfig Property Map
    Configure the provider for management through account provider.

    Supporting Types

    WorkspaceIamGroupV2ProviderConfig, WorkspaceIamGroupV2ProviderConfigArgs

    WorkspaceId string
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    WorkspaceId string
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspace_id string
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspaceId String
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspaceId string
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspace_id str
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspaceId String
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.

    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 logo
    Viewing docs for Databricks v1.109.0
    published on Tuesday, Sep 8, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-databricks

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial