Databricks v1.64.0, Apr 2 25

Databricks v1.64.0 published on Wednesday, Apr 2, 2025 by Pulumi

databricks.getApp

Explore with Pulumi AI

Databricks v1.64.0 published on Wednesday, Apr 2, 2025 by Pulumi

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.

This data source allows you to fetch information about a Databricks App.

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

const _this = databricks.getApp({
    name: "my-custom-app",
});

import pulumi
import pulumi_databricks as databricks

this = databricks.get_app(name="my-custom-app")

package main

import (
	"github.com/pulumi/pulumi-databricks/sdk/go/databricks"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := databricks.LookupApp(ctx, &databricks.LookupAppArgs{
			Name: "my-custom-app",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Databricks = Pulumi.Databricks;

return await Deployment.RunAsync(() => 
{
    var @this = Databricks.GetApp.Invoke(new()
    {
        Name = "my-custom-app",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.databricks.DatabricksFunctions;
import com.pulumi.databricks.inputs.GetAppArgs;
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) {
        final var this = DatabricksFunctions.getApp(GetAppArgs.builder()
            .name("my-custom-app")
            .build());

    }
}

variables:
  this:
    fn::invoke:
      function: databricks:getApp
      arguments:
        name: my-custom-app

The following resources are used in the same context:

databricks.App to manage Databricks Apps.
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.

Using getApp

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.

TypeScript
Python
Go
C#
Java
YAML

function getApp(args: GetAppArgs, opts?: InvokeOptions): Promise<GetAppResult>
function getAppOutput(args: GetAppOutputArgs, opts?: InvokeOptions): Output<GetAppResult>

def get_app(name: Optional[str] = None,
            opts: Optional[InvokeOptions] = None) -> GetAppResult
def get_app_output(name: Optional[pulumi.Input[str]] = None,
            opts: Optional[InvokeOptions] = None) -> Output[GetAppResult]

func LookupApp(ctx *Context, args *LookupAppArgs, opts ...InvokeOption) (*LookupAppResult, error)
func LookupAppOutput(ctx *Context, args *LookupAppOutputArgs, opts ...InvokeOption) LookupAppResultOutput

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

public static class GetApp 
{
    public static Task<GetAppResult> InvokeAsync(GetAppArgs args, InvokeOptions? opts = null)
    public static Output<GetAppResult> Invoke(GetAppInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetAppResult> getApp(GetAppArgs args, InvokeOptions options)
public static Output<GetAppResult> getApp(GetAppArgs args, InvokeOptions options)

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

The following arguments are supported:

Name string: The name of the app.

Name string: The name of the app.

name String: The name of the app.

name string: The name of the app.

name str: The name of the app.

name String: The name of the app.

getApp Result

The following output properties are available:

App GetAppApp: attribute
Id string: The provider-assigned unique ID for this managed resource.
Name string: Name of the serving endpoint to grant permission on.

App GetAppApp: attribute
Id string: The provider-assigned unique ID for this managed resource.
Name string: Name of the serving endpoint to grant permission on.

app GetAppApp: attribute
id String: The provider-assigned unique ID for this managed resource.
name String: Name of the serving endpoint to grant permission on.

app GetAppApp: attribute
id string: The provider-assigned unique ID for this managed resource.
name string: Name of the serving endpoint to grant permission on.

app GetAppApp: attribute
id str: The provider-assigned unique ID for this managed resource.
name str: Name of the serving endpoint to grant permission on.

app Property Map: attribute
id String: The provider-assigned unique ID for this managed resource.
name String: Name of the serving endpoint to grant permission on.

Supporting Types

GetAppApp

ActiveDeployment GetAppAppActiveDeployment
AppStatus GetAppAppAppStatus: attribute
ComputeStatus GetAppAppComputeStatus: 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: Id of the job to grant permission on.
Name string: The name of the app.
Oauth2AppClientId string
Oauth2AppIntegrationId string
PendingDeployment GetAppAppPendingDeployment
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.
BudgetPolicyId string: The Budget Policy ID set for this resource.
Description string: The description of the resource.
Resources List<GetAppAppResource>: A list of resources that the app have access to.
UserApiScopes List<string>

ActiveDeployment GetAppAppActiveDeployment
AppStatus GetAppAppAppStatus: attribute
ComputeStatus GetAppAppComputeStatus: 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: Id of the job to grant permission on.
Name string: The name of the app.
Oauth2AppClientId string
Oauth2AppIntegrationId string
PendingDeployment GetAppAppPendingDeployment
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.
BudgetPolicyId string: The Budget Policy ID set for this resource.
Description string: The description of the resource.
Resources []GetAppAppResource: A list of resources that the app have access to.
UserApiScopes []string

activeDeployment GetAppAppActiveDeployment
appStatus GetAppAppAppStatus: attribute
computeStatus GetAppAppComputeStatus: 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: Id of the job to grant permission on.
name String: The name of the app.
oauth2AppClientId String
oauth2AppIntegrationId String
pendingDeployment GetAppAppPendingDeployment
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.
budgetPolicyId String: The Budget Policy ID set for this resource.
description String: The description of the resource.
resources List<GetAppAppResource>: A list of resources that the app have access to.
userApiScopes List<String>

activeDeployment GetAppAppActiveDeployment
appStatus GetAppAppAppStatus: attribute
computeStatus GetAppAppComputeStatus: 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: Id of the job to grant permission on.
name string: The name of the app.
oauth2AppClientId string
oauth2AppIntegrationId string
pendingDeployment GetAppAppPendingDeployment
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.
budgetPolicyId string: The Budget Policy ID set for this resource.
description string: The description of the resource.
resources GetAppAppResource[]: A list of resources that the app have access to.
userApiScopes string[]

active_deployment GetAppAppActiveDeployment
app_status GetAppAppAppStatus: attribute
compute_status GetAppAppComputeStatus: 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: Id of the job to grant permission on.
name str: The name of the app.
oauth2_app_client_id str
oauth2_app_integration_id str
pending_deployment GetAppAppPendingDeployment
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.
budget_policy_id str: The Budget Policy ID set for this resource.
description str: The description of the resource.
resources Sequence[GetAppAppResource]: A list of resources that the app have access to.
user_api_scopes Sequence[str]

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: Id of the job to grant permission on.
name String: The name of the app.
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.
budgetPolicyId String: The Budget Policy ID set for this resource.
description String: The description of the resource.
resources List<Property Map>: A list of resources that the app have access to.
userApiScopes List<String>

GetAppAppActiveDeployment

CreateTime string: The creation time of the app.
Creator string: The email of the user that created the app.
DeploymentArtifacts GetAppAppActiveDeploymentDeploymentArtifacts
Status GetAppAppActiveDeploymentStatus
UpdateTime string: The update time of the app.
DeploymentId string
Mode string
SourceCodePath string

CreateTime string: The creation time of the app.
Creator string: The email of the user that created the app.
DeploymentArtifacts GetAppAppActiveDeploymentDeploymentArtifacts
Status GetAppAppActiveDeploymentStatus
UpdateTime string: The update time of the app.
DeploymentId string
Mode string
SourceCodePath string

createTime String: The creation time of the app.
creator String: The email of the user that created the app.
deploymentArtifacts GetAppAppActiveDeploymentDeploymentArtifacts
status GetAppAppActiveDeploymentStatus
updateTime String: The update time of the app.
deploymentId String
mode String
sourceCodePath String

createTime string: The creation time of the app.
creator string: The email of the user that created the app.
deploymentArtifacts GetAppAppActiveDeploymentDeploymentArtifacts
status GetAppAppActiveDeploymentStatus
updateTime string: The update time of the app.
deploymentId string
mode string
sourceCodePath string

create_time str: The creation time of the app.
creator str: The email of the user that created the app.
deployment_artifacts GetAppAppActiveDeploymentDeploymentArtifacts
status GetAppAppActiveDeploymentStatus
update_time str: The update time of the app.
deployment_id str
mode str
source_code_path str

createTime String: The creation time of the app.
creator String: The email of the user that created the app.
deploymentArtifacts Property Map
status Property Map
updateTime String: The update time of the app.
deploymentId String
mode String
sourceCodePath String

GetAppAppActiveDeploymentDeploymentArtifacts

SourceCodePath string

SourceCodePath string

sourceCodePath String

sourceCodePath string

source_code_path str

sourceCodePath String

GetAppAppActiveDeploymentStatus

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.

GetAppAppAppStatus

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.

GetAppAppComputeStatus

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.

GetAppAppPendingDeployment

CreateTime string: The creation time of the app.
Creator string: The email of the user that created the app.
DeploymentArtifacts GetAppAppPendingDeploymentDeploymentArtifacts
Status GetAppAppPendingDeploymentStatus
UpdateTime string: The update time of the app.
DeploymentId string
Mode string
SourceCodePath string

CreateTime string: The creation time of the app.
Creator string: The email of the user that created the app.
DeploymentArtifacts GetAppAppPendingDeploymentDeploymentArtifacts
Status GetAppAppPendingDeploymentStatus
UpdateTime string: The update time of the app.
DeploymentId string
Mode string
SourceCodePath string

createTime String: The creation time of the app.
creator String: The email of the user that created the app.
deploymentArtifacts GetAppAppPendingDeploymentDeploymentArtifacts
status GetAppAppPendingDeploymentStatus
updateTime String: The update time of the app.
deploymentId String
mode String
sourceCodePath String

createTime string: The creation time of the app.
creator string: The email of the user that created the app.
deploymentArtifacts GetAppAppPendingDeploymentDeploymentArtifacts
status GetAppAppPendingDeploymentStatus
updateTime string: The update time of the app.
deploymentId string
mode string
sourceCodePath string

create_time str: The creation time of the app.
creator str: The email of the user that created the app.
deployment_artifacts GetAppAppPendingDeploymentDeploymentArtifacts
status GetAppAppPendingDeploymentStatus
update_time str: The update time of the app.
deployment_id str
mode str
source_code_path str

createTime String: The creation time of the app.
creator String: The email of the user that created the app.
deploymentArtifacts Property Map
status Property Map
updateTime String: The update time of the app.
deploymentId String
mode String
sourceCodePath String

GetAppAppPendingDeploymentDeploymentArtifacts

SourceCodePath string

SourceCodePath string

sourceCodePath String

sourceCodePath string

source_code_path str

sourceCodePath String

GetAppAppPendingDeploymentStatus

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.

GetAppAppResource

Name string: The name of the app.
Description string: The description of the resource.
Job GetAppAppResourceJob: attribute
Secret GetAppAppResourceSecret: attribute
ServingEndpoint GetAppAppResourceServingEndpoint: attribute
SqlWarehouse GetAppAppResourceSqlWarehouse: attribute

Name string: The name of the app.
Description string: The description of the resource.
Job GetAppAppResourceJob: attribute
Secret GetAppAppResourceSecret: attribute
ServingEndpoint GetAppAppResourceServingEndpoint: attribute
SqlWarehouse GetAppAppResourceSqlWarehouse: attribute

name String: The name of the app.
description String: The description of the resource.
job GetAppAppResourceJob: attribute
secret GetAppAppResourceSecret: attribute
servingEndpoint GetAppAppResourceServingEndpoint: attribute
sqlWarehouse GetAppAppResourceSqlWarehouse: attribute

name string: The name of the app.
description string: The description of the resource.
job GetAppAppResourceJob: attribute
secret GetAppAppResourceSecret: attribute
servingEndpoint GetAppAppResourceServingEndpoint: attribute
sqlWarehouse GetAppAppResourceSqlWarehouse: attribute

name str: The name of the app.
description str: The description of the resource.
job GetAppAppResourceJob: attribute
secret GetAppAppResourceSecret: attribute
serving_endpoint GetAppAppResourceServingEndpoint: attribute
sql_warehouse GetAppAppResourceSqlWarehouse: attribute

name String: The name of the app.
description String: The description of the resource.
job Property Map: attribute
secret Property Map: attribute
servingEndpoint Property Map: attribute
sqlWarehouse Property Map: attribute

GetAppAppResourceJob

Id string: Id of the job to grant permission on.
Permission string: Permissions to grant on the Job. Supported permissions are: CAN_MANAGE, IS_OWNER, CAN_MANAGE_RUN, CAN_VIEW.

Id string: Id of the job to grant permission on.
Permission string: Permissions to grant on the Job. Supported permissions are: CAN_MANAGE, IS_OWNER, CAN_MANAGE_RUN, CAN_VIEW.

id String: Id of the job to grant permission on.
permission String: Permissions to grant on the Job. Supported permissions are: CAN_MANAGE, IS_OWNER, CAN_MANAGE_RUN, CAN_VIEW.

id string: Id of the job to grant permission on.
permission string: Permissions to grant on the Job. Supported permissions are: CAN_MANAGE, IS_OWNER, CAN_MANAGE_RUN, CAN_VIEW.

id str: Id of the job to grant permission on.
permission str: Permissions to grant on the Job. Supported permissions are: CAN_MANAGE, IS_OWNER, CAN_MANAGE_RUN, CAN_VIEW.

id String: Id of the job to grant permission on.
permission String: Permissions to grant on the Job. Supported permissions are: CAN_MANAGE, IS_OWNER, CAN_MANAGE_RUN, CAN_VIEW.

GetAppAppResourceSecret

Key string: Key of the secret to grant permission on.
Permission string: Permissions to grant on the Job. Supported permissions are: CAN_MANAGE, IS_OWNER, CAN_MANAGE_RUN, CAN_VIEW.
Scope string: Scope of the secret to grant permission on.

Key string: Key of the secret to grant permission on.
Permission string: Permissions to grant on the Job. Supported permissions are: CAN_MANAGE, IS_OWNER, CAN_MANAGE_RUN, CAN_VIEW.
Scope string: Scope of the secret to grant permission on.

key String: Key of the secret to grant permission on.
permission String: Permissions to grant on the Job. Supported permissions are: CAN_MANAGE, IS_OWNER, CAN_MANAGE_RUN, CAN_VIEW.
scope String: Scope of the secret to grant permission on.

key string: Key of the secret to grant permission on.
permission string: Permissions to grant on the Job. Supported permissions are: CAN_MANAGE, IS_OWNER, CAN_MANAGE_RUN, CAN_VIEW.
scope string: Scope of the secret to grant permission on.

key str: Key of the secret to grant permission on.
permission str: Permissions to grant on the Job. Supported permissions are: CAN_MANAGE, IS_OWNER, CAN_MANAGE_RUN, CAN_VIEW.
scope str: Scope of the secret to grant permission on.

key String: Key of the secret to grant permission on.
permission String: Permissions to grant on the Job. Supported permissions are: CAN_MANAGE, IS_OWNER, CAN_MANAGE_RUN, CAN_VIEW.
scope String: Scope of the secret to grant permission on.

GetAppAppResourceServingEndpoint

Name string: The name of the app.
Permission string: Permissions to grant on the Job. Supported permissions are: CAN_MANAGE, IS_OWNER, CAN_MANAGE_RUN, CAN_VIEW.

Name string: The name of the app.
Permission string: Permissions to grant on the Job. Supported permissions are: CAN_MANAGE, IS_OWNER, CAN_MANAGE_RUN, CAN_VIEW.

name String: The name of the app.
permission String: Permissions to grant on the Job. Supported permissions are: CAN_MANAGE, IS_OWNER, CAN_MANAGE_RUN, CAN_VIEW.

name string: The name of the app.
permission string: Permissions to grant on the Job. Supported permissions are: CAN_MANAGE, IS_OWNER, CAN_MANAGE_RUN, CAN_VIEW.

name str: The name of the app.
permission str: Permissions to grant on the Job. Supported permissions are: CAN_MANAGE, IS_OWNER, CAN_MANAGE_RUN, CAN_VIEW.

name String: The name of the app.
permission String: Permissions to grant on the Job. Supported permissions are: CAN_MANAGE, IS_OWNER, CAN_MANAGE_RUN, CAN_VIEW.

GetAppAppResourceSqlWarehouse

Id string: Id of the job to grant permission on.
Permission string: Permissions to grant on the Job. Supported permissions are: CAN_MANAGE, IS_OWNER, CAN_MANAGE_RUN, CAN_VIEW.

Id string: Id of the job to grant permission on.
Permission string: Permissions to grant on the Job. Supported permissions are: CAN_MANAGE, IS_OWNER, CAN_MANAGE_RUN, CAN_VIEW.

id String: Id of the job to grant permission on.
permission String: Permissions to grant on the Job. Supported permissions are: CAN_MANAGE, IS_OWNER, CAN_MANAGE_RUN, CAN_VIEW.

id string: Id of the job to grant permission on.
permission string: Permissions to grant on the Job. Supported permissions are: CAN_MANAGE, IS_OWNER, CAN_MANAGE_RUN, CAN_VIEW.

id str: Id of the job to grant permission on.
permission str: Permissions to grant on the Job. Supported permissions are: CAN_MANAGE, IS_OWNER, CAN_MANAGE_RUN, CAN_VIEW.

id String: Id of the job to grant permission on.
permission String: Permissions to grant on the Job. Supported permissions are: CAN_MANAGE, IS_OWNER, CAN_MANAGE_RUN, CAN_VIEW.

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

databricks.getApp

On this page

On this page

Example Usage

Using getApp

getApp Result

Supporting Types

GetAppApp

GetAppAppActiveDeployment

GetAppAppActiveDeploymentDeploymentArtifacts

GetAppAppActiveDeploymentStatus

GetAppAppAppStatus

GetAppAppComputeStatus

GetAppAppPendingDeployment

GetAppAppPendingDeploymentDeploymentArtifacts

GetAppAppPendingDeploymentStatus

GetAppAppResource

GetAppAppResourceJob

GetAppAppResourceSecret

GetAppAppResourceServingEndpoint

GetAppAppResourceSqlWarehouse

Package Details

On this page

On this page

databricks.getApp

On this page

On this page

Example Usage

Related Resources

Using getApp

getApp Result

Supporting Types

GetAppApp

GetAppAppActiveDeployment

GetAppAppActiveDeploymentDeploymentArtifacts

GetAppAppActiveDeploymentStatus

GetAppAppAppStatus

GetAppAppComputeStatus

GetAppAppPendingDeployment

GetAppAppPendingDeploymentDeploymentArtifacts

GetAppAppPendingDeploymentStatus

GetAppAppResource

GetAppAppResourceJob

GetAppAppResourceSecret

GetAppAppResourceServingEndpoint

GetAppAppResourceSqlWarehouse

Package Details

On this page

On this page