databricks.ServicePrincipal (v0)

Databricks v0.4.0 (0.x), Mar 9 26

Viewing docs for Databricks v0.4.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-databricks

Viewing docs for Databricks v0.4.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-databricks

End to end workspace management guide.
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_group_member to attach users and groups as group members.
databricks.Permissions to manage access control in Databricks workspace.
databricks.SqlPermissions to manage data object access control lists in Databricks workspaces for things like tables, views, databases, and [more](https://docs.databricks.

Create ServicePrincipal Resource

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

Constructor syntax

new ServicePrincipal(name: string, args?: ServicePrincipalArgs, opts?: CustomResourceOptions);

@overload
def ServicePrincipal(resource_name: str,
                     args: Optional[ServicePrincipalArgs] = None,
                     opts: Optional[ResourceOptions] = None)

@overload
def ServicePrincipal(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     active: Optional[bool] = None,
                     allow_cluster_create: Optional[bool] = None,
                     allow_instance_pool_create: Optional[bool] = None,
                     application_id: Optional[str] = None,
                     databricks_sql_access: Optional[bool] = None,
                     display_name: Optional[str] = None,
                     workspace_access: Optional[bool] = None)

func NewServicePrincipal(ctx *Context, name string, args *ServicePrincipalArgs, opts ...ResourceOption) (*ServicePrincipal, error)

public ServicePrincipal(string name, ServicePrincipalArgs? args = null, CustomResourceOptions? opts = null)

public ServicePrincipal(String name, ServicePrincipalArgs args)
public ServicePrincipal(String name, ServicePrincipalArgs args, CustomResourceOptions options)

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

Parameters

name string: The unique name of the resource.
args ServicePrincipalArgs: 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 ServicePrincipalArgs: 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 ServicePrincipalArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ServicePrincipalArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ServicePrincipalArgs: 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 servicePrincipalResource = new Databricks.ServicePrincipal("servicePrincipalResource", new()
{
    Active = false,
    AllowClusterCreate = false,
    AllowInstancePoolCreate = false,
    ApplicationId = "string",
    DatabricksSqlAccess = false,
    DisplayName = "string",
    WorkspaceAccess = false,
});

example, err := databricks.NewServicePrincipal(ctx, "servicePrincipalResource", &databricks.ServicePrincipalArgs{
	Active:                  pulumi.Bool(false),
	AllowClusterCreate:      pulumi.Bool(false),
	AllowInstancePoolCreate: pulumi.Bool(false),
	ApplicationId:           pulumi.String("string"),
	DatabricksSqlAccess:     pulumi.Bool(false),
	DisplayName:             pulumi.String("string"),
	WorkspaceAccess:         pulumi.Bool(false),
})

var servicePrincipalResource = new ServicePrincipal("servicePrincipalResource", ServicePrincipalArgs.builder()
    .active(false)
    .allowClusterCreate(false)
    .allowInstancePoolCreate(false)
    .applicationId("string")
    .databricksSqlAccess(false)
    .displayName("string")
    .workspaceAccess(false)
    .build());

service_principal_resource = databricks.ServicePrincipal("servicePrincipalResource",
    active=False,
    allow_cluster_create=False,
    allow_instance_pool_create=False,
    application_id="string",
    databricks_sql_access=False,
    display_name="string",
    workspace_access=False)

const servicePrincipalResource = new databricks.ServicePrincipal("servicePrincipalResource", {
    active: false,
    allowClusterCreate: false,
    allowInstancePoolCreate: false,
    applicationId: "string",
    databricksSqlAccess: false,
    displayName: "string",
    workspaceAccess: false,
});

type: databricks:ServicePrincipal
properties:
    active: false
    allowClusterCreate: false
    allowInstancePoolCreate: false
    applicationId: string
    databricksSqlAccess: false
    displayName: string
    workspaceAccess: false

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

Active bool: Either service principal is active or not. True by default, but can be set to false in case of service principal deactivation with preserving service principal assets.
AllowClusterCreate bool: Allow the service principal to have cluster create privileges. Defaults to false. More fine grained permissions could be assigned with databricks.Permissions and cluster_id argument. Everyone without allow_cluster_create argument set, but with permission to use Cluster Policy would be able to create clusters, but within the boundaries of that specific policy.
AllowInstancePoolCreate bool: Allow the service principal to have instance pool create privileges. Defaults to false. More fine grained permissions could be assigned with databricks.Permissions and instance_pool_id argument.
ApplicationId string: This is the application id of the given service principal and will be their form of access and identity. On other clouds than Azure this value is auto-generated.
DatabricksSqlAccess bool: This is a field to allow the group to have access to Databricks SQL feature through databricks_sql_endpoint.
DisplayName string: This is an alias for the service principal and can be the full name of the service principal.
WorkspaceAccess bool: This is a field to allow the group to have access to Databricks Workspace.

Active bool: Either service principal is active or not. True by default, but can be set to false in case of service principal deactivation with preserving service principal assets.
AllowClusterCreate bool: Allow the service principal to have cluster create privileges. Defaults to false. More fine grained permissions could be assigned with databricks.Permissions and cluster_id argument. Everyone without allow_cluster_create argument set, but with permission to use Cluster Policy would be able to create clusters, but within the boundaries of that specific policy.
AllowInstancePoolCreate bool: Allow the service principal to have instance pool create privileges. Defaults to false. More fine grained permissions could be assigned with databricks.Permissions and instance_pool_id argument.
ApplicationId string: This is the application id of the given service principal and will be their form of access and identity. On other clouds than Azure this value is auto-generated.
DatabricksSqlAccess bool: This is a field to allow the group to have access to Databricks SQL feature through databricks_sql_endpoint.
DisplayName string: This is an alias for the service principal and can be the full name of the service principal.
WorkspaceAccess bool: This is a field to allow the group to have access to Databricks Workspace.

active Boolean: Either service principal is active or not. True by default, but can be set to false in case of service principal deactivation with preserving service principal assets.
allowClusterCreate Boolean: Allow the service principal to have cluster create privileges. Defaults to false. More fine grained permissions could be assigned with databricks.Permissions and cluster_id argument. Everyone without allow_cluster_create argument set, but with permission to use Cluster Policy would be able to create clusters, but within the boundaries of that specific policy.
allowInstancePoolCreate Boolean: Allow the service principal to have instance pool create privileges. Defaults to false. More fine grained permissions could be assigned with databricks.Permissions and instance_pool_id argument.
applicationId String: This is the application id of the given service principal and will be their form of access and identity. On other clouds than Azure this value is auto-generated.
databricksSqlAccess Boolean: This is a field to allow the group to have access to Databricks SQL feature through databricks_sql_endpoint.
displayName String: This is an alias for the service principal and can be the full name of the service principal.
workspaceAccess Boolean: This is a field to allow the group to have access to Databricks Workspace.

active boolean: Either service principal is active or not. True by default, but can be set to false in case of service principal deactivation with preserving service principal assets.
allowClusterCreate boolean: Allow the service principal to have cluster create privileges. Defaults to false. More fine grained permissions could be assigned with databricks.Permissions and cluster_id argument. Everyone without allow_cluster_create argument set, but with permission to use Cluster Policy would be able to create clusters, but within the boundaries of that specific policy.
allowInstancePoolCreate boolean: Allow the service principal to have instance pool create privileges. Defaults to false. More fine grained permissions could be assigned with databricks.Permissions and instance_pool_id argument.
applicationId string: This is the application id of the given service principal and will be their form of access and identity. On other clouds than Azure this value is auto-generated.
databricksSqlAccess boolean: This is a field to allow the group to have access to Databricks SQL feature through databricks_sql_endpoint.
displayName string: This is an alias for the service principal and can be the full name of the service principal.
workspaceAccess boolean: This is a field to allow the group to have access to Databricks Workspace.

active bool: Either service principal is active or not. True by default, but can be set to false in case of service principal deactivation with preserving service principal assets.
allow_cluster_create bool: Allow the service principal to have cluster create privileges. Defaults to false. More fine grained permissions could be assigned with databricks.Permissions and cluster_id argument. Everyone without allow_cluster_create argument set, but with permission to use Cluster Policy would be able to create clusters, but within the boundaries of that specific policy.
allow_instance_pool_create bool: Allow the service principal to have instance pool create privileges. Defaults to false. More fine grained permissions could be assigned with databricks.Permissions and instance_pool_id argument.
application_id str: This is the application id of the given service principal and will be their form of access and identity. On other clouds than Azure this value is auto-generated.
databricks_sql_access bool: This is a field to allow the group to have access to Databricks SQL feature through databricks_sql_endpoint.
display_name str: This is an alias for the service principal and can be the full name of the service principal.
workspace_access bool: This is a field to allow the group to have access to Databricks Workspace.

active Boolean: Either service principal is active or not. True by default, but can be set to false in case of service principal deactivation with preserving service principal assets.
allowClusterCreate Boolean: Allow the service principal to have cluster create privileges. Defaults to false. More fine grained permissions could be assigned with databricks.Permissions and cluster_id argument. Everyone without allow_cluster_create argument set, but with permission to use Cluster Policy would be able to create clusters, but within the boundaries of that specific policy.
allowInstancePoolCreate Boolean: Allow the service principal to have instance pool create privileges. Defaults to false. More fine grained permissions could be assigned with databricks.Permissions and instance_pool_id argument.
applicationId String: This is the application id of the given service principal and will be their form of access and identity. On other clouds than Azure this value is auto-generated.
databricksSqlAccess Boolean: This is a field to allow the group to have access to Databricks SQL feature through databricks_sql_endpoint.
displayName String: This is an alias for the service principal and can be the full name of the service principal.
workspaceAccess Boolean: This is a field to allow the group to have access to Databricks Workspace.

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing ServicePrincipal Resource

Get an existing ServicePrincipal 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?: ServicePrincipalState, opts?: CustomResourceOptions): ServicePrincipal

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        active: Optional[bool] = None,
        allow_cluster_create: Optional[bool] = None,
        allow_instance_pool_create: Optional[bool] = None,
        application_id: Optional[str] = None,
        databricks_sql_access: Optional[bool] = None,
        display_name: Optional[str] = None,
        workspace_access: Optional[bool] = None) -> ServicePrincipal

func GetServicePrincipal(ctx *Context, name string, id IDInput, state *ServicePrincipalState, opts ...ResourceOption) (*ServicePrincipal, error)

public static ServicePrincipal Get(string name, Input<string> id, ServicePrincipalState? state, CustomResourceOptions? opts = null)

public static ServicePrincipal get(String name, Output<String> id, ServicePrincipalState state, CustomResourceOptions options)

resources:  _:    type: databricks:ServicePrincipal    get:      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:

Active bool: Either service principal is active or not. True by default, but can be set to false in case of service principal deactivation with preserving service principal assets.
AllowClusterCreate bool: Allow the service principal to have cluster create privileges. Defaults to false. More fine grained permissions could be assigned with databricks.Permissions and cluster_id argument. Everyone without allow_cluster_create argument set, but with permission to use Cluster Policy would be able to create clusters, but within the boundaries of that specific policy.
AllowInstancePoolCreate bool: Allow the service principal to have instance pool create privileges. Defaults to false. More fine grained permissions could be assigned with databricks.Permissions and instance_pool_id argument.
ApplicationId string: This is the application id of the given service principal and will be their form of access and identity. On other clouds than Azure this value is auto-generated.
DatabricksSqlAccess bool: This is a field to allow the group to have access to Databricks SQL feature through databricks_sql_endpoint.
DisplayName string: This is an alias for the service principal and can be the full name of the service principal.
WorkspaceAccess bool: This is a field to allow the group to have access to Databricks Workspace.

Active bool: Either service principal is active or not. True by default, but can be set to false in case of service principal deactivation with preserving service principal assets.
AllowClusterCreate bool: Allow the service principal to have cluster create privileges. Defaults to false. More fine grained permissions could be assigned with databricks.Permissions and cluster_id argument. Everyone without allow_cluster_create argument set, but with permission to use Cluster Policy would be able to create clusters, but within the boundaries of that specific policy.
AllowInstancePoolCreate bool: Allow the service principal to have instance pool create privileges. Defaults to false. More fine grained permissions could be assigned with databricks.Permissions and instance_pool_id argument.
ApplicationId string: This is the application id of the given service principal and will be their form of access and identity. On other clouds than Azure this value is auto-generated.
DatabricksSqlAccess bool: This is a field to allow the group to have access to Databricks SQL feature through databricks_sql_endpoint.
DisplayName string: This is an alias for the service principal and can be the full name of the service principal.
WorkspaceAccess bool: This is a field to allow the group to have access to Databricks Workspace.

active Boolean: Either service principal is active or not. True by default, but can be set to false in case of service principal deactivation with preserving service principal assets.
allowClusterCreate Boolean: Allow the service principal to have cluster create privileges. Defaults to false. More fine grained permissions could be assigned with databricks.Permissions and cluster_id argument. Everyone without allow_cluster_create argument set, but with permission to use Cluster Policy would be able to create clusters, but within the boundaries of that specific policy.
allowInstancePoolCreate Boolean: Allow the service principal to have instance pool create privileges. Defaults to false. More fine grained permissions could be assigned with databricks.Permissions and instance_pool_id argument.
applicationId String: This is the application id of the given service principal and will be their form of access and identity. On other clouds than Azure this value is auto-generated.
databricksSqlAccess Boolean: This is a field to allow the group to have access to Databricks SQL feature through databricks_sql_endpoint.
displayName String: This is an alias for the service principal and can be the full name of the service principal.
workspaceAccess Boolean: This is a field to allow the group to have access to Databricks Workspace.

active boolean: Either service principal is active or not. True by default, but can be set to false in case of service principal deactivation with preserving service principal assets.
allowClusterCreate boolean: Allow the service principal to have cluster create privileges. Defaults to false. More fine grained permissions could be assigned with databricks.Permissions and cluster_id argument. Everyone without allow_cluster_create argument set, but with permission to use Cluster Policy would be able to create clusters, but within the boundaries of that specific policy.
allowInstancePoolCreate boolean: Allow the service principal to have instance pool create privileges. Defaults to false. More fine grained permissions could be assigned with databricks.Permissions and instance_pool_id argument.
applicationId string: This is the application id of the given service principal and will be their form of access and identity. On other clouds than Azure this value is auto-generated.
databricksSqlAccess boolean: This is a field to allow the group to have access to Databricks SQL feature through databricks_sql_endpoint.
displayName string: This is an alias for the service principal and can be the full name of the service principal.
workspaceAccess boolean: This is a field to allow the group to have access to Databricks Workspace.

active bool: Either service principal is active or not. True by default, but can be set to false in case of service principal deactivation with preserving service principal assets.
allow_cluster_create bool: Allow the service principal to have cluster create privileges. Defaults to false. More fine grained permissions could be assigned with databricks.Permissions and cluster_id argument. Everyone without allow_cluster_create argument set, but with permission to use Cluster Policy would be able to create clusters, but within the boundaries of that specific policy.
allow_instance_pool_create bool: Allow the service principal to have instance pool create privileges. Defaults to false. More fine grained permissions could be assigned with databricks.Permissions and instance_pool_id argument.
application_id str: This is the application id of the given service principal and will be their form of access and identity. On other clouds than Azure this value is auto-generated.
databricks_sql_access bool: This is a field to allow the group to have access to Databricks SQL feature through databricks_sql_endpoint.
display_name str: This is an alias for the service principal and can be the full name of the service principal.
workspace_access bool: This is a field to allow the group to have access to Databricks Workspace.

active Boolean: Either service principal is active or not. True by default, but can be set to false in case of service principal deactivation with preserving service principal assets.
allowClusterCreate Boolean: Allow the service principal to have cluster create privileges. Defaults to false. More fine grained permissions could be assigned with databricks.Permissions and cluster_id argument. Everyone without allow_cluster_create argument set, but with permission to use Cluster Policy would be able to create clusters, but within the boundaries of that specific policy.
allowInstancePoolCreate Boolean: Allow the service principal to have instance pool create privileges. Defaults to false. More fine grained permissions could be assigned with databricks.Permissions and instance_pool_id argument.
applicationId String: This is the application id of the given service principal and will be their form of access and identity. On other clouds than Azure this value is auto-generated.
databricksSqlAccess Boolean: This is a field to allow the group to have access to Databricks SQL feature through databricks_sql_endpoint.
displayName String: This is an alias for the service principal and can be the full name of the service principal.
workspaceAccess Boolean: This is a field to allow the group to have access to Databricks Workspace.

Import

The resource scim service principal can be imported using idbash

 $ pulumi import databricks:index/servicePrincipal:ServicePrincipal me <service-principal-id>

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository: databricks pulumi/pulumi-databricks
License: Apache-2.0
Notes: This Pulumi package is based on the databricks Terraform Provider.

Viewing docs for Databricks v0.4.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-databricks

databricks.ServicePrincipal

On this page

On this page

Create ServicePrincipal Resource

Constructor syntax

Parameters

Constructor example

ServicePrincipal Resource Properties

Inputs

Outputs

Look up Existing ServicePrincipal Resource

Import

Package Details

On this page

On this page

databricks.ServicePrincipal

On this page

On this page

Related Resources

Create ServicePrincipal Resource

Constructor syntax

Parameters

Constructor example

ServicePrincipal Resource Properties

Inputs

Outputs

Look up Existing ServicePrincipal Resource

Import

Package Details

On this page

On this page