1. Registry
  2. Packages
  3. Databricks Provider
  4. API Docs
  5. getWorkspaceIamGroupsV2
Viewing docs for Databricks v1.109.0
published on Tuesday, Sep 8, 2026 by Pulumi
databricks logo databricks logo
Viewing docs for Databricks v1.109.0
published on Tuesday, Sep 8, 2026 by Pulumi

    Public Beta

    API Documentation

    Lists the groups visible to a workspace, using a workspace-scoped provider.

    Example Usage

    Example usage:

    List all groups visible to the workspace, using a workspace-scoped provider.

    import * as pulumi from "@pulumi/pulumi";
    import * as databricks from "@pulumi/databricks";
    
    const _this = databricks.getWorkspaceIamGroupsV2({});
    
    import pulumi
    import pulumi_databricks as databricks
    
    this = databricks.get_workspace_iam_groups_v2()
    
    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.GetWorkspaceIamGroupsV2(ctx, &databricks.GetWorkspaceIamGroupsV2Args{}, nil)
    		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 = Databricks.GetWorkspaceIamGroupsV2.Invoke();
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.databricks.DatabricksFunctions;
    import com.pulumi.databricks.inputs.GetWorkspaceIamGroupsV2Args;
    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) {
            final var this = DatabricksFunctions.getWorkspaceIamGroupsV2(GetWorkspaceIamGroupsV2Args.builder()
                .build());
    
        }
    }
    
    variables:
      this:
        fn::invoke:
          function: databricks:getWorkspaceIamGroupsV2
          arguments: {}
    
    pulumi {
      required_providers {
        databricks = {
          source = "pulumi/databricks"
        }
      }
    }
    
    data "databricks_getworkspaceiamgroupsv2" "this" {
    }
    

    Using getWorkspaceIamGroupsV2

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getWorkspaceIamGroupsV2(args: GetWorkspaceIamGroupsV2Args, opts?: InvokeOptions): Promise<GetWorkspaceIamGroupsV2Result>
    function getWorkspaceIamGroupsV2Output(args: GetWorkspaceIamGroupsV2OutputArgs, opts?: InvokeOutputOptions): Output<GetWorkspaceIamGroupsV2Result>
    def get_workspace_iam_groups_v2(filter: Optional[str] = None,
                                    page_size: Optional[int] = None,
                                    provider_config: Optional[GetWorkspaceIamGroupsV2ProviderConfig] = None,
                                    opts: Optional[InvokeOptions] = None) -> GetWorkspaceIamGroupsV2Result
    def get_workspace_iam_groups_v2_output(filter: pulumi.Input[Optional[str]] = None,
                                    page_size: pulumi.Input[Optional[int]] = None,
                                    provider_config: pulumi.Input[Optional[GetWorkspaceIamGroupsV2ProviderConfigArgs]] = None,
                                    opts: Optional[InvokeOutputOptions] = None) -> Output[GetWorkspaceIamGroupsV2Result]
    func GetWorkspaceIamGroupsV2(ctx *Context, args *GetWorkspaceIamGroupsV2Args, opts ...InvokeOption) (*GetWorkspaceIamGroupsV2Result, error)
    func GetWorkspaceIamGroupsV2Output(ctx *Context, args *GetWorkspaceIamGroupsV2OutputArgs, opts ...InvokeOption) GetWorkspaceIamGroupsV2ResultOutput

    > Note: This function is named GetWorkspaceIamGroupsV2 in the Go SDK.

    public static class GetWorkspaceIamGroupsV2 
    {
        public static Task<GetWorkspaceIamGroupsV2Result> InvokeAsync(GetWorkspaceIamGroupsV2Args args, InvokeOptions? opts = null)
        public static Output<GetWorkspaceIamGroupsV2Result> Invoke(GetWorkspaceIamGroupsV2InvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetWorkspaceIamGroupsV2Result> Invoke(GetWorkspaceIamGroupsV2InvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetWorkspaceIamGroupsV2Result> getWorkspaceIamGroupsV2(GetWorkspaceIamGroupsV2Args args, InvokeOptions options)
    public static Output<GetWorkspaceIamGroupsV2Result> getWorkspaceIamGroupsV2(GetWorkspaceIamGroupsV2Args args, InvokeOptions options)
    public static Output<GetWorkspaceIamGroupsV2Result> getWorkspaceIamGroupsV2(GetWorkspaceIamGroupsV2Args args, InvokeOutputOptions options)
    
    fn::invoke:
      function: databricks:index/getWorkspaceIamGroupsV2:getWorkspaceIamGroupsV2
      arguments:
        # arguments dictionary
    data "databricks_get_workspace_iam_groups_v2" "name" {
        # arguments
    }

    The following arguments are supported:

    Filter string
    Optional. Allows filtering groups by group name or external id
    PageSize int
    The maximum number of groups to return. The service may return fewer than this value. If not provided, defaults to 1000, which is also the maximum allowed. Requests for more than the maximum are clamped to 1000
    ProviderConfig GetWorkspaceIamGroupsV2ProviderConfig
    Configure the provider for management through account provider.
    Filter string
    Optional. Allows filtering groups by group name or external id
    PageSize int
    The maximum number of groups to return. The service may return fewer than this value. If not provided, defaults to 1000, which is also the maximum allowed. Requests for more than the maximum are clamped to 1000
    ProviderConfig GetWorkspaceIamGroupsV2ProviderConfig
    Configure the provider for management through account provider.
    filter string
    Optional. Allows filtering groups by group name or external id
    page_size number
    The maximum number of groups to return. The service may return fewer than this value. If not provided, defaults to 1000, which is also the maximum allowed. Requests for more than the maximum are clamped to 1000
    provider_config object
    Configure the provider for management through account provider.
    filter String
    Optional. Allows filtering groups by group name or external id
    pageSize Integer
    The maximum number of groups to return. The service may return fewer than this value. If not provided, defaults to 1000, which is also the maximum allowed. Requests for more than the maximum are clamped to 1000
    providerConfig GetWorkspaceIamGroupsV2ProviderConfig
    Configure the provider for management through account provider.
    filter string
    Optional. Allows filtering groups by group name or external id
    pageSize number
    The maximum number of groups to return. The service may return fewer than this value. If not provided, defaults to 1000, which is also the maximum allowed. Requests for more than the maximum are clamped to 1000
    providerConfig GetWorkspaceIamGroupsV2ProviderConfig
    Configure the provider for management through account provider.
    filter str
    Optional. Allows filtering groups by group name or external id
    page_size int
    The maximum number of groups to return. The service may return fewer than this value. If not provided, defaults to 1000, which is also the maximum allowed. Requests for more than the maximum are clamped to 1000
    provider_config GetWorkspaceIamGroupsV2ProviderConfig
    Configure the provider for management through account provider.
    filter String
    Optional. Allows filtering groups by group name or external id
    pageSize Number
    The maximum number of groups to return. The service may return fewer than this value. If not provided, defaults to 1000, which is also the maximum allowed. Requests for more than the maximum are clamped to 1000
    providerConfig Property Map
    Configure the provider for management through account provider.

    getWorkspaceIamGroupsV2 Result

    The following output properties are available:

    Supporting Types

    GetWorkspaceIamGroupsV2Group

    AccountId string
    (string) - The parent account ID for group in Databricks
    ExternalId string
    (string) - ExternalId of the group in the customer's IdP
    GroupId string
    (string) - Internal group ID of the group in Databricks
    GroupName string
    (string) - Display name of the group
    ProviderConfig GetWorkspaceIamGroupsV2GroupProviderConfig
    Configure the provider for management through account provider.
    AccountId string
    (string) - The parent account ID for group in Databricks
    ExternalId string
    (string) - ExternalId of the group in the customer's IdP
    GroupId string
    (string) - Internal group ID of the group in Databricks
    GroupName string
    (string) - Display name of the group
    ProviderConfig GetWorkspaceIamGroupsV2GroupProviderConfig
    Configure the provider for management through account provider.
    account_id string
    (string) - The parent account ID for group in Databricks
    external_id string
    (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
    (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
    (string) - ExternalId of the group in the customer's IdP
    groupId String
    (string) - Internal group ID of the group in Databricks
    groupName String
    (string) - Display name of the group
    providerConfig GetWorkspaceIamGroupsV2GroupProviderConfig
    Configure the provider for management through account provider.
    accountId string
    (string) - The parent account ID for group in Databricks
    externalId string
    (string) - ExternalId of the group in the customer's IdP
    groupId string
    (string) - Internal group ID of the group in Databricks
    groupName string
    (string) - Display name of the group
    providerConfig GetWorkspaceIamGroupsV2GroupProviderConfig
    Configure the provider for management through account provider.
    account_id str
    (string) - The parent account ID for group in Databricks
    external_id str
    (string) - ExternalId of the group in the customer's IdP
    group_id str
    (string) - Internal group ID of the group in Databricks
    group_name str
    (string) - Display name of the group
    provider_config GetWorkspaceIamGroupsV2GroupProviderConfig
    Configure the provider for management through account provider.
    accountId String
    (string) - The parent account ID for group in Databricks
    externalId String
    (string) - ExternalId of the group in the customer's IdP
    groupId String
    (string) - Internal group ID of the group in Databricks
    groupName String
    (string) - Display name of the group
    providerConfig Property Map
    Configure the provider for management through account provider.

    GetWorkspaceIamGroupsV2GroupProviderConfig

    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.

    GetWorkspaceIamGroupsV2ProviderConfig

    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

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial