Databricks SDK for JavaScript
    Preparing search index...

    Interface App

    interface App {
        activeDeployment?: AppDeployment;
        appStatus?: ApplicationStatus;
        budgetPolicyId?: string;
        computeMaxInstances?: number;
        computeMinInstances?: number;
        computeSize?: ComputeSize;
        computeStatus?: ComputeStatus;
        createTime?: Instant;
        creator?: string;
        defaultGitSource?: GitSource;
        defaultSourceCodePath?: string;
        deploymentSource?:
            | { $case: "sourceCodePath"; sourceCodePath: string }
            | { $case: "gitSource"; gitSource: GitSource };
        description?: string;
        effectiveBudgetPolicyId?: string;
        effectiveUsagePolicyId?: string;
        effectiveUserApiScopes?: string[];
        forwardUserAccessToken?: boolean;
        gitRepository?: GitRepository;
        id?: string;
        name?: string;
        oauth2AppClientId?: string;
        oauth2AppIntegrationId?: string;
        pendingDeployment?: AppDeployment;
        resources?: AppResource[];
        servicePrincipalClientId?: string;
        servicePrincipalId?: bigint;
        servicePrincipalName?: string;
        space?: string;
        telemetryExportDestinations?: TelemetryExportDestination[];
        thumbnailUrl?: string;
        updater?: string;
        updateTime?: Instant;
        url?: string;
        usagePolicyId?: string;
        userApiScopes?: string[];
    }
    Index

    Properties

    activeDeployment? appStatus? budgetPolicyId? computeMaxInstances? computeMinInstances? computeSize? computeStatus? createTime? creator? defaultGitSource? defaultSourceCodePath? deploymentSource? description? effectiveBudgetPolicyId? effectiveUsagePolicyId? effectiveUserApiScopes? forwardUserAccessToken? gitRepository? id? name? oauth2AppClientId? oauth2AppIntegrationId? pendingDeployment? resources? servicePrincipalClientId? servicePrincipalId? servicePrincipalName? space? telemetryExportDestinations? thumbnailUrl? updater? updateTime? url? usagePolicyId? userApiScopes?

    Properties

    activeDeployment?: AppDeployment

    The active deployment of the app. A deployment is considered active when it has been deployed to the app compute.

    appStatus?: ApplicationStatus
    budgetPolicyId?: string
    computeMaxInstances?: number

    Maximum number of app instances. Must be set together with compute_min_instances.

    computeMinInstances?: number

    Minimum number of app instances. Must be set together with compute_max_instances.

    computeSize?: ComputeSize
    computeStatus?: ComputeStatus
    createTime?: Instant

    The creation time of the app. Formatted timestamp in ISO 6801.

    creator?: string

    The email of the user that created the app.

    defaultGitSource?: GitSource

    The Git source of the app's most recent active deployment, including the repository configuration and the resolved reference. Populated by the system after a Git-based deployment and used as the default reference when automatic deployments are enabled.

    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.

    deploymentSource?:
        | { $case: "sourceCodePath"; sourceCodePath: string }
        | { $case: "gitSource"; gitSource: GitSource }

    Type Declaration

    • { $case: "sourceCodePath"; sourceCodePath: string }
    • { $case: "gitSource"; gitSource: GitSource }
      • $case: "gitSource"
      • gitSource: GitSource

        The Git source to deploy from, specifying the reference to check out (branch, tag, or commit) and an optional path to the app source code within the repository configured in git_repository.

    description?: string

    The description of the app.

    effectiveBudgetPolicyId?: string
    effectiveUsagePolicyId?: string
    effectiveUserApiScopes?: string[]

    The effective api scopes granted to the user access token.

    forwardUserAccessToken?: boolean

    Forward the user's access token to the app. Requires stopping and starting app compute to take effect.

    gitRepository?: GitRepository

    Git repository configuration for app deployments. When specified, deployments can reference code from this repository by providing only the git reference (branch, tag, or commit).

    id?: string

    The unique identifier 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.

    oauth2AppClientId?: string
    oauth2AppIntegrationId?: string
    pendingDeployment?: AppDeployment

    The pending deployment of the app. A deployment is considered pending when it is being prepared for deployment to the app compute.

    resources?: AppResource[]

    Resources for the app.

    servicePrincipalClientId?: string
    servicePrincipalId?: bigint
    servicePrincipalName?: string
    space?: string

    Name of the space this app belongs to.

    telemetryExportDestinations?: TelemetryExportDestination[]
    thumbnailUrl?: string

    The URL of the thumbnail image for the app.

    updater?: string

    The email of the user that last updated the app.

    updateTime?: Instant

    The update time of the app. Formatted timestamp in ISO 6801.

    url?: string

    The URL of the app once it is deployed.

    usagePolicyId?: string
    userApiScopes?: string[]

    Settings

    Member Visibility

    On This Page

    Properties