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

databricks.getAppsSettingsCustomTemplates

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 fetch the list of Custom Templates within the workspace. The list can then be accessed via the data object’s templates field.

    Example Usage

    Getting a list of all Custom Templates:

    import * as pulumi from "@pulumi/pulumi";
    import * as databricks from "@pulumi/databricks";
    
    const all = databricks.getAppsSettingsCustomTemplates({});
    export const allCustomTemplates = all.then(all => all.templates);
    
    import pulumi
    import pulumi_databricks as databricks
    
    all = databricks.get_apps_settings_custom_templates()
    pulumi.export("allCustomTemplates", all.templates)
    
    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 {
    		all, err := databricks.GetAppsSettingsCustomTemplates(ctx, &databricks.GetAppsSettingsCustomTemplatesArgs{}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("allCustomTemplates", all.Templates)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Databricks = Pulumi.Databricks;
    
    return await Deployment.RunAsync(() => 
    {
        var all = Databricks.GetAppsSettingsCustomTemplates.Invoke();
    
        return new Dictionary<string, object?>
        {
            ["allCustomTemplates"] = all.Apply(getAppsSettingsCustomTemplatesResult => getAppsSettingsCustomTemplatesResult.Templates),
        };
    });
    
    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.GetAppsSettingsCustomTemplatesArgs;
    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 all = DatabricksFunctions.getAppsSettingsCustomTemplates(GetAppsSettingsCustomTemplatesArgs.builder()
                .build());
    
            ctx.export("allCustomTemplates", all.templates());
        }
    }
    
    variables:
      all:
        fn::invoke:
          function: databricks:getAppsSettingsCustomTemplates
          arguments: {}
    outputs:
      allCustomTemplates: ${all.templates}
    

    Using getAppsSettingsCustomTemplates

    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 getAppsSettingsCustomTemplates(args: GetAppsSettingsCustomTemplatesArgs, opts?: InvokeOptions): Promise<GetAppsSettingsCustomTemplatesResult>
    function getAppsSettingsCustomTemplatesOutput(args: GetAppsSettingsCustomTemplatesOutputArgs, opts?: InvokeOptions): Output<GetAppsSettingsCustomTemplatesResult>
    def get_apps_settings_custom_templates(workspace_id: Optional[str] = None,
                                           opts: Optional[InvokeOptions] = None) -> GetAppsSettingsCustomTemplatesResult
    def get_apps_settings_custom_templates_output(workspace_id: Optional[pulumi.Input[str]] = None,
                                           opts: Optional[InvokeOptions] = None) -> Output[GetAppsSettingsCustomTemplatesResult]
    func GetAppsSettingsCustomTemplates(ctx *Context, args *GetAppsSettingsCustomTemplatesArgs, opts ...InvokeOption) (*GetAppsSettingsCustomTemplatesResult, error)
    func GetAppsSettingsCustomTemplatesOutput(ctx *Context, args *GetAppsSettingsCustomTemplatesOutputArgs, opts ...InvokeOption) GetAppsSettingsCustomTemplatesResultOutput

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

    public static class GetAppsSettingsCustomTemplates 
    {
        public static Task<GetAppsSettingsCustomTemplatesResult> InvokeAsync(GetAppsSettingsCustomTemplatesArgs args, InvokeOptions? opts = null)
        public static Output<GetAppsSettingsCustomTemplatesResult> Invoke(GetAppsSettingsCustomTemplatesInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetAppsSettingsCustomTemplatesResult> getAppsSettingsCustomTemplates(GetAppsSettingsCustomTemplatesArgs args, InvokeOptions options)
    public static Output<GetAppsSettingsCustomTemplatesResult> getAppsSettingsCustomTemplates(GetAppsSettingsCustomTemplatesArgs args, InvokeOptions options)
    
    fn::invoke:
      function: databricks:index/getAppsSettingsCustomTemplates:getAppsSettingsCustomTemplates
      arguments:
        # arguments dictionary

    The following arguments are supported:

    WorkspaceId string
    Workspace ID of the resource
    WorkspaceId string
    Workspace ID of the resource
    workspaceId String
    Workspace ID of the resource
    workspaceId string
    Workspace ID of the resource
    workspace_id str
    Workspace ID of the resource
    workspaceId String
    Workspace ID of the resource

    getAppsSettingsCustomTemplates Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Templates List<GetAppsSettingsCustomTemplatesTemplate>
    WorkspaceId string
    Id string
    The provider-assigned unique ID for this managed resource.
    Templates []GetAppsSettingsCustomTemplatesTemplate
    WorkspaceId string
    id String
    The provider-assigned unique ID for this managed resource.
    templates List<GetAppsSettingsCustomTemplatesTemplate>
    workspaceId String
    id string
    The provider-assigned unique ID for this managed resource.
    templates GetAppsSettingsCustomTemplatesTemplate[]
    workspaceId string
    id str
    The provider-assigned unique ID for this managed resource.
    templates Sequence[GetAppsSettingsCustomTemplatesTemplate]
    workspace_id str
    id String
    The provider-assigned unique ID for this managed resource.
    templates List<Property Map>
    workspaceId String

    Supporting Types

    GetAppsSettingsCustomTemplatesTemplate

    Creator string
    (string)
    GitProvider string
    (string) - The Git provider of the template
    GitRepo string
    (string) - The Git repository URL that the template resides in
    Manifest GetAppsSettingsCustomTemplatesTemplateManifest
    (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
    Creator string
    (string)
    GitProvider string
    (string) - The Git provider of the template
    GitRepo string
    (string) - The Git repository URL that the template resides in
    Manifest GetAppsSettingsCustomTemplatesTemplateManifest
    (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
    creator String
    (string)
    gitProvider String
    (string) - The Git provider of the template
    gitRepo String
    (string) - The Git repository URL that the template resides in
    manifest GetAppsSettingsCustomTemplatesTemplateManifest
    (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
    creator string
    (string)
    gitProvider string
    (string) - The Git provider of the template
    gitRepo string
    (string) - The Git repository URL that the template resides in
    manifest GetAppsSettingsCustomTemplatesTemplateManifest
    (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
    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
    manifest GetAppsSettingsCustomTemplatesTemplateManifest
    (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
    creator String
    (string)
    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
    (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

    GetAppsSettingsCustomTemplatesTemplateManifest

    Name string
    (string) - Name of the App Resource
    Version int
    (integer) - The manifest schema version, for now only 1 is allowed
    Description string
    (string) - Description of the App Resource
    ResourceSpecs List<GetAppsSettingsCustomTemplatesTemplateManifestResourceSpec>
    (list of AppManifestAppResourceSpec)
    Name string
    (string) - Name of the App Resource
    Version int
    (integer) - The manifest schema version, for now only 1 is allowed
    Description string
    (string) - Description of the App Resource
    ResourceSpecs []GetAppsSettingsCustomTemplatesTemplateManifestResourceSpec
    (list of AppManifestAppResourceSpec)
    name String
    (string) - Name of the App Resource
    version Integer
    (integer) - The manifest schema version, for now only 1 is allowed
    description String
    (string) - Description of the App Resource
    resourceSpecs List<GetAppsSettingsCustomTemplatesTemplateManifestResourceSpec>
    (list of AppManifestAppResourceSpec)
    name string
    (string) - Name of the App Resource
    version number
    (integer) - The manifest schema version, for now only 1 is allowed
    description string
    (string) - Description of the App Resource
    resourceSpecs GetAppsSettingsCustomTemplatesTemplateManifestResourceSpec[]
    (list of AppManifestAppResourceSpec)
    name str
    (string) - Name of the App Resource
    version int
    (integer) - The manifest schema version, for now only 1 is allowed
    description str
    (string) - Description of the App Resource
    resource_specs Sequence[GetAppsSettingsCustomTemplatesTemplateManifestResourceSpec]
    (list of AppManifestAppResourceSpec)
    name String
    (string) - Name of the App Resource
    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)

    GetAppsSettingsCustomTemplatesTemplateManifestResourceSpec

    name String
    (string) - Name of the App Resource
    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)

    GetAppsSettingsCustomTemplatesTemplateManifestResourceSpecJobSpec

    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

    GetAppsSettingsCustomTemplatesTemplateManifestResourceSpecSecretSpec

    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

    GetAppsSettingsCustomTemplatesTemplateManifestResourceSpecServingEndpointSpec

    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

    GetAppsSettingsCustomTemplatesTemplateManifestResourceSpecSqlWarehouseSpec

    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

    GetAppsSettingsCustomTemplatesTemplateManifestResourceSpecUcSecurableSpec

    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