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

databricks.getAccountIamExternalGroupV2

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

    Retrieves an external group — a group that can be synced from your identity provider (IdP) — with the given external ID from the customer’s IdP. If the group does not exist in the account, it will be created. If the customer is not onboarded onto Automatic Identity Management (AIM), this returns an error.

    The name uses the format accounts/{account_id}/external-groups/{external_group_id}, where externalGroupId is the group’s object ID in the IdP (for example, a Microsoft Entra ID object ID).

    Note Reading this data source has a side effect: it resolves the group against the IdP and provisions the group in the account if it does not already exist.

    Note This data source can only be used with an account-level provider.

    Example Usage

    Referring to an external group by its resource name:

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

const example = databricks.getAccountIamExternalGroupV2({
    name: "accounts/00000000-0000-0000-0000-000000000000/external-groups/11111111-2222-3333-4444-555555555555",
});

    import pulumi
import pulumi_databricks as databricks

example = databricks.get_account_iam_external_group_v2(name="accounts/00000000-0000-0000-0000-000000000000/external-groups/11111111-2222-3333-4444-555555555555")

    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.GetAccountIamExternalGroupV2(ctx, &databricks.GetAccountIamExternalGroupV2Args{
			Name: "accounts/00000000-0000-0000-0000-000000000000/external-groups/11111111-2222-3333-4444-555555555555",
		}, 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 example = Databricks.GetAccountIamExternalGroupV2.Invoke(new()
    {
        Name = "accounts/00000000-0000-0000-0000-000000000000/external-groups/11111111-2222-3333-4444-555555555555",
    });

});

    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.GetAccountIamExternalGroupV2Args;
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 example = DatabricksFunctions.getAccountIamExternalGroupV2(GetAccountIamExternalGroupV2Args.builder()
            .name("accounts/00000000-0000-0000-0000-000000000000/external-groups/11111111-2222-3333-4444-555555555555")
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      function: databricks:getAccountIamExternalGroupV2
      arguments:
        name: accounts/00000000-0000-0000-0000-000000000000/external-groups/11111111-2222-3333-4444-555555555555

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

data "databricks_getaccountiamexternalgroupv2" "example" {
  name = "accounts/00000000-0000-0000-0000-000000000000/external-groups/11111111-2222-3333-4444-555555555555"
}

    Using getAccountIamExternalGroupV2

    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 getAccountIamExternalGroupV2(args: GetAccountIamExternalGroupV2Args, opts?: InvokeOptions): Promise<GetAccountIamExternalGroupV2Result>
function getAccountIamExternalGroupV2Output(args: GetAccountIamExternalGroupV2OutputArgs, opts?: InvokeOutputOptions): Output<GetAccountIamExternalGroupV2Result>
    def get_account_iam_external_group_v2(name: Optional[str] = None,
                                      opts: Optional[InvokeOptions] = None) -> GetAccountIamExternalGroupV2Result
def get_account_iam_external_group_v2_output(name: pulumi.Input[Optional[str]] = None,
                                      opts: Optional[InvokeOutputOptions] = None) -> Output[GetAccountIamExternalGroupV2Result]
    func GetAccountIamExternalGroupV2(ctx *Context, args *GetAccountIamExternalGroupV2Args, opts ...InvokeOption) (*GetAccountIamExternalGroupV2Result, error)
func GetAccountIamExternalGroupV2Output(ctx *Context, args *GetAccountIamExternalGroupV2OutputArgs, opts ...InvokeOption) GetAccountIamExternalGroupV2ResultOutput

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

    public static class GetAccountIamExternalGroupV2 
{
    public static Task<GetAccountIamExternalGroupV2Result> InvokeAsync(GetAccountIamExternalGroupV2Args args, InvokeOptions? opts = null)
    public static Output<GetAccountIamExternalGroupV2Result> Invoke(GetAccountIamExternalGroupV2InvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetAccountIamExternalGroupV2Result> Invoke(GetAccountIamExternalGroupV2InvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetAccountIamExternalGroupV2Result> getAccountIamExternalGroupV2(GetAccountIamExternalGroupV2Args args, InvokeOptions options)
public static Output<GetAccountIamExternalGroupV2Result> getAccountIamExternalGroupV2(GetAccountIamExternalGroupV2Args args, InvokeOptions options)
public static Output<GetAccountIamExternalGroupV2Result> getAccountIamExternalGroupV2(GetAccountIamExternalGroupV2Args args, InvokeOutputOptions options)

    fn::invoke:
  function: databricks:index/getAccountIamExternalGroupV2:getAccountIamExternalGroupV2
  arguments:
    # arguments dictionary
    data "databricks_get_account_iam_external_group_v2" "name" {
    # arguments
}

    The following arguments are supported:

    Name string
    The resource name of the external group. The format depends on the API that returned it:

    • Account-scoped: accounts/{account_id}/external-groups/{external_group_id}
    • Workspace-scoped: external-groups/{external_group_id}
    Name string
    The resource name of the external group. The format depends on the API that returned it:

    • Account-scoped: accounts/{account_id}/external-groups/{external_group_id}
    • Workspace-scoped: external-groups/{external_group_id}
    name string
    The resource name of the external group. The format depends on the API that returned it:

    • Account-scoped: accounts/{account_id}/external-groups/{external_group_id}
    • Workspace-scoped: external-groups/{external_group_id}
    name String
    The resource name of the external group. The format depends on the API that returned it:

    • Account-scoped: accounts/{account_id}/external-groups/{external_group_id}
    • Workspace-scoped: external-groups/{external_group_id}
    name string
    The resource name of the external group. The format depends on the API that returned it:

    • Account-scoped: accounts/{account_id}/external-groups/{external_group_id}
    • Workspace-scoped: external-groups/{external_group_id}
    name str
    The resource name of the external group. The format depends on the API that returned it:

    • Account-scoped: accounts/{account_id}/external-groups/{external_group_id}
    • Workspace-scoped: external-groups/{external_group_id}
    name String
    The resource name of the external group. The format depends on the API that returned it:

    • Account-scoped: accounts/{account_id}/external-groups/{external_group_id}
    • Workspace-scoped: external-groups/{external_group_id}

    getAccountIamExternalGroupV2 Result

    The following output properties are available:

    AccountId string
    (string) - The parent account ID, from Databricks
    DisplayName string
    (string) - Display name of the group from the customer's IdP
    ExternalGroupId string
    (string) - The external ID of the group in the customer's IdP
    InternalId string
    (string) - Internal groupId of the group in Databricks
    Name string
    (string) - The resource name of the external group. The format depends on the API that returned it:

    • Account-scoped: accounts/{account_id}/external-groups/{external_group_id}
    • Workspace-scoped: external-groups/{external_group_id}
    AccountId string
    (string) - The parent account ID, from Databricks
    DisplayName string
    (string) - Display name of the group from the customer's IdP
    ExternalGroupId string
    (string) - The external ID of the group in the customer's IdP
    InternalId string
    (string) - Internal groupId of the group in Databricks
    Name string
    (string) - The resource name of the external group. The format depends on the API that returned it:

    • Account-scoped: accounts/{account_id}/external-groups/{external_group_id}
    • Workspace-scoped: external-groups/{external_group_id}
    account_id string
    (string) - The parent account ID, from Databricks
    display_name string
    (string) - Display name of the group from the customer's IdP
    external_group_id string
    (string) - The external ID of the group in the customer's IdP
    internal_id string
    (string) - Internal groupId of the group in Databricks
    name string
    (string) - The resource name of the external group. The format depends on the API that returned it:

    • Account-scoped: accounts/{account_id}/external-groups/{external_group_id}
    • Workspace-scoped: external-groups/{external_group_id}
    accountId String
    (string) - The parent account ID, from Databricks
    displayName String
    (string) - Display name of the group from the customer's IdP
    externalGroupId String
    (string) - The external ID of the group in the customer's IdP
    internalId String
    (string) - Internal groupId of the group in Databricks
    name String
    (string) - The resource name of the external group. The format depends on the API that returned it:

    • Account-scoped: accounts/{account_id}/external-groups/{external_group_id}
    • Workspace-scoped: external-groups/{external_group_id}
    accountId string
    (string) - The parent account ID, from Databricks
    displayName string
    (string) - Display name of the group from the customer's IdP
    externalGroupId string
    (string) - The external ID of the group in the customer's IdP
    internalId string
    (string) - Internal groupId of the group in Databricks
    name string
    (string) - The resource name of the external group. The format depends on the API that returned it:

    • Account-scoped: accounts/{account_id}/external-groups/{external_group_id}
    • Workspace-scoped: external-groups/{external_group_id}
    account_id str
    (string) - The parent account ID, from Databricks
    display_name str
    (string) - Display name of the group from the customer's IdP
    external_group_id str
    (string) - The external ID of the group in the customer's IdP
    internal_id str
    (string) - Internal groupId of the group in Databricks
    name str
    (string) - The resource name of the external group. The format depends on the API that returned it:

    • Account-scoped: accounts/{account_id}/external-groups/{external_group_id}
    • Workspace-scoped: external-groups/{external_group_id}
    accountId String
    (string) - The parent account ID, from Databricks
    displayName String
    (string) - Display name of the group from the customer's IdP
    externalGroupId String
    (string) - The external ID of the group in the customer's IdP
    internalId String
    (string) - Internal groupId of the group in Databricks
    name String
    (string) - The resource name of the external group. The format depends on the API that returned it:

    • Account-scoped: accounts/{account_id}/external-groups/{external_group_id}
    • Workspace-scoped: external-groups/{external_group_id}

    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