1. Packages
  2. Databricks Provider
  3. API Docs
  4. getServicePrincipals
Viewing docs for Databricks v1.90.0
published on Thursday, Mar 19, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-databricks

databricks.getServicePrincipals

databricks logo
Viewing docs for Databricks v1.90.0
published on Thursday, Mar 19, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-databricks

    Retrieves application_ids of all databricks.ServicePrincipal based on their display_name

    This data source can be used with an account or workspace-level provider.

    Example Usage

    Adding all service principals of which display name contains my-spn to admin group

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

export = async () => {
    const admins = await databricks.getGroup({
        displayName: "admins",
    });
    const spns = await databricks.getServicePrincipals({
        displayNameContains: "my-spn",
    });
    const spn = .reduce((__obj, [__key, __value]) => ({ ...__obj, [__key]: await databricks.getServicePrincipal({
        applicationId: __value,
    }) }));
    const myMemberSpn: databricks.GroupMember[] = [];
    for (const range of std.toset({
        input: spns.applicationIds,
    }).result.map((v, k) => ({key: k, value: v}))) {
        myMemberSpn.push(new databricks.GroupMember(`my_member_spn-${range.key}`, {
            groupId: admins.id,
            memberId: spn[range.value].spId,
        }));
    }
}

    import pulumi
import pulumi_databricks as databricks
import pulumi_std as std

admins = databricks.get_group(display_name="admins")
spns = databricks.get_service_principals(display_name_contains="my-spn")
spn = {__key: databricks.get_service_principal(application_id=__value) for __key, __value in std.toset(input=spns.application_ids).result}
my_member_spn = []
for range in [{"key": k, "value": v} for [k, v] in enumerate(std.toset(input=spns.application_ids).result)]:
    my_member_spn.append(databricks.GroupMember(f"my_member_spn-{range['key']}",
        group_id=admins.id,
        member_id=spn[range["value"]].sp_id))

    Example coming soon!

    using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Pulumi;
using Databricks = Pulumi.Databricks;
using Std = Pulumi.Std;

return await Deployment.RunAsync(async() => 
{
    var admins = await Databricks.GetGroup.InvokeAsync(new()
    {
        DisplayName = "admins",
    });

    var spns = await Databricks.GetServicePrincipals.InvokeAsync(new()
    {
        DisplayNameContains = "my-spn",
    });

    var spn = ;

    var myMemberSpn = new List<Databricks.GroupMember>();
    foreach (var range in )
    {
        myMemberSpn.Add(new Databricks.GroupMember($"my_member_spn-{range.Key}", new()
        {
            GroupId = admins.Id,
            MemberId = spn[range.Value].SpId,
        }));
    }
});

    Example coming soon!

    Example coming soon!

    The following resources are used in the same context:

    • End to end workspace management guide. - databricks.getCurrentUser data to retrieve information about databricks.User or databricks_service_principal, that is calling Databricks REST API. - databricks.Group to manage Account-level or Workspace-level groups. - databricks.Group data to retrieve information about databricks.Group members, entitlements and instance profiles. - databricks.GroupInstanceProfile to attach databricks.InstanceProfile (AWS) to databricks_group. - databricks.GroupMember to attach users and groups as group members. - databricks.Permissions to manage access control in Databricks workspace. - databricks_service principal to manage service principals

    Using getServicePrincipals

    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 getServicePrincipals(args: GetServicePrincipalsArgs, opts?: InvokeOptions): Promise<GetServicePrincipalsResult>
function getServicePrincipalsOutput(args: GetServicePrincipalsOutputArgs, opts?: InvokeOptions): Output<GetServicePrincipalsResult>
    def get_service_principals(application_ids: Optional[Sequence[str]] = None,
                           display_name_contains: Optional[str] = None,
                           provider_config: Optional[GetServicePrincipalsProviderConfig] = None,
                           service_principals: Optional[Sequence[GetServicePrincipalsServicePrincipal]] = None,
                           opts: Optional[InvokeOptions] = None) -> GetServicePrincipalsResult
def get_service_principals_output(application_ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                           display_name_contains: Optional[pulumi.Input[str]] = None,
                           provider_config: Optional[pulumi.Input[GetServicePrincipalsProviderConfigArgs]] = None,
                           service_principals: Optional[pulumi.Input[Sequence[pulumi.Input[GetServicePrincipalsServicePrincipalArgs]]]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetServicePrincipalsResult]
    func GetServicePrincipals(ctx *Context, args *GetServicePrincipalsArgs, opts ...InvokeOption) (*GetServicePrincipalsResult, error)
func GetServicePrincipalsOutput(ctx *Context, args *GetServicePrincipalsOutputArgs, opts ...InvokeOption) GetServicePrincipalsResultOutput

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

    public static class GetServicePrincipals 
{
    public static Task<GetServicePrincipalsResult> InvokeAsync(GetServicePrincipalsArgs args, InvokeOptions? opts = null)
    public static Output<GetServicePrincipalsResult> Invoke(GetServicePrincipalsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetServicePrincipalsResult> getServicePrincipals(GetServicePrincipalsArgs args, InvokeOptions options)
public static Output<GetServicePrincipalsResult> getServicePrincipals(GetServicePrincipalsArgs args, InvokeOptions options)

    fn::invoke:
  function: databricks:index/getServicePrincipals:getServicePrincipals
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ApplicationIds List<string>
    List of application_ids of service principals. Individual service principal can be retrieved using databricks.ServicePrincipal data source or from service_principals attribute.
    DisplayNameContains string
    Only return databricks.ServicePrincipal display name that match the given name string
    ProviderConfig GetServicePrincipalsProviderConfig
    Configure the provider for management through account provider. This block consists of the following fields:
    ServicePrincipals List<GetServicePrincipalsServicePrincipal>
    List of objects describing individual service principals. Each object has the following attributes:
    ApplicationIds []string
    List of application_ids of service principals. Individual service principal can be retrieved using databricks.ServicePrincipal data source or from service_principals attribute.
    DisplayNameContains string
    Only return databricks.ServicePrincipal display name that match the given name string
    ProviderConfig GetServicePrincipalsProviderConfig
    Configure the provider for management through account provider. This block consists of the following fields:
    ServicePrincipals []GetServicePrincipalsServicePrincipal
    List of objects describing individual service principals. Each object has the following attributes:
    applicationIds List<String>
    List of application_ids of service principals. Individual service principal can be retrieved using databricks.ServicePrincipal data source or from service_principals attribute.
    displayNameContains String
    Only return databricks.ServicePrincipal display name that match the given name string
    providerConfig GetServicePrincipalsProviderConfig
    Configure the provider for management through account provider. This block consists of the following fields:
    servicePrincipals List<GetServicePrincipalsServicePrincipal>
    List of objects describing individual service principals. Each object has the following attributes:
    applicationIds string[]
    List of application_ids of service principals. Individual service principal can be retrieved using databricks.ServicePrincipal data source or from service_principals attribute.
    displayNameContains string
    Only return databricks.ServicePrincipal display name that match the given name string
    providerConfig GetServicePrincipalsProviderConfig
    Configure the provider for management through account provider. This block consists of the following fields:
    servicePrincipals GetServicePrincipalsServicePrincipal[]
    List of objects describing individual service principals. Each object has the following attributes:
    application_ids Sequence[str]
    List of application_ids of service principals. Individual service principal can be retrieved using databricks.ServicePrincipal data source or from service_principals attribute.
    display_name_contains str
    Only return databricks.ServicePrincipal display name that match the given name string
    provider_config GetServicePrincipalsProviderConfig
    Configure the provider for management through account provider. This block consists of the following fields:
    service_principals Sequence[GetServicePrincipalsServicePrincipal]
    List of objects describing individual service principals. Each object has the following attributes:
    applicationIds List<String>
    List of application_ids of service principals. Individual service principal can be retrieved using databricks.ServicePrincipal data source or from service_principals attribute.
    displayNameContains String
    Only return databricks.ServicePrincipal display name that match the given name string
    providerConfig Property Map
    Configure the provider for management through account provider. This block consists of the following fields:
    servicePrincipals List<Property Map>
    List of objects describing individual service principals. Each object has the following attributes:

    getServicePrincipals Result

    The following output properties are available:

    ApplicationIds List<string>
    List of application_ids of service principals. Individual service principal can be retrieved using databricks.ServicePrincipal data source or from service_principals attribute.
    DisplayNameContains string
    Id string
    The provider-assigned unique ID for this managed resource.
    ServicePrincipals List<GetServicePrincipalsServicePrincipal>
    List of objects describing individual service principals. Each object has the following attributes:
    ProviderConfig GetServicePrincipalsProviderConfig
    ApplicationIds []string
    List of application_ids of service principals. Individual service principal can be retrieved using databricks.ServicePrincipal data source or from service_principals attribute.
    DisplayNameContains string
    Id string
    The provider-assigned unique ID for this managed resource.
    ServicePrincipals []GetServicePrincipalsServicePrincipal
    List of objects describing individual service principals. Each object has the following attributes:
    ProviderConfig GetServicePrincipalsProviderConfig
    applicationIds List<String>
    List of application_ids of service principals. Individual service principal can be retrieved using databricks.ServicePrincipal data source or from service_principals attribute.
    displayNameContains String
    id String
    The provider-assigned unique ID for this managed resource.
    servicePrincipals List<GetServicePrincipalsServicePrincipal>
    List of objects describing individual service principals. Each object has the following attributes:
    providerConfig GetServicePrincipalsProviderConfig
    applicationIds string[]
    List of application_ids of service principals. Individual service principal can be retrieved using databricks.ServicePrincipal data source or from service_principals attribute.
    displayNameContains string
    id string
    The provider-assigned unique ID for this managed resource.
    servicePrincipals GetServicePrincipalsServicePrincipal[]
    List of objects describing individual service principals. Each object has the following attributes:
    providerConfig GetServicePrincipalsProviderConfig
    application_ids Sequence[str]
    List of application_ids of service principals. Individual service principal can be retrieved using databricks.ServicePrincipal data source or from service_principals attribute.
    display_name_contains str
    id str
    The provider-assigned unique ID for this managed resource.
    service_principals Sequence[GetServicePrincipalsServicePrincipal]
    List of objects describing individual service principals. Each object has the following attributes:
    provider_config GetServicePrincipalsProviderConfig
    applicationIds List<String>
    List of application_ids of service principals. Individual service principal can be retrieved using databricks.ServicePrincipal data source or from service_principals attribute.
    displayNameContains String
    id String
    The provider-assigned unique ID for this managed resource.
    servicePrincipals List<Property Map>
    List of objects describing individual service principals. Each object has the following attributes:
    providerConfig Property Map

    Supporting Types

    GetServicePrincipalsProviderConfig

    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.
    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.

    GetServicePrincipalsServicePrincipal

    AclPrincipalId string
    identifier for use in databricks_access_control_rule_set, e.g. servicePrincipals/00000000-0000-0000-0000-000000000000.
    Active bool
    Whether service principal is active or not.
    ApplicationId string
    Application ID of the service principal.
    DisplayName string
    Display name of the service principal, e.g. Foo SPN.
    ExternalId string
    ID of the service principal in an external identity provider.
    Home string
    Home folder of the service principal, e.g. /Users/11111111-2222-3333-4444-555666777888.
    Id string
    The id of the service principal (SCIM ID).
    Repos string
    Repos location of the service principal, e.g. /Repos/11111111-2222-3333-4444-555666777888.
    ScimId string
    same as id.
    SpId string
    AclPrincipalId string
    identifier for use in databricks_access_control_rule_set, e.g. servicePrincipals/00000000-0000-0000-0000-000000000000.
    Active bool
    Whether service principal is active or not.
    ApplicationId string
    Application ID of the service principal.
    DisplayName string
    Display name of the service principal, e.g. Foo SPN.
    ExternalId string
    ID of the service principal in an external identity provider.
    Home string
    Home folder of the service principal, e.g. /Users/11111111-2222-3333-4444-555666777888.
    Id string
    The id of the service principal (SCIM ID).
    Repos string
    Repos location of the service principal, e.g. /Repos/11111111-2222-3333-4444-555666777888.
    ScimId string
    same as id.
    SpId string
    aclPrincipalId String
    identifier for use in databricks_access_control_rule_set, e.g. servicePrincipals/00000000-0000-0000-0000-000000000000.
    active Boolean
    Whether service principal is active or not.
    applicationId String
    Application ID of the service principal.
    displayName String
    Display name of the service principal, e.g. Foo SPN.
    externalId String
    ID of the service principal in an external identity provider.
    home String
    Home folder of the service principal, e.g. /Users/11111111-2222-3333-4444-555666777888.
    id String
    The id of the service principal (SCIM ID).
    repos String
    Repos location of the service principal, e.g. /Repos/11111111-2222-3333-4444-555666777888.
    scimId String
    same as id.
    spId String
    aclPrincipalId string
    identifier for use in databricks_access_control_rule_set, e.g. servicePrincipals/00000000-0000-0000-0000-000000000000.
    active boolean
    Whether service principal is active or not.
    applicationId string
    Application ID of the service principal.
    displayName string
    Display name of the service principal, e.g. Foo SPN.
    externalId string
    ID of the service principal in an external identity provider.
    home string
    Home folder of the service principal, e.g. /Users/11111111-2222-3333-4444-555666777888.
    id string
    The id of the service principal (SCIM ID).
    repos string
    Repos location of the service principal, e.g. /Repos/11111111-2222-3333-4444-555666777888.
    scimId string
    same as id.
    spId string
    acl_principal_id str
    identifier for use in databricks_access_control_rule_set, e.g. servicePrincipals/00000000-0000-0000-0000-000000000000.
    active bool
    Whether service principal is active or not.
    application_id str
    Application ID of the service principal.
    display_name str
    Display name of the service principal, e.g. Foo SPN.
    external_id str
    ID of the service principal in an external identity provider.
    home str
    Home folder of the service principal, e.g. /Users/11111111-2222-3333-4444-555666777888.
    id str
    The id of the service principal (SCIM ID).
    repos str
    Repos location of the service principal, e.g. /Repos/11111111-2222-3333-4444-555666777888.
    scim_id str
    same as id.
    sp_id str
    aclPrincipalId String
    identifier for use in databricks_access_control_rule_set, e.g. servicePrincipals/00000000-0000-0000-0000-000000000000.
    active Boolean
    Whether service principal is active or not.
    applicationId String
    Application ID of the service principal.
    displayName String
    Display name of the service principal, e.g. Foo SPN.
    externalId String
    ID of the service principal in an external identity provider.
    home String
    Home folder of the service principal, e.g. /Users/11111111-2222-3333-4444-555666777888.
    id String
    The id of the service principal (SCIM ID).
    repos String
    Repos location of the service principal, e.g. /Repos/11111111-2222-3333-4444-555666777888.
    scimId String
    same as id.
    spId String

    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 v1.90.0
    published on Thursday, Mar 19, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-databricks
      Try Pulumi Cloud free. Your team will thank you.