databricks logo
Databricks v1.14.0, May 23 23

databricks.getServicePrincipals

Explore with Pulumi AI

Note If you have a fully automated setup with workspaces created by databricks_mws_workspaces, please make sure to add depends_on attribute in order to prevent default auth: cannot configure default credentials errors.

Retrieves application_ids of all databricks.ServicePrincipal based on their display_name

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 groups in Databricks Workspace or Account Console (for AWS deployments).
  • 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,
                           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,
                           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)
// Output-based functions aren't available in Java yet
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

DisplayNameContains string

Only return databricks.ServicePrincipal display name that match the given name string

ApplicationIds []string

List of application_ids of service principals Individual service principal can be retrieved using databricks.ServicePrincipal data source

DisplayNameContains string

Only return databricks.ServicePrincipal display name that match the given name string

applicationIds List<String>

List of application_ids of service principals Individual service principal can be retrieved using databricks.ServicePrincipal data source

displayNameContains String

Only return databricks.ServicePrincipal display name that match the given name string

applicationIds string[]

List of application_ids of service principals Individual service principal can be retrieved using databricks.ServicePrincipal data source

displayNameContains string

Only return databricks.ServicePrincipal display name that match the given name string

application_ids Sequence[str]

List of application_ids of service principals Individual service principal can be retrieved using databricks.ServicePrincipal data source

display_name_contains str

Only return databricks.ServicePrincipal display name that match the given name string

applicationIds List<String>

List of application_ids of service principals Individual service principal can be retrieved using databricks.ServicePrincipal data source

displayNameContains String

Only return databricks.ServicePrincipal display name that match the given name string

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

DisplayNameContains string
Id string

The provider-assigned unique ID for this managed resource.

ApplicationIds []string

List of application_ids of service principals Individual service principal can be retrieved using databricks.ServicePrincipal data source

DisplayNameContains string
Id string

The provider-assigned unique ID for this managed resource.

applicationIds List<String>

List of application_ids of service principals Individual service principal can be retrieved using databricks.ServicePrincipal data source

displayNameContains String
id String

The provider-assigned unique ID for this managed resource.

applicationIds string[]

List of application_ids of service principals Individual service principal can be retrieved using databricks.ServicePrincipal data source

displayNameContains string
id string

The provider-assigned unique ID for this managed resource.

application_ids Sequence[str]

List of application_ids of service principals Individual service principal can be retrieved using databricks.ServicePrincipal data source

display_name_contains str
id str

The provider-assigned unique ID for this managed resource.

applicationIds List<String>

List of application_ids of service principals Individual service principal can be retrieved using databricks.ServicePrincipal data source

displayNameContains String
id String

The provider-assigned unique ID for this managed resource.

Package Details

Repository
databricks pulumi/pulumi-databricks
License
Apache-2.0
Notes

This Pulumi package is based on the databricks Terraform Provider.