Databricks v1.57.1, Jan 10 25

Databricks v1.57.1 published on Friday, Jan 10, 2025 by Pulumi

databricks.getApps

Explore with Pulumi AI

Databricks v1.57.1 published on Friday, Jan 10, 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 all Databricks Apps within a workspace.

Example Usage

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

const allApps = databricks.getApps({});

import pulumi
import pulumi_databricks as databricks

all_apps = databricks.get_apps()

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.GetApps(ctx, map[string]interface{}{}, 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 allApps = Databricks.GetApps.Invoke();

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.databricks.DatabricksFunctions;
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 allApps = DatabricksFunctions.getApps();

    }
}

variables:
  allApps:
    fn::invoke:
      function: databricks:getApps
      arguments: {}

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 getApps

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getApps(opts?: InvokeOptions): Promise<GetAppsResult>
function getAppsOutput(opts?: InvokeOptions): Output<GetAppsResult>

def get_apps(opts: Optional[InvokeOptions] = None) -> GetAppsResult
def get_apps_output(opts: Optional[InvokeOptions] = None) -> Output[GetAppsResult]

func GetApps(ctx *Context, opts ...InvokeOption) (*GetAppsResult, error)
func GetAppsOutput(ctx *Context, opts ...InvokeOption) GetAppsResultOutput

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

public static class GetApps 
{
    public static Task<GetAppsResult> InvokeAsync(InvokeOptions? opts = null)
    public static Output<GetAppsResult> Invoke(InvokeOptions? opts = null)
}

public static CompletableFuture<GetAppsResult> getApps(InvokeOptions options)
// Output-based functions aren't available in Java yet

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

getApps Result

The following output properties are available:

Apps List<GetAppsApp>
Id string: The provider-assigned unique ID for this managed resource.

Apps []GetAppsApp
Id string: The provider-assigned unique ID for this managed resource.

apps List<GetAppsApp>
id String: The provider-assigned unique ID for this managed resource.

apps GetAppsApp[]
id string: The provider-assigned unique ID for this managed resource.

apps Sequence[GetAppsApp]
id str: The provider-assigned unique ID for this managed resource.

apps List<Property Map>
id String: The provider-assigned unique ID for this managed resource.

Supporting Types

GetAppsApp

ActiveDeployment GetAppsAppActiveDeployment
AppStatus GetAppsAppAppStatus: attribute
ComputeStatus GetAppsAppComputeStatus: 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.
Name string: Name of the serving endpoint to grant permission on.
PendingDeployment GetAppsAppPendingDeployment
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.
Description string: The description of the resource.
Resources List<GetAppsAppResource>: A list of resources that the app have access to.

ActiveDeployment GetAppsAppActiveDeployment
AppStatus GetAppsAppAppStatus: attribute
ComputeStatus GetAppsAppComputeStatus: 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.
Name string: Name of the serving endpoint to grant permission on.
PendingDeployment GetAppsAppPendingDeployment
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.
Description string: The description of the resource.
Resources []GetAppsAppResource: A list of resources that the app have access to.

activeDeployment GetAppsAppActiveDeployment
appStatus GetAppsAppAppStatus: attribute
computeStatus GetAppsAppComputeStatus: 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.
name String: Name of the serving endpoint to grant permission on.
pendingDeployment GetAppsAppPendingDeployment
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.
description String: The description of the resource.
resources List<GetAppsAppResource>: A list of resources that the app have access to.

activeDeployment GetAppsAppActiveDeployment
appStatus GetAppsAppAppStatus: attribute
computeStatus GetAppsAppComputeStatus: 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.
name string: Name of the serving endpoint to grant permission on.
pendingDeployment GetAppsAppPendingDeployment
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.
description string: The description of the resource.
resources GetAppsAppResource[]: A list of resources that the app have access to.

active_deployment GetAppsAppActiveDeployment
app_status GetAppsAppAppStatus: attribute
compute_status GetAppsAppComputeStatus: 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.
name str: Name of the serving endpoint to grant permission on.
pending_deployment GetAppsAppPendingDeployment
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.
description str: The description of the resource.
resources Sequence[GetAppsAppResource]: A list of resources that the app have access to.

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.
name String: Name of the serving endpoint to grant permission on.
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.
description String: The description of the resource.
resources List<Property Map>: A list of resources that the app have access to.

GetAppsAppActiveDeployment

CreateTime string: The creation time of the app.
Creator string: The email of the user that created the app.
DeploymentArtifacts GetAppsAppActiveDeploymentDeploymentArtifacts
Status GetAppsAppActiveDeploymentStatus
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 GetAppsAppActiveDeploymentDeploymentArtifacts
Status GetAppsAppActiveDeploymentStatus
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 GetAppsAppActiveDeploymentDeploymentArtifacts
status GetAppsAppActiveDeploymentStatus
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 GetAppsAppActiveDeploymentDeploymentArtifacts
status GetAppsAppActiveDeploymentStatus
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 GetAppsAppActiveDeploymentDeploymentArtifacts
status GetAppsAppActiveDeploymentStatus
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

GetAppsAppActiveDeploymentDeploymentArtifacts

SourceCodePath string

SourceCodePath string

sourceCodePath String

sourceCodePath string

source_code_path str

sourceCodePath String

GetAppsAppActiveDeploymentStatus

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.

GetAppsAppAppStatus

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.

GetAppsAppComputeStatus

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.

GetAppsAppPendingDeployment

CreateTime string: The creation time of the app.
Creator string: The email of the user that created the app.
DeploymentArtifacts GetAppsAppPendingDeploymentDeploymentArtifacts
Status GetAppsAppPendingDeploymentStatus
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 GetAppsAppPendingDeploymentDeploymentArtifacts
Status GetAppsAppPendingDeploymentStatus
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 GetAppsAppPendingDeploymentDeploymentArtifacts
status GetAppsAppPendingDeploymentStatus
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 GetAppsAppPendingDeploymentDeploymentArtifacts
status GetAppsAppPendingDeploymentStatus
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 GetAppsAppPendingDeploymentDeploymentArtifacts
status GetAppsAppPendingDeploymentStatus
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

GetAppsAppPendingDeploymentDeploymentArtifacts

SourceCodePath string

SourceCodePath string

sourceCodePath String

sourceCodePath string

source_code_path str

sourceCodePath String

GetAppsAppPendingDeploymentStatus

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.

GetAppsAppResource

Name string: Name of the serving endpoint to grant permission on.
Description string: The description of the resource.
Job GetAppsAppResourceJob: attribute
Secret GetAppsAppResourceSecret: attribute
ServingEndpoint GetAppsAppResourceServingEndpoint: attribute
SqlWarehouse GetAppsAppResourceSqlWarehouse: attribute

Name string: Name of the serving endpoint to grant permission on.
Description string: The description of the resource.
Job GetAppsAppResourceJob: attribute
Secret GetAppsAppResourceSecret: attribute
ServingEndpoint GetAppsAppResourceServingEndpoint: attribute
SqlWarehouse GetAppsAppResourceSqlWarehouse: attribute

name String: Name of the serving endpoint to grant permission on.
description String: The description of the resource.
job GetAppsAppResourceJob: attribute
secret GetAppsAppResourceSecret: attribute
servingEndpoint GetAppsAppResourceServingEndpoint: attribute
sqlWarehouse GetAppsAppResourceSqlWarehouse: attribute

name string: Name of the serving endpoint to grant permission on.
description string: The description of the resource.
job GetAppsAppResourceJob: attribute
secret GetAppsAppResourceSecret: attribute
servingEndpoint GetAppsAppResourceServingEndpoint: attribute
sqlWarehouse GetAppsAppResourceSqlWarehouse: attribute

name str: Name of the serving endpoint to grant permission on.
description str: The description of the resource.
job GetAppsAppResourceJob: attribute
secret GetAppsAppResourceSecret: attribute
serving_endpoint GetAppsAppResourceServingEndpoint: attribute
sql_warehouse GetAppsAppResourceSqlWarehouse: attribute

name String: Name of the serving endpoint to grant permission on.
description String: The description of the resource.
job Property Map: attribute
secret Property Map: attribute
servingEndpoint Property Map: attribute
sqlWarehouse Property Map: attribute

GetAppsAppResourceJob

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.

GetAppsAppResourceSecret

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.

GetAppsAppResourceServingEndpoint

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

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

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

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

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

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

GetAppsAppResourceSqlWarehouse

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.57.1 published on Friday, Jan 10, 2025 by Pulumi

pulumi/pulumi-databricks

databricks.getApps

On this page

On this page

Example Usage

Using getApps

getApps Result

Supporting Types

GetAppsApp

GetAppsAppActiveDeployment

GetAppsAppActiveDeploymentDeploymentArtifacts

GetAppsAppActiveDeploymentStatus

GetAppsAppAppStatus

GetAppsAppComputeStatus

GetAppsAppPendingDeployment

GetAppsAppPendingDeploymentDeploymentArtifacts

GetAppsAppPendingDeploymentStatus

GetAppsAppResource

GetAppsAppResourceJob

GetAppsAppResourceSecret

GetAppsAppResourceServingEndpoint

GetAppsAppResourceSqlWarehouse

Package Details

On this page

On this page

databricks.getApps

On this page

On this page

Example Usage

Related Resources

Using getApps

getApps Result

Supporting Types

GetAppsApp

GetAppsAppActiveDeployment

GetAppsAppActiveDeploymentDeploymentArtifacts

GetAppsAppActiveDeploymentStatus

GetAppsAppAppStatus

GetAppsAppComputeStatus

GetAppsAppPendingDeployment

GetAppsAppPendingDeploymentDeploymentArtifacts

GetAppsAppPendingDeploymentStatus

GetAppsAppResource

GetAppsAppResourceJob

GetAppsAppResourceSecret

GetAppsAppResourceServingEndpoint

GetAppsAppResourceSqlWarehouse

Package Details

On this page

On this page