Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Databricks Provider
  3. API Docs
  4. App
Databricks v1.64.0 published on Wednesday, Apr 2, 2025 by Pulumi
pulumi/pulumi-databricks

databricks.App

Explore with Pulumi AI

Databricks v1.64.0 published on Wednesday, Apr 2, 2025 by Pulumi
pulumi/pulumi-databricks

This feature is in Public Preview.

Databricks Apps run directly on a customer’s Databricks instance, integrate with their data, use and extend Databricks services, and enable users to interact through single sign-on. This resource creates the application but does not handle app deployment, which should be handled separately as part of your CI/CD pipeline.

Example Usage

Coming soon!

Coming soon!

Coming soon!

Coming soon!

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.databricks.App;
import com.pulumi.databricks.AppArgs;
import com.pulumi.databricks.inputs.AppResourceArgs;
import com.pulumi.databricks.inputs.AppResourceJobArgs;
import java.util.List;
import java.util.ArrayList;
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) {
        var this_ = new App("this", AppArgs.builder()
            .name("my-custom-app")
            .description("My app")
            .resources(            
                AppResourceArgs.builder()
                    .name("sql-warehouse")
                    .sql_warehouse(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                    .build(),
                AppResourceArgs.builder()
                    .name("serving-endpoint")
                    .serving_endpoint(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                    .build(),
                AppResourceArgs.builder()
                    .name("job")
                    .job(AppResourceJobArgs.builder()
                        .id("1234")
                        .permission("CAN_MANAGE")
                        .build())
                    .build())
            .build());

    }
}
Copy
resources:
  this:
    type: databricks:App
    properties:
      name: my-custom-app
      description: My app
      resources:
        - name: sql-warehouse
          sql_warehouse:
            id: e9ca293f79a74b5c
            permission: CAN_MANAGE
        - name: serving-endpoint
          serving_endpoint:
            name: databricks-meta-llama-3-1-70b-instruct
            permission: CAN_MANAGE
        - name: job
          job:
            id: '1234'
            permission: CAN_MANAGE
Copy

The following resources are used in the same context:

  • databricks.SqlEndpoint to manage Databricks SQL Endpoints.
  • databricks.ModelServing to serve this model on a Databricks serving endpoint.
  • databricks.Secret to manage secrets in Databricks workspace.
  • databricks.Job to manage Databricks Jobs to run non-interactive code.

Create App Resource

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

Constructor syntax

new App(name: string, args?: AppArgs, opts?: CustomResourceOptions);
@overload
def App(resource_name: str,
        args: Optional[AppArgs] = None,
        opts: Optional[ResourceOptions] = None)

@overload
def App(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        budget_policy_id: Optional[str] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        no_compute: Optional[bool] = None,
        resources: Optional[Sequence[AppResourceArgs]] = None,
        user_api_scopes: Optional[Sequence[str]] = None)
func NewApp(ctx *Context, name string, args *AppArgs, opts ...ResourceOption) (*App, error)
public App(string name, AppArgs? args = null, CustomResourceOptions? opts = null)
public App(String name, AppArgs args)
public App(String name, AppArgs args, CustomResourceOptions options)

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

Parameters

name This property is required. string
The unique name of the resource.
args AppArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args AppArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args AppArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args AppArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. AppArgs
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 appResource = new Databricks.App("appResource", new()
{
    BudgetPolicyId = "string",
    Description = "string",
    Name = "string",
    NoCompute = false,
    Resources = new[]
    {
        new Databricks.Inputs.AppResourceArgs
        {
            Name = "string",
            Description = "string",
            Job = new Databricks.Inputs.AppResourceJobArgs
            {
                Id = "string",
                Permission = "string",
            },
            Secret = new Databricks.Inputs.AppResourceSecretArgs
            {
                Key = "string",
                Permission = "string",
                Scope = "string",
            },
            ServingEndpoint = new Databricks.Inputs.AppResourceServingEndpointArgs
            {
                Name = "string",
                Permission = "string",
            },
            SqlWarehouse = new Databricks.Inputs.AppResourceSqlWarehouseArgs
            {
                Id = "string",
                Permission = "string",
            },
        },
    },
    UserApiScopes = new[]
    {
        "string",
    },
});
Copy
example, err := databricks.NewApp(ctx, "appResource", &databricks.AppArgs{
	BudgetPolicyId: pulumi.String("string"),
	Description:    pulumi.String("string"),
	Name:           pulumi.String("string"),
	NoCompute:      pulumi.Bool(false),
	Resources: databricks.AppResourceArray{
		&databricks.AppResourceArgs{
			Name:        pulumi.String("string"),
			Description: pulumi.String("string"),
			Job: &databricks.AppResourceJobArgs{
				Id:         pulumi.String("string"),
				Permission: pulumi.String("string"),
			},
			Secret: &databricks.AppResourceSecretArgs{
				Key:        pulumi.String("string"),
				Permission: pulumi.String("string"),
				Scope:      pulumi.String("string"),
			},
			ServingEndpoint: &databricks.AppResourceServingEndpointArgs{
				Name:       pulumi.String("string"),
				Permission: pulumi.String("string"),
			},
			SqlWarehouse: &databricks.AppResourceSqlWarehouseArgs{
				Id:         pulumi.String("string"),
				Permission: pulumi.String("string"),
			},
		},
	},
	UserApiScopes: pulumi.StringArray{
		pulumi.String("string"),
	},
})
Copy
var appResource = new App("appResource", AppArgs.builder()
    .budgetPolicyId("string")
    .description("string")
    .name("string")
    .noCompute(false)
    .resources(AppResourceArgs.builder()
        .name("string")
        .description("string")
        .job(AppResourceJobArgs.builder()
            .id("string")
            .permission("string")
            .build())
        .secret(AppResourceSecretArgs.builder()
            .key("string")
            .permission("string")
            .scope("string")
            .build())
        .servingEndpoint(AppResourceServingEndpointArgs.builder()
            .name("string")
            .permission("string")
            .build())
        .sqlWarehouse(AppResourceSqlWarehouseArgs.builder()
            .id("string")
            .permission("string")
            .build())
        .build())
    .userApiScopes("string")
    .build());
Copy
app_resource = databricks.App("appResource",
    budget_policy_id="string",
    description="string",
    name="string",
    no_compute=False,
    resources=[{
        "name": "string",
        "description": "string",
        "job": {
            "id": "string",
            "permission": "string",
        },
        "secret": {
            "key": "string",
            "permission": "string",
            "scope": "string",
        },
        "serving_endpoint": {
            "name": "string",
            "permission": "string",
        },
        "sql_warehouse": {
            "id": "string",
            "permission": "string",
        },
    }],
    user_api_scopes=["string"])
Copy
const appResource = new databricks.App("appResource", {
    budgetPolicyId: "string",
    description: "string",
    name: "string",
    noCompute: false,
    resources: [{
        name: "string",
        description: "string",
        job: {
            id: "string",
            permission: "string",
        },
        secret: {
            key: "string",
            permission: "string",
            scope: "string",
        },
        servingEndpoint: {
            name: "string",
            permission: "string",
        },
        sqlWarehouse: {
            id: "string",
            permission: "string",
        },
    }],
    userApiScopes: ["string"],
});
Copy
type: databricks:App
properties:
    budgetPolicyId: string
    description: string
    name: string
    noCompute: false
    resources:
        - description: string
          job:
            id: string
            permission: string
          name: string
          secret:
            key: string
            permission: string
            scope: string
          servingEndpoint:
            name: string
            permission: string
          sqlWarehouse:
            id: string
            permission: string
    userApiScopes:
        - string
Copy

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

BudgetPolicyId string
The optional Budget Policy ID set for this resource.
Description string
The description of the app.
Name string
The name of the app. The name must contain only lowercase alphanumeric characters and hyphens. It must be unique within the workspace.
NoCompute bool
Resources List<AppResource>
A list of resources that the app have access to.
UserApiScopes List<string>
BudgetPolicyId string
The optional Budget Policy ID set for this resource.
Description string
The description of the app.
Name string
The name of the app. The name must contain only lowercase alphanumeric characters and hyphens. It must be unique within the workspace.
NoCompute bool
Resources []AppResourceArgs
A list of resources that the app have access to.
UserApiScopes []string
budgetPolicyId String
The optional Budget Policy ID set for this resource.
description String
The description of the app.
name String
The name of the app. The name must contain only lowercase alphanumeric characters and hyphens. It must be unique within the workspace.
noCompute Boolean
resources List<AppResource>
A list of resources that the app have access to.
userApiScopes List<String>
budgetPolicyId string
The optional Budget Policy ID set for this resource.
description string
The description of the app.
name string
The name of the app. The name must contain only lowercase alphanumeric characters and hyphens. It must be unique within the workspace.
noCompute boolean
resources AppResource[]
A list of resources that the app have access to.
userApiScopes string[]
budget_policy_id str
The optional Budget Policy ID set for this resource.
description str
The description of the app.
name str
The name of the app. The name must contain only lowercase alphanumeric characters and hyphens. It must be unique within the workspace.
no_compute bool
resources Sequence[AppResourceArgs]
A list of resources that the app have access to.
user_api_scopes Sequence[str]
budgetPolicyId String
The optional Budget Policy ID set for this resource.
description String
The description of the app.
name String
The name of the app. The name must contain only lowercase alphanumeric characters and hyphens. It must be unique within the workspace.
noCompute Boolean
resources List<Property Map>
A list of resources that the app have access to.
userApiScopes List<String>

Outputs

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

ActiveDeployment AppActiveDeployment
AppStatus AppAppStatus
attribute
ComputeStatus AppComputeStatus
attribute
CreateTime string
The creation time of the app.
Creator string
The email of the user that created the app.
DefaultSourceCodePath string
The default workspace file system path of the source code from which app deployment are created. This field tracks the workspace source code path of the last active deployment.
EffectiveBudgetPolicyId string
The effective budget policy ID.
EffectiveUserApiScopes List<string>
Id string
The provider-assigned unique ID for this managed resource.
Oauth2AppClientId string
Oauth2AppIntegrationId string
PendingDeployment AppPendingDeployment
ServicePrincipalClientId string
ServicePrincipalId int
id of the app service principal
ServicePrincipalName string
name of the app service principal
UpdateTime string
The update time of the app.
Updater string
The email of the user that last updated the app.
Url string
The URL of the app once it is deployed.
ActiveDeployment AppActiveDeployment
AppStatus AppAppStatus
attribute
ComputeStatus AppComputeStatus
attribute
CreateTime string
The creation time of the app.
Creator string
The email of the user that created the app.
DefaultSourceCodePath string
The default workspace file system path of the source code from which app deployment are created. This field tracks the workspace source code path of the last active deployment.
EffectiveBudgetPolicyId string
The effective budget policy ID.
EffectiveUserApiScopes []string
Id string
The provider-assigned unique ID for this managed resource.
Oauth2AppClientId string
Oauth2AppIntegrationId string
PendingDeployment AppPendingDeployment
ServicePrincipalClientId string
ServicePrincipalId int
id of the app service principal
ServicePrincipalName string
name of the app service principal
UpdateTime string
The update time of the app.
Updater string
The email of the user that last updated the app.
Url string
The URL of the app once it is deployed.
activeDeployment AppActiveDeployment
appStatus AppAppStatus
attribute
computeStatus AppComputeStatus
attribute
createTime String
The creation time of the app.
creator String
The email of the user that created the app.
defaultSourceCodePath String
The default workspace file system path of the source code from which app deployment are created. This field tracks the workspace source code path of the last active deployment.
effectiveBudgetPolicyId String
The effective budget policy ID.
effectiveUserApiScopes List<String>
id String
The provider-assigned unique ID for this managed resource.
oauth2AppClientId String
oauth2AppIntegrationId String
pendingDeployment AppPendingDeployment
servicePrincipalClientId String
servicePrincipalId Integer
id of the app service principal
servicePrincipalName String
name of the app service principal
updateTime String
The update time of the app.
updater String
The email of the user that last updated the app.
url String
The URL of the app once it is deployed.
activeDeployment AppActiveDeployment
appStatus AppAppStatus
attribute
computeStatus AppComputeStatus
attribute
createTime string
The creation time of the app.
creator string
The email of the user that created the app.
defaultSourceCodePath string
The default workspace file system path of the source code from which app deployment are created. This field tracks the workspace source code path of the last active deployment.
effectiveBudgetPolicyId string
The effective budget policy ID.
effectiveUserApiScopes string[]
id string
The provider-assigned unique ID for this managed resource.
oauth2AppClientId string
oauth2AppIntegrationId string
pendingDeployment AppPendingDeployment
servicePrincipalClientId string
servicePrincipalId number
id of the app service principal
servicePrincipalName string
name of the app service principal
updateTime string
The update time of the app.
updater string
The email of the user that last updated the app.
url string
The URL of the app once it is deployed.
active_deployment AppActiveDeployment
app_status AppAppStatus
attribute
compute_status AppComputeStatus
attribute
create_time str
The creation time of the app.
creator str
The email of the user that created the app.
default_source_code_path str
The default workspace file system path of the source code from which app deployment are created. This field tracks the workspace source code path of the last active deployment.
effective_budget_policy_id str
The effective budget policy ID.
effective_user_api_scopes Sequence[str]
id str
The provider-assigned unique ID for this managed resource.
oauth2_app_client_id str
oauth2_app_integration_id str
pending_deployment AppPendingDeployment
service_principal_client_id str
service_principal_id int
id of the app service principal
service_principal_name str
name of the app service principal
update_time str
The update time of the app.
updater str
The email of the user that last updated the app.
url str
The URL of the app once it is deployed.
activeDeployment Property Map
appStatus Property Map
attribute
computeStatus Property Map
attribute
createTime String
The creation time of the app.
creator String
The email of the user that created the app.
defaultSourceCodePath String
The default workspace file system path of the source code from which app deployment are created. This field tracks the workspace source code path of the last active deployment.
effectiveBudgetPolicyId String
The effective budget policy ID.
effectiveUserApiScopes List<String>
id String
The provider-assigned unique ID for this managed resource.
oauth2AppClientId String
oauth2AppIntegrationId String
pendingDeployment Property Map
servicePrincipalClientId String
servicePrincipalId Number
id of the app service principal
servicePrincipalName String
name of the app service principal
updateTime String
The update time of the app.
updater String
The email of the user that last updated the app.
url String
The URL of the app once it is deployed.

Look up Existing App Resource

Get an existing App 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?: AppState, opts?: CustomResourceOptions): App
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        active_deployment: Optional[AppActiveDeploymentArgs] = None,
        app_status: Optional[AppAppStatusArgs] = None,
        budget_policy_id: Optional[str] = None,
        compute_status: Optional[AppComputeStatusArgs] = None,
        create_time: Optional[str] = None,
        creator: Optional[str] = None,
        default_source_code_path: Optional[str] = None,
        description: Optional[str] = None,
        effective_budget_policy_id: Optional[str] = None,
        effective_user_api_scopes: Optional[Sequence[str]] = None,
        name: Optional[str] = None,
        no_compute: Optional[bool] = None,
        oauth2_app_client_id: Optional[str] = None,
        oauth2_app_integration_id: Optional[str] = None,
        pending_deployment: Optional[AppPendingDeploymentArgs] = None,
        resources: Optional[Sequence[AppResourceArgs]] = None,
        service_principal_client_id: Optional[str] = None,
        service_principal_id: Optional[int] = None,
        service_principal_name: Optional[str] = None,
        update_time: Optional[str] = None,
        updater: Optional[str] = None,
        url: Optional[str] = None,
        user_api_scopes: Optional[Sequence[str]] = None) -> App
func GetApp(ctx *Context, name string, id IDInput, state *AppState, opts ...ResourceOption) (*App, error)
public static App Get(string name, Input<string> id, AppState? state, CustomResourceOptions? opts = null)
public static App get(String name, Output<String> id, AppState state, CustomResourceOptions options)
resources:  _:    type: databricks:App    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
ActiveDeployment AppActiveDeployment
AppStatus AppAppStatus
attribute
BudgetPolicyId string
The optional Budget Policy ID set for this resource.
ComputeStatus AppComputeStatus
attribute
CreateTime string
The creation time of the app.
Creator string
The email of the user that created the app.
DefaultSourceCodePath string
The default workspace file system path of the source code from which app deployment are created. This field tracks the workspace source code path of the last active deployment.
Description string
The description of the app.
EffectiveBudgetPolicyId string
The effective budget policy ID.
EffectiveUserApiScopes List<string>
Name string
The name of the app. The name must contain only lowercase alphanumeric characters and hyphens. It must be unique within the workspace.
NoCompute bool
Oauth2AppClientId string
Oauth2AppIntegrationId string
PendingDeployment AppPendingDeployment
Resources List<AppResource>
A list of resources that the app have access to.
ServicePrincipalClientId string
ServicePrincipalId int
id of the app service principal
ServicePrincipalName string
name of the app service principal
UpdateTime string
The update time of the app.
Updater string
The email of the user that last updated the app.
Url string
The URL of the app once it is deployed.
UserApiScopes List<string>
ActiveDeployment AppActiveDeploymentArgs
AppStatus AppAppStatusArgs
attribute
BudgetPolicyId string
The optional Budget Policy ID set for this resource.
ComputeStatus AppComputeStatusArgs
attribute
CreateTime string
The creation time of the app.
Creator string
The email of the user that created the app.
DefaultSourceCodePath string
The default workspace file system path of the source code from which app deployment are created. This field tracks the workspace source code path of the last active deployment.
Description string
The description of the app.
EffectiveBudgetPolicyId string
The effective budget policy ID.
EffectiveUserApiScopes []string
Name string
The name of the app. The name must contain only lowercase alphanumeric characters and hyphens. It must be unique within the workspace.
NoCompute bool
Oauth2AppClientId string
Oauth2AppIntegrationId string
PendingDeployment AppPendingDeploymentArgs
Resources []AppResourceArgs
A list of resources that the app have access to.
ServicePrincipalClientId string
ServicePrincipalId int
id of the app service principal
ServicePrincipalName string
name of the app service principal
UpdateTime string
The update time of the app.
Updater string
The email of the user that last updated the app.
Url string
The URL of the app once it is deployed.
UserApiScopes []string
activeDeployment AppActiveDeployment
appStatus AppAppStatus
attribute
budgetPolicyId String
The optional Budget Policy ID set for this resource.
computeStatus AppComputeStatus
attribute
createTime String
The creation time of the app.
creator String
The email of the user that created the app.
defaultSourceCodePath String
The default workspace file system path of the source code from which app deployment are created. This field tracks the workspace source code path of the last active deployment.
description String
The description of the app.
effectiveBudgetPolicyId String
The effective budget policy ID.
effectiveUserApiScopes List<String>
name String
The name of the app. The name must contain only lowercase alphanumeric characters and hyphens. It must be unique within the workspace.
noCompute Boolean
oauth2AppClientId String
oauth2AppIntegrationId String
pendingDeployment AppPendingDeployment
resources List<AppResource>
A list of resources that the app have access to.
servicePrincipalClientId String
servicePrincipalId Integer
id of the app service principal
servicePrincipalName String
name of the app service principal
updateTime String
The update time of the app.
updater String
The email of the user that last updated the app.
url String
The URL of the app once it is deployed.
userApiScopes List<String>
activeDeployment AppActiveDeployment
appStatus AppAppStatus
attribute
budgetPolicyId string
The optional Budget Policy ID set for this resource.
computeStatus AppComputeStatus
attribute
createTime string
The creation time of the app.
creator string
The email of the user that created the app.
defaultSourceCodePath string
The default workspace file system path of the source code from which app deployment are created. This field tracks the workspace source code path of the last active deployment.
description string
The description of the app.
effectiveBudgetPolicyId string
The effective budget policy ID.
effectiveUserApiScopes string[]
name string
The name of the app. The name must contain only lowercase alphanumeric characters and hyphens. It must be unique within the workspace.
noCompute boolean
oauth2AppClientId string
oauth2AppIntegrationId string
pendingDeployment AppPendingDeployment
resources AppResource[]
A list of resources that the app have access to.
servicePrincipalClientId string
servicePrincipalId number
id of the app service principal
servicePrincipalName string
name of the app service principal
updateTime string
The update time of the app.
updater string
The email of the user that last updated the app.
url string
The URL of the app once it is deployed.
userApiScopes string[]
active_deployment AppActiveDeploymentArgs
app_status AppAppStatusArgs
attribute
budget_policy_id str
The optional Budget Policy ID set for this resource.
compute_status AppComputeStatusArgs
attribute
create_time str
The creation time of the app.
creator str
The email of the user that created the app.
default_source_code_path str
The default workspace file system path of the source code from which app deployment are created. This field tracks the workspace source code path of the last active deployment.
description str
The description of the app.
effective_budget_policy_id str
The effective budget policy ID.
effective_user_api_scopes Sequence[str]
name str
The name of the app. The name must contain only lowercase alphanumeric characters and hyphens. It must be unique within the workspace.
no_compute bool
oauth2_app_client_id str
oauth2_app_integration_id str
pending_deployment AppPendingDeploymentArgs
resources Sequence[AppResourceArgs]
A list of resources that the app have access to.
service_principal_client_id str
service_principal_id int
id of the app service principal
service_principal_name str
name of the app service principal
update_time str
The update time of the app.
updater str
The email of the user that last updated the app.
url str
The URL of the app once it is deployed.
user_api_scopes Sequence[str]
activeDeployment Property Map
appStatus Property Map
attribute
budgetPolicyId String
The optional Budget Policy ID set for this resource.
computeStatus Property Map
attribute
createTime String
The creation time of the app.
creator String
The email of the user that created the app.
defaultSourceCodePath String
The default workspace file system path of the source code from which app deployment are created. This field tracks the workspace source code path of the last active deployment.
description String
The description of the app.
effectiveBudgetPolicyId String
The effective budget policy ID.
effectiveUserApiScopes List<String>
name String
The name of the app. The name must contain only lowercase alphanumeric characters and hyphens. It must be unique within the workspace.
noCompute Boolean
oauth2AppClientId String
oauth2AppIntegrationId String
pendingDeployment Property Map
resources List<Property Map>
A list of resources that the app have access to.
servicePrincipalClientId String
servicePrincipalId Number
id of the app service principal
servicePrincipalName String
name of the app service principal
updateTime String
The update time of the app.
updater String
The email of the user that last updated the app.
url String
The URL of the app once it is deployed.
userApiScopes List<String>

Supporting Types

AppActiveDeployment
, AppActiveDeploymentArgs

CreateTime string
The creation time of the app.
Creator string
The email of the user that created the app.
DeploymentArtifacts AppActiveDeploymentDeploymentArtifacts
DeploymentId string
Mode string
SourceCodePath string
Status AppActiveDeploymentStatus
UpdateTime string
The update time of the app.
CreateTime string
The creation time of the app.
Creator string
The email of the user that created the app.
DeploymentArtifacts AppActiveDeploymentDeploymentArtifacts
DeploymentId string
Mode string
SourceCodePath string
Status AppActiveDeploymentStatus
UpdateTime string
The update time of the app.
createTime String
The creation time of the app.
creator String
The email of the user that created the app.
deploymentArtifacts AppActiveDeploymentDeploymentArtifacts
deploymentId String
mode String
sourceCodePath String
status AppActiveDeploymentStatus
updateTime String
The update time of the app.
createTime string
The creation time of the app.
creator string
The email of the user that created the app.
deploymentArtifacts AppActiveDeploymentDeploymentArtifacts
deploymentId string
mode string
sourceCodePath string
status AppActiveDeploymentStatus
updateTime string
The update time of the app.
create_time str
The creation time of the app.
creator str
The email of the user that created the app.
deployment_artifacts AppActiveDeploymentDeploymentArtifacts
deployment_id str
mode str
source_code_path str
status AppActiveDeploymentStatus
update_time str
The update time of the app.
createTime String
The creation time of the app.
creator String
The email of the user that created the app.
deploymentArtifacts Property Map
deploymentId String
mode String
sourceCodePath String
status Property Map
updateTime String
The update time of the app.

AppActiveDeploymentDeploymentArtifacts
, AppActiveDeploymentDeploymentArtifactsArgs

AppActiveDeploymentStatus
, AppActiveDeploymentStatusArgs

Message string
Application status message
State string
State of the application.
Message string
Application status message
State string
State of the application.
message String
Application status message
state String
State of the application.
message string
Application status message
state string
State of the application.
message str
Application status message
state str
State of the application.
message String
Application status message
state String
State of the application.

AppAppStatus
, AppAppStatusArgs

Message string
Application status message
State string
State of the application.
Message string
Application status message
State string
State of the application.
message String
Application status message
state String
State of the application.
message string
Application status message
state string
State of the application.
message str
Application status message
state str
State of the application.
message String
Application status message
state String
State of the application.

AppComputeStatus
, AppComputeStatusArgs

Message string
Application status message
State string
State of the application.
Message string
Application status message
State string
State of the application.
message String
Application status message
state String
State of the application.
message string
Application status message
state string
State of the application.
message str
Application status message
state str
State of the application.
message String
Application status message
state String
State of the application.

AppPendingDeployment
, AppPendingDeploymentArgs

CreateTime string
The creation time of the app.
Creator string
The email of the user that created the app.
DeploymentArtifacts AppPendingDeploymentDeploymentArtifacts
DeploymentId string
Mode string
SourceCodePath string
Status AppPendingDeploymentStatus
UpdateTime string
The update time of the app.
CreateTime string
The creation time of the app.
Creator string
The email of the user that created the app.
DeploymentArtifacts AppPendingDeploymentDeploymentArtifacts
DeploymentId string
Mode string
SourceCodePath string
Status AppPendingDeploymentStatus
UpdateTime string
The update time of the app.
createTime String
The creation time of the app.
creator String
The email of the user that created the app.
deploymentArtifacts AppPendingDeploymentDeploymentArtifacts
deploymentId String
mode String
sourceCodePath String
status AppPendingDeploymentStatus
updateTime String
The update time of the app.
createTime string
The creation time of the app.
creator string
The email of the user that created the app.
deploymentArtifacts AppPendingDeploymentDeploymentArtifacts
deploymentId string
mode string
sourceCodePath string
status AppPendingDeploymentStatus
updateTime string
The update time of the app.
create_time str
The creation time of the app.
creator str
The email of the user that created the app.
deployment_artifacts AppPendingDeploymentDeploymentArtifacts
deployment_id str
mode str
source_code_path str
status AppPendingDeploymentStatus
update_time str
The update time of the app.
createTime String
The creation time of the app.
creator String
The email of the user that created the app.
deploymentArtifacts Property Map
deploymentId String
mode String
sourceCodePath String
status Property Map
updateTime String
The update time of the app.

AppPendingDeploymentDeploymentArtifacts
, AppPendingDeploymentDeploymentArtifactsArgs

AppPendingDeploymentStatus
, AppPendingDeploymentStatusArgs

Message string
Application status message
State string
State of the application.
Message string
Application status message
State string
State of the application.
message String
Application status message
state String
State of the application.
message string
Application status message
state string
State of the application.
message str
Application status message
state str
State of the application.
message String
Application status message
state String
State of the application.

AppResource
, AppResourceArgs

Name This property is required. string
The name of the resource.
Description string

The description of the resource.

Exactly one of the following attributes must be provided:

Job AppResourceJob
attribute
Secret AppResourceSecret
attribute
ServingEndpoint AppResourceServingEndpoint
attribute
SqlWarehouse AppResourceSqlWarehouse
attribute
Name This property is required. string
The name of the resource.
Description string

The description of the resource.

Exactly one of the following attributes must be provided:

Job AppResourceJob
attribute
Secret AppResourceSecret
attribute
ServingEndpoint AppResourceServingEndpoint
attribute
SqlWarehouse AppResourceSqlWarehouse
attribute
name This property is required. String
The name of the resource.
description String

The description of the resource.

Exactly one of the following attributes must be provided:

job AppResourceJob
attribute
secret AppResourceSecret
attribute
servingEndpoint AppResourceServingEndpoint
attribute
sqlWarehouse AppResourceSqlWarehouse
attribute
name This property is required. string
The name of the resource.
description string

The description of the resource.

Exactly one of the following attributes must be provided:

job AppResourceJob
attribute
secret AppResourceSecret
attribute
servingEndpoint AppResourceServingEndpoint
attribute
sqlWarehouse AppResourceSqlWarehouse
attribute
name This property is required. str
The name of the resource.
description str

The description of the resource.

Exactly one of the following attributes must be provided:

job AppResourceJob
attribute
secret AppResourceSecret
attribute
serving_endpoint AppResourceServingEndpoint
attribute
sql_warehouse AppResourceSqlWarehouse
attribute
name This property is required. String
The name of the resource.
description String

The description of the resource.

Exactly one of the following attributes must be provided:

job Property Map
attribute
secret Property Map
attribute
servingEndpoint Property Map
attribute
sqlWarehouse Property Map
attribute

AppResourceJob
, AppResourceJobArgs

Id This property is required. string
Id of the job to grant permission on.
Permission This property is required. string
Permissions to grant on the Job. Supported permissions are: CAN_MANAGE, IS_OWNER, CAN_MANAGE_RUN, CAN_VIEW.
Id This property is required. string
Id of the job to grant permission on.
Permission This property is required. string
Permissions to grant on the Job. Supported permissions are: CAN_MANAGE, IS_OWNER, CAN_MANAGE_RUN, CAN_VIEW.
id This property is required. String
Id of the job to grant permission on.
permission This property is required. String
Permissions to grant on the Job. Supported permissions are: CAN_MANAGE, IS_OWNER, CAN_MANAGE_RUN, CAN_VIEW.
id This property is required. string
Id of the job to grant permission on.
permission This property is required. string
Permissions to grant on the Job. Supported permissions are: CAN_MANAGE, IS_OWNER, CAN_MANAGE_RUN, CAN_VIEW.
id This property is required. str
Id of the job to grant permission on.
permission This property is required. str
Permissions to grant on the Job. Supported permissions are: CAN_MANAGE, IS_OWNER, CAN_MANAGE_RUN, CAN_VIEW.
id This property is required. String
Id of the job to grant permission on.
permission This property is required. String
Permissions to grant on the Job. Supported permissions are: CAN_MANAGE, IS_OWNER, CAN_MANAGE_RUN, CAN_VIEW.

AppResourceSecret
, AppResourceSecretArgs

Key This property is required. string
Key of the secret to grant permission on.
Permission This property is required. string
Permission to grant on the secret scope. For secrets, only one permission is allowed. Permission must be one of: READ, WRITE, MANAGE.
Scope This property is required. string
Scope of the secret to grant permission on.
Key This property is required. string
Key of the secret to grant permission on.
Permission This property is required. string
Permission to grant on the secret scope. For secrets, only one permission is allowed. Permission must be one of: READ, WRITE, MANAGE.
Scope This property is required. string
Scope of the secret to grant permission on.
key This property is required. String
Key of the secret to grant permission on.
permission This property is required. String
Permission to grant on the secret scope. For secrets, only one permission is allowed. Permission must be one of: READ, WRITE, MANAGE.
scope This property is required. String
Scope of the secret to grant permission on.
key This property is required. string
Key of the secret to grant permission on.
permission This property is required. string
Permission to grant on the secret scope. For secrets, only one permission is allowed. Permission must be one of: READ, WRITE, MANAGE.
scope This property is required. string
Scope of the secret to grant permission on.
key This property is required. str
Key of the secret to grant permission on.
permission This property is required. str
Permission to grant on the secret scope. For secrets, only one permission is allowed. Permission must be one of: READ, WRITE, MANAGE.
scope This property is required. str
Scope of the secret to grant permission on.
key This property is required. String
Key of the secret to grant permission on.
permission This property is required. String
Permission to grant on the secret scope. For secrets, only one permission is allowed. Permission must be one of: READ, WRITE, MANAGE.
scope This property is required. String
Scope of the secret to grant permission on.

AppResourceServingEndpoint
, AppResourceServingEndpointArgs

Name This property is required. string
Name of the serving endpoint to grant permission on.
Permission This property is required. string
Permission to grant on the serving endpoint. Supported permissions are: CAN_MANAGE, CAN_QUERY, CAN_VIEW.
Name This property is required. string
Name of the serving endpoint to grant permission on.
Permission This property is required. string
Permission to grant on the serving endpoint. Supported permissions are: CAN_MANAGE, CAN_QUERY, CAN_VIEW.
name This property is required. String
Name of the serving endpoint to grant permission on.
permission This property is required. String
Permission to grant on the serving endpoint. Supported permissions are: CAN_MANAGE, CAN_QUERY, CAN_VIEW.
name This property is required. string
Name of the serving endpoint to grant permission on.
permission This property is required. string
Permission to grant on the serving endpoint. Supported permissions are: CAN_MANAGE, CAN_QUERY, CAN_VIEW.
name This property is required. str
Name of the serving endpoint to grant permission on.
permission This property is required. str
Permission to grant on the serving endpoint. Supported permissions are: CAN_MANAGE, CAN_QUERY, CAN_VIEW.
name This property is required. String
Name of the serving endpoint to grant permission on.
permission This property is required. String
Permission to grant on the serving endpoint. Supported permissions are: CAN_MANAGE, CAN_QUERY, CAN_VIEW.

AppResourceSqlWarehouse
, AppResourceSqlWarehouseArgs

Id This property is required. string
Id of the SQL warehouse to grant permission on.
Permission This property is required. string
Permission to grant on the SQL warehouse. Supported permissions are: CAN_MANAGE, CAN_USE, IS_OWNER.
Id This property is required. string
Id of the SQL warehouse to grant permission on.
Permission This property is required. string
Permission to grant on the SQL warehouse. Supported permissions are: CAN_MANAGE, CAN_USE, IS_OWNER.
id This property is required. String
Id of the SQL warehouse to grant permission on.
permission This property is required. String
Permission to grant on the SQL warehouse. Supported permissions are: CAN_MANAGE, CAN_USE, IS_OWNER.
id This property is required. string
Id of the SQL warehouse to grant permission on.
permission This property is required. string
Permission to grant on the SQL warehouse. Supported permissions are: CAN_MANAGE, CAN_USE, IS_OWNER.
id This property is required. str
Id of the SQL warehouse to grant permission on.
permission This property is required. str
Permission to grant on the SQL warehouse. Supported permissions are: CAN_MANAGE, CAN_USE, IS_OWNER.
id This property is required. String
Id of the SQL warehouse to grant permission on.
permission This property is required. String
Permission to grant on the SQL warehouse. Supported permissions are: CAN_MANAGE, CAN_USE, IS_OWNER.

Import

This resource can be imported by name:

hcl

import {

to = databricks_app.this

id = “<app_name>”

}

or using the terraform CLI:

bash

$ pulumi import databricks:index/app:App this <app_name>
Copy

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.
Databricks v1.64.0 published on Wednesday, Apr 2, 2025 by Pulumi
pulumi/pulumi-databricks