1. Packages
  2. Databricks Provider
  3. API Docs
  4. getAppsSettingsCustomTemplate
Databricks v1.75.0 published on Thursday, Sep 11, 2025 by Pulumi

databricks.getAppsSettingsCustomTemplate

Explore with Pulumi AI

databricks logo
Databricks v1.75.0 published on Thursday, Sep 11, 2025 by Pulumi

    This data source can be used to get a single Custom Template.

    Example Usage

    Referring to a Custom Template by name:

    import * as pulumi from "@pulumi/pulumi";
    import * as databricks from "@pulumi/databricks";
    
    const myTemplate = databricks.getAppsSettingsCustomTemplate({
        name: "my-custom-template",
    });
    
    import pulumi
    import pulumi_databricks as databricks
    
    my_template = databricks.get_apps_settings_custom_template(name="my-custom-template")
    
    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.LookupAppsSettingsCustomTemplate(ctx, &databricks.LookupAppsSettingsCustomTemplateArgs{
    			Name: "my-custom-template",
    		}, 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 myTemplate = Databricks.GetAppsSettingsCustomTemplate.Invoke(new()
        {
            Name = "my-custom-template",
        });
    
    });
    
    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.GetAppsSettingsCustomTemplateArgs;
    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 myTemplate = DatabricksFunctions.getAppsSettingsCustomTemplate(GetAppsSettingsCustomTemplateArgs.builder()
                .name("my-custom-template")
                .build());
    
        }
    }
    
    variables:
      myTemplate:
        fn::invoke:
          function: databricks:getAppsSettingsCustomTemplate
          arguments:
            name: my-custom-template
    

    Using getAppsSettingsCustomTemplate

    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 getAppsSettingsCustomTemplate(args: GetAppsSettingsCustomTemplateArgs, opts?: InvokeOptions): Promise<GetAppsSettingsCustomTemplateResult>
    function getAppsSettingsCustomTemplateOutput(args: GetAppsSettingsCustomTemplateOutputArgs, opts?: InvokeOptions): Output<GetAppsSettingsCustomTemplateResult>
    def get_apps_settings_custom_template(description: Optional[str] = None,
                                          git_provider: Optional[str] = None,
                                          git_repo: Optional[str] = None,
                                          manifest: Optional[GetAppsSettingsCustomTemplateManifest] = None,
                                          name: Optional[str] = None,
                                          path: Optional[str] = None,
                                          workspace_id: Optional[str] = None,
                                          opts: Optional[InvokeOptions] = None) -> GetAppsSettingsCustomTemplateResult
    def get_apps_settings_custom_template_output(description: Optional[pulumi.Input[str]] = None,
                                          git_provider: Optional[pulumi.Input[str]] = None,
                                          git_repo: Optional[pulumi.Input[str]] = None,
                                          manifest: Optional[pulumi.Input[GetAppsSettingsCustomTemplateManifestArgs]] = None,
                                          name: Optional[pulumi.Input[str]] = None,
                                          path: Optional[pulumi.Input[str]] = None,
                                          workspace_id: Optional[pulumi.Input[str]] = None,
                                          opts: Optional[InvokeOptions] = None) -> Output[GetAppsSettingsCustomTemplateResult]
    func LookupAppsSettingsCustomTemplate(ctx *Context, args *LookupAppsSettingsCustomTemplateArgs, opts ...InvokeOption) (*LookupAppsSettingsCustomTemplateResult, error)
    func LookupAppsSettingsCustomTemplateOutput(ctx *Context, args *LookupAppsSettingsCustomTemplateOutputArgs, opts ...InvokeOption) LookupAppsSettingsCustomTemplateResultOutput

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

    public static class GetAppsSettingsCustomTemplate 
    {
        public static Task<GetAppsSettingsCustomTemplateResult> InvokeAsync(GetAppsSettingsCustomTemplateArgs args, InvokeOptions? opts = null)
        public static Output<GetAppsSettingsCustomTemplateResult> Invoke(GetAppsSettingsCustomTemplateInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetAppsSettingsCustomTemplateResult> getAppsSettingsCustomTemplate(GetAppsSettingsCustomTemplateArgs args, InvokeOptions options)
    public static Output<GetAppsSettingsCustomTemplateResult> getAppsSettingsCustomTemplate(GetAppsSettingsCustomTemplateArgs args, InvokeOptions options)
    
    fn::invoke:
      function: databricks:index/getAppsSettingsCustomTemplate:getAppsSettingsCustomTemplate
      arguments:
        # arguments dictionary

    The following arguments are supported:

    GitProvider string
    (string) - The Git provider of the template
    GitRepo string
    (string) - The Git repository URL that the template resides in
    Manifest GetAppsSettingsCustomTemplateManifest
    (AppManifest) - The manifest of the template. It defines fields and default values when installing the template
    Name string
    The name of the template. It must contain only alphanumeric characters, hyphens, underscores, and whitespaces. It must be unique within the workspace
    Path string
    (string) - The path to the template within the Git repository
    Description string
    (string) - Description of the App Resource
    WorkspaceId string
    Workspace ID of the resource
    GitProvider string
    (string) - The Git provider of the template
    GitRepo string
    (string) - The Git repository URL that the template resides in
    Manifest GetAppsSettingsCustomTemplateManifest
    (AppManifest) - The manifest of the template. It defines fields and default values when installing the template
    Name string
    The name of the template. It must contain only alphanumeric characters, hyphens, underscores, and whitespaces. It must be unique within the workspace
    Path string
    (string) - The path to the template within the Git repository
    Description string
    (string) - Description of the App Resource
    WorkspaceId string
    Workspace ID of the resource
    gitProvider String
    (string) - The Git provider of the template
    gitRepo String
    (string) - The Git repository URL that the template resides in
    manifest GetAppsSettingsCustomTemplateManifest
    (AppManifest) - The manifest of the template. It defines fields and default values when installing the template
    name String
    The name of the template. It must contain only alphanumeric characters, hyphens, underscores, and whitespaces. It must be unique within the workspace
    path String
    (string) - The path to the template within the Git repository
    description String
    (string) - Description of the App Resource
    workspaceId String
    Workspace ID of the resource
    gitProvider string
    (string) - The Git provider of the template
    gitRepo string
    (string) - The Git repository URL that the template resides in
    manifest GetAppsSettingsCustomTemplateManifest
    (AppManifest) - The manifest of the template. It defines fields and default values when installing the template
    name string
    The name of the template. It must contain only alphanumeric characters, hyphens, underscores, and whitespaces. It must be unique within the workspace
    path string
    (string) - The path to the template within the Git repository
    description string
    (string) - Description of the App Resource
    workspaceId string
    Workspace ID of the resource
    git_provider str
    (string) - The Git provider of the template
    git_repo str
    (string) - The Git repository URL that the template resides in
    manifest GetAppsSettingsCustomTemplateManifest
    (AppManifest) - The manifest of the template. It defines fields and default values when installing the template
    name str
    The name of the template. It must contain only alphanumeric characters, hyphens, underscores, and whitespaces. It must be unique within the workspace
    path str
    (string) - The path to the template within the Git repository
    description str
    (string) - Description of the App Resource
    workspace_id str
    Workspace ID of the resource
    gitProvider String
    (string) - The Git provider of the template
    gitRepo String
    (string) - The Git repository URL that the template resides in
    manifest Property Map
    (AppManifest) - The manifest of the template. It defines fields and default values when installing the template
    name String
    The name of the template. It must contain only alphanumeric characters, hyphens, underscores, and whitespaces. It must be unique within the workspace
    path String
    (string) - The path to the template within the Git repository
    description String
    (string) - Description of the App Resource
    workspaceId String
    Workspace ID of the resource

    getAppsSettingsCustomTemplate Result

    The following output properties are available:

    Creator string
    (string)
    GitProvider string
    (string) - The Git provider of the template
    GitRepo string
    (string) - The Git repository URL that the template resides in
    Id string
    The provider-assigned unique ID for this managed resource.
    Manifest GetAppsSettingsCustomTemplateManifest
    (AppManifest) - The manifest of the template. It defines fields and default values when installing the template
    Name string
    (string) - Name of the App Resource
    Path string
    (string) - The path to the template within the Git repository
    Description string
    (string) - Description of the App Resource
    WorkspaceId string
    Creator string
    (string)
    GitProvider string
    (string) - The Git provider of the template
    GitRepo string
    (string) - The Git repository URL that the template resides in
    Id string
    The provider-assigned unique ID for this managed resource.
    Manifest GetAppsSettingsCustomTemplateManifest
    (AppManifest) - The manifest of the template. It defines fields and default values when installing the template
    Name string
    (string) - Name of the App Resource
    Path string
    (string) - The path to the template within the Git repository
    Description string
    (string) - Description of the App Resource
    WorkspaceId string
    creator String
    (string)
    gitProvider String
    (string) - The Git provider of the template
    gitRepo String
    (string) - The Git repository URL that the template resides in
    id String
    The provider-assigned unique ID for this managed resource.
    manifest GetAppsSettingsCustomTemplateManifest
    (AppManifest) - The manifest of the template. It defines fields and default values when installing the template
    name String
    (string) - Name of the App Resource
    path String
    (string) - The path to the template within the Git repository
    description String
    (string) - Description of the App Resource
    workspaceId String
    creator string
    (string)
    gitProvider string
    (string) - The Git provider of the template
    gitRepo string
    (string) - The Git repository URL that the template resides in
    id string
    The provider-assigned unique ID for this managed resource.
    manifest GetAppsSettingsCustomTemplateManifest
    (AppManifest) - The manifest of the template. It defines fields and default values when installing the template
    name string
    (string) - Name of the App Resource
    path string
    (string) - The path to the template within the Git repository
    description string
    (string) - Description of the App Resource
    workspaceId string
    creator str
    (string)
    git_provider str
    (string) - The Git provider of the template
    git_repo str
    (string) - The Git repository URL that the template resides in
    id str
    The provider-assigned unique ID for this managed resource.
    manifest GetAppsSettingsCustomTemplateManifest
    (AppManifest) - The manifest of the template. It defines fields and default values when installing the template
    name str
    (string) - Name of the App Resource
    path str
    (string) - The path to the template within the Git repository
    description str
    (string) - Description of the App Resource
    workspace_id str
    creator String
    (string)
    gitProvider String
    (string) - The Git provider of the template
    gitRepo String
    (string) - The Git repository URL that the template resides in
    id String
    The provider-assigned unique ID for this managed resource.
    manifest Property Map
    (AppManifest) - The manifest of the template. It defines fields and default values when installing the template
    name String
    (string) - Name of the App Resource
    path String
    (string) - The path to the template within the Git repository
    description String
    (string) - Description of the App Resource
    workspaceId String

    Supporting Types

    GetAppsSettingsCustomTemplateManifest

    Name string
    The name of the template. It must contain only alphanumeric characters, hyphens, underscores, and whitespaces. It must be unique within the workspace
    Version int
    (integer) - The manifest schema version, for now only 1 is allowed
    Description string
    (string) - Description of the App Resource
    ResourceSpecs List<GetAppsSettingsCustomTemplateManifestResourceSpec>
    (list of AppManifestAppResourceSpec)
    Name string
    The name of the template. It must contain only alphanumeric characters, hyphens, underscores, and whitespaces. It must be unique within the workspace
    Version int
    (integer) - The manifest schema version, for now only 1 is allowed
    Description string
    (string) - Description of the App Resource
    ResourceSpecs []GetAppsSettingsCustomTemplateManifestResourceSpec
    (list of AppManifestAppResourceSpec)
    name String
    The name of the template. It must contain only alphanumeric characters, hyphens, underscores, and whitespaces. It must be unique within the workspace
    version Integer
    (integer) - The manifest schema version, for now only 1 is allowed
    description String
    (string) - Description of the App Resource
    resourceSpecs List<GetAppsSettingsCustomTemplateManifestResourceSpec>
    (list of AppManifestAppResourceSpec)
    name string
    The name of the template. It must contain only alphanumeric characters, hyphens, underscores, and whitespaces. It must be unique within the workspace
    version number
    (integer) - The manifest schema version, for now only 1 is allowed
    description string
    (string) - Description of the App Resource
    resourceSpecs GetAppsSettingsCustomTemplateManifestResourceSpec[]
    (list of AppManifestAppResourceSpec)
    name str
    The name of the template. It must contain only alphanumeric characters, hyphens, underscores, and whitespaces. It must be unique within the workspace
    version int
    (integer) - The manifest schema version, for now only 1 is allowed
    description str
    (string) - Description of the App Resource
    resource_specs Sequence[GetAppsSettingsCustomTemplateManifestResourceSpec]
    (list of AppManifestAppResourceSpec)
    name String
    The name of the template. It must contain only alphanumeric characters, hyphens, underscores, and whitespaces. It must be unique within the workspace
    version Number
    (integer) - The manifest schema version, for now only 1 is allowed
    description String
    (string) - Description of the App Resource
    resourceSpecs List<Property Map>
    (list of AppManifestAppResourceSpec)

    GetAppsSettingsCustomTemplateManifestResourceSpec

    Name string
    The name of the template. It must contain only alphanumeric characters, hyphens, underscores, and whitespaces. It must be unique within the workspace
    Description string
    (string) - Description of the App Resource
    JobSpec GetAppsSettingsCustomTemplateManifestResourceSpecJobSpec
    (AppManifestAppResourceJobSpec)
    SecretSpec GetAppsSettingsCustomTemplateManifestResourceSpecSecretSpec
    (AppManifestAppResourceSecretSpec)
    ServingEndpointSpec GetAppsSettingsCustomTemplateManifestResourceSpecServingEndpointSpec
    (AppManifestAppResourceServingEndpointSpec)
    SqlWarehouseSpec GetAppsSettingsCustomTemplateManifestResourceSpecSqlWarehouseSpec
    (AppManifestAppResourceSqlWarehouseSpec)
    UcSecurableSpec GetAppsSettingsCustomTemplateManifestResourceSpecUcSecurableSpec
    (AppManifestAppResourceUcSecurableSpec)
    Name string
    The name of the template. It must contain only alphanumeric characters, hyphens, underscores, and whitespaces. It must be unique within the workspace
    Description string
    (string) - Description of the App Resource
    JobSpec GetAppsSettingsCustomTemplateManifestResourceSpecJobSpec
    (AppManifestAppResourceJobSpec)
    SecretSpec GetAppsSettingsCustomTemplateManifestResourceSpecSecretSpec
    (AppManifestAppResourceSecretSpec)
    ServingEndpointSpec GetAppsSettingsCustomTemplateManifestResourceSpecServingEndpointSpec
    (AppManifestAppResourceServingEndpointSpec)
    SqlWarehouseSpec GetAppsSettingsCustomTemplateManifestResourceSpecSqlWarehouseSpec
    (AppManifestAppResourceSqlWarehouseSpec)
    UcSecurableSpec GetAppsSettingsCustomTemplateManifestResourceSpecUcSecurableSpec
    (AppManifestAppResourceUcSecurableSpec)
    name String
    The name of the template. It must contain only alphanumeric characters, hyphens, underscores, and whitespaces. It must be unique within the workspace
    description String
    (string) - Description of the App Resource
    jobSpec GetAppsSettingsCustomTemplateManifestResourceSpecJobSpec
    (AppManifestAppResourceJobSpec)
    secretSpec GetAppsSettingsCustomTemplateManifestResourceSpecSecretSpec
    (AppManifestAppResourceSecretSpec)
    servingEndpointSpec GetAppsSettingsCustomTemplateManifestResourceSpecServingEndpointSpec
    (AppManifestAppResourceServingEndpointSpec)
    sqlWarehouseSpec GetAppsSettingsCustomTemplateManifestResourceSpecSqlWarehouseSpec
    (AppManifestAppResourceSqlWarehouseSpec)
    ucSecurableSpec GetAppsSettingsCustomTemplateManifestResourceSpecUcSecurableSpec
    (AppManifestAppResourceUcSecurableSpec)
    name string
    The name of the template. It must contain only alphanumeric characters, hyphens, underscores, and whitespaces. It must be unique within the workspace
    description string
    (string) - Description of the App Resource
    jobSpec GetAppsSettingsCustomTemplateManifestResourceSpecJobSpec
    (AppManifestAppResourceJobSpec)
    secretSpec GetAppsSettingsCustomTemplateManifestResourceSpecSecretSpec
    (AppManifestAppResourceSecretSpec)
    servingEndpointSpec GetAppsSettingsCustomTemplateManifestResourceSpecServingEndpointSpec
    (AppManifestAppResourceServingEndpointSpec)
    sqlWarehouseSpec GetAppsSettingsCustomTemplateManifestResourceSpecSqlWarehouseSpec
    (AppManifestAppResourceSqlWarehouseSpec)
    ucSecurableSpec GetAppsSettingsCustomTemplateManifestResourceSpecUcSecurableSpec
    (AppManifestAppResourceUcSecurableSpec)
    name str
    The name of the template. It must contain only alphanumeric characters, hyphens, underscores, and whitespaces. It must be unique within the workspace
    description str
    (string) - Description of the App Resource
    job_spec GetAppsSettingsCustomTemplateManifestResourceSpecJobSpec
    (AppManifestAppResourceJobSpec)
    secret_spec GetAppsSettingsCustomTemplateManifestResourceSpecSecretSpec
    (AppManifestAppResourceSecretSpec)
    serving_endpoint_spec GetAppsSettingsCustomTemplateManifestResourceSpecServingEndpointSpec
    (AppManifestAppResourceServingEndpointSpec)
    sql_warehouse_spec GetAppsSettingsCustomTemplateManifestResourceSpecSqlWarehouseSpec
    (AppManifestAppResourceSqlWarehouseSpec)
    uc_securable_spec GetAppsSettingsCustomTemplateManifestResourceSpecUcSecurableSpec
    (AppManifestAppResourceUcSecurableSpec)
    name String
    The name of the template. It must contain only alphanumeric characters, hyphens, underscores, and whitespaces. It must be unique within the workspace
    description String
    (string) - Description of the App Resource
    jobSpec Property Map
    (AppManifestAppResourceJobSpec)
    secretSpec Property Map
    (AppManifestAppResourceSecretSpec)
    servingEndpointSpec Property Map
    (AppManifestAppResourceServingEndpointSpec)
    sqlWarehouseSpec Property Map
    (AppManifestAppResourceSqlWarehouseSpec)
    ucSecurableSpec Property Map
    (AppManifestAppResourceUcSecurableSpec)

    GetAppsSettingsCustomTemplateManifestResourceSpecJobSpec

    Permission string
    (string) - . Possible values are: MANAGE, READ_VOLUME, WRITE_VOLUME
    Permission string
    (string) - . Possible values are: MANAGE, READ_VOLUME, WRITE_VOLUME
    permission String
    (string) - . Possible values are: MANAGE, READ_VOLUME, WRITE_VOLUME
    permission string
    (string) - . Possible values are: MANAGE, READ_VOLUME, WRITE_VOLUME
    permission str
    (string) - . Possible values are: MANAGE, READ_VOLUME, WRITE_VOLUME
    permission String
    (string) - . Possible values are: MANAGE, READ_VOLUME, WRITE_VOLUME

    GetAppsSettingsCustomTemplateManifestResourceSpecSecretSpec

    Permission string
    (string) - . Possible values are: MANAGE, READ_VOLUME, WRITE_VOLUME
    Permission string
    (string) - . Possible values are: MANAGE, READ_VOLUME, WRITE_VOLUME
    permission String
    (string) - . Possible values are: MANAGE, READ_VOLUME, WRITE_VOLUME
    permission string
    (string) - . Possible values are: MANAGE, READ_VOLUME, WRITE_VOLUME
    permission str
    (string) - . Possible values are: MANAGE, READ_VOLUME, WRITE_VOLUME
    permission String
    (string) - . Possible values are: MANAGE, READ_VOLUME, WRITE_VOLUME

    GetAppsSettingsCustomTemplateManifestResourceSpecServingEndpointSpec

    Permission string
    (string) - . Possible values are: MANAGE, READ_VOLUME, WRITE_VOLUME
    Permission string
    (string) - . Possible values are: MANAGE, READ_VOLUME, WRITE_VOLUME
    permission String
    (string) - . Possible values are: MANAGE, READ_VOLUME, WRITE_VOLUME
    permission string
    (string) - . Possible values are: MANAGE, READ_VOLUME, WRITE_VOLUME
    permission str
    (string) - . Possible values are: MANAGE, READ_VOLUME, WRITE_VOLUME
    permission String
    (string) - . Possible values are: MANAGE, READ_VOLUME, WRITE_VOLUME

    GetAppsSettingsCustomTemplateManifestResourceSpecSqlWarehouseSpec

    Permission string
    (string) - . Possible values are: MANAGE, READ_VOLUME, WRITE_VOLUME
    Permission string
    (string) - . Possible values are: MANAGE, READ_VOLUME, WRITE_VOLUME
    permission String
    (string) - . Possible values are: MANAGE, READ_VOLUME, WRITE_VOLUME
    permission string
    (string) - . Possible values are: MANAGE, READ_VOLUME, WRITE_VOLUME
    permission str
    (string) - . Possible values are: MANAGE, READ_VOLUME, WRITE_VOLUME
    permission String
    (string) - . Possible values are: MANAGE, READ_VOLUME, WRITE_VOLUME

    GetAppsSettingsCustomTemplateManifestResourceSpecUcSecurableSpec

    Permission string
    (string) - . Possible values are: MANAGE, READ_VOLUME, WRITE_VOLUME
    SecurableType string
    (string) - . Possible values are: VOLUME
    Permission string
    (string) - . Possible values are: MANAGE, READ_VOLUME, WRITE_VOLUME
    SecurableType string
    (string) - . Possible values are: VOLUME
    permission String
    (string) - . Possible values are: MANAGE, READ_VOLUME, WRITE_VOLUME
    securableType String
    (string) - . Possible values are: VOLUME
    permission string
    (string) - . Possible values are: MANAGE, READ_VOLUME, WRITE_VOLUME
    securableType string
    (string) - . Possible values are: VOLUME
    permission str
    (string) - . Possible values are: MANAGE, READ_VOLUME, WRITE_VOLUME
    securable_type str
    (string) - . Possible values are: VOLUME
    permission String
    (string) - . Possible values are: MANAGE, READ_VOLUME, WRITE_VOLUME
    securableType String
    (string) - . Possible values are: VOLUME

    Package Details

    Repository
    databricks pulumi/pulumi-databricks
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the databricks Terraform Provider.
    databricks logo
    Databricks v1.75.0 published on Thursday, Sep 11, 2025 by Pulumi