1. Registry
  2. Packages
  3. Harness Provider
  4. API Docs
  5. platform
  6. getDashboardFolder
Viewing docs for Harness v0.16.5
published on Saturday, Sep 12, 2026 by Pulumi
harness logo
Viewing docs for Harness v0.16.5
published on Saturday, Sep 12, 2026 by Pulumi

    Data source for retrieving a Harness Custom Dashboard Folder by id or name.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as harness from "@pulumi/harness";
    
    // By id
    const byId = harness.platform.getDashboardFolder({
        id: "1234",
    });
    // By name (will perform a list + match internally)
    const byName = harness.platform.getDashboardFolder({
        name: "my-folder",
    });
    
    import pulumi
    import pulumi_harness as harness
    
    # By id
    by_id = harness.platform.get_dashboard_folder(id="1234")
    # By name (will perform a list + match internally)
    by_name = harness.platform.get_dashboard_folder(name="my-folder")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-harness/sdk/go/harness/platform"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		// By id
    		_, err := platform.LookupDashboardFolder(ctx, &platform.LookupDashboardFolderArgs{
    			Id: pulumi.StringRef("1234"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		// By name (will perform a list + match internally)
    		_, err = platform.LookupDashboardFolder(ctx, &platform.LookupDashboardFolderArgs{
    			Name: pulumi.StringRef("my-folder"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Harness = Pulumi.Harness;
    
    return await Deployment.RunAsync(() => 
    {
        // By id
        var byId = Harness.Platform.GetDashboardFolder.Invoke(new()
        {
            Id = "1234",
        });
    
        // By name (will perform a list + match internally)
        var byName = Harness.Platform.GetDashboardFolder.Invoke(new()
        {
            Name = "my-folder",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.harness.platform.PlatformFunctions;
    import com.pulumi.harness.platform.inputs.GetDashboardFolderArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    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) {
            // By id
            final var byId = PlatformFunctions.getDashboardFolder(GetDashboardFolderArgs.builder()
                .id("1234")
                .build());
    
            // By name (will perform a list + match internally)
            final var byName = PlatformFunctions.getDashboardFolder(GetDashboardFolderArgs.builder()
                .name("my-folder")
                .build());
    
        }
    }
    
    variables:
      # By id
      byId:
        fn::invoke:
          function: harness:platform:getDashboardFolder
          arguments:
            id: '1234'
      # By name (will perform a list + match internally)
      byName:
        fn::invoke:
          function: harness:platform:getDashboardFolder
          arguments:
            name: my-folder
    
    pulumi {
      required_providers {
        harness = {
          source = "pulumi/harness"
        }
      }
    }
    
    data "harness_platform_getdashboardfolder" "byId" {
      id = "1234"
    }
    data "harness_platform_getdashboardfolder" "byName" {
      name = "my-folder"
    }
    
    # By id
    # By name (will perform a list + match internally)
    

    Using getDashboardFolder

    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 getDashboardFolder(args: GetDashboardFolderArgs, opts?: InvokeOptions): Promise<GetDashboardFolderResult>
    function getDashboardFolderOutput(args: GetDashboardFolderOutputArgs, opts?: InvokeOutputOptions): Output<GetDashboardFolderResult>
    def get_dashboard_folder(id: Optional[str] = None,
                             identifier: Optional[str] = None,
                             name: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetDashboardFolderResult
    def get_dashboard_folder_output(id: pulumi.Input[Optional[str]] = None,
                             identifier: pulumi.Input[Optional[str]] = None,
                             name: pulumi.Input[Optional[str]] = None,
                             opts: Optional[InvokeOutputOptions] = None) -> Output[GetDashboardFolderResult]
    func LookupDashboardFolder(ctx *Context, args *LookupDashboardFolderArgs, opts ...InvokeOption) (*LookupDashboardFolderResult, error)
    func LookupDashboardFolderOutput(ctx *Context, args *LookupDashboardFolderOutputArgs, opts ...InvokeOption) LookupDashboardFolderResultOutput

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

    public static class GetDashboardFolder 
    {
        public static Task<GetDashboardFolderResult> InvokeAsync(GetDashboardFolderArgs args, InvokeOptions? opts = null)
        public static Output<GetDashboardFolderResult> Invoke(GetDashboardFolderInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetDashboardFolderResult> Invoke(GetDashboardFolderInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetDashboardFolderResult> getDashboardFolder(GetDashboardFolderArgs args, InvokeOptions options)
    public static Output<GetDashboardFolderResult> getDashboardFolder(GetDashboardFolderArgs args, InvokeOptions options)
    public static Output<GetDashboardFolderResult> getDashboardFolder(GetDashboardFolderArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: harness:platform/getDashboardFolder:getDashboardFolder
      arguments:
        # arguments dictionary
    data "harness_platform_get_dashboard_folder" "name" {
        # arguments
    }

    The following arguments are supported:

    Id string
    Identifier of the folder. Required if name is not provided.
    Identifier string
    Unique identifier of the resource.
    Name string
    Name of the resource.
    Id string
    Identifier of the folder. Required if name is not provided.
    Identifier string
    Unique identifier of the resource.
    Name string
    Name of the resource.
    id string
    Identifier of the folder. Required if name is not provided.
    identifier string
    Unique identifier of the resource.
    name string
    Name of the resource.
    id String
    Identifier of the folder. Required if name is not provided.
    identifier String
    Unique identifier of the resource.
    name String
    Name of the resource.
    id string
    Identifier of the folder. Required if name is not provided.
    identifier string
    Unique identifier of the resource.
    name string
    Name of the resource.
    id str
    Identifier of the folder. Required if name is not provided.
    identifier str
    Unique identifier of the resource.
    name str
    Name of the resource.
    id String
    Identifier of the folder. Required if name is not provided.
    identifier String
    Unique identifier of the resource.
    name String
    Name of the resource.

    getDashboardFolder Result

    The following output properties are available:

    CreatedAt string
    Created DateTime of the folder.
    Description string
    Description of the resource.
    Tags List<string>
    Tags to associate with the resource.
    Id string
    Identifier of the folder. Required if name is not provided.
    Identifier string
    Unique identifier of the resource.
    Name string
    Name of the resource.
    CreatedAt string
    Created DateTime of the folder.
    Description string
    Description of the resource.
    Tags []string
    Tags to associate with the resource.
    Id string
    Identifier of the folder. Required if name is not provided.
    Identifier string
    Unique identifier of the resource.
    Name string
    Name of the resource.
    created_at string
    Created DateTime of the folder.
    description string
    Description of the resource.
    tags list(string)
    Tags to associate with the resource.
    id string
    Identifier of the folder. Required if name is not provided.
    identifier string
    Unique identifier of the resource.
    name string
    Name of the resource.
    createdAt String
    Created DateTime of the folder.
    description String
    Description of the resource.
    tags List<String>
    Tags to associate with the resource.
    id String
    Identifier of the folder. Required if name is not provided.
    identifier String
    Unique identifier of the resource.
    name String
    Name of the resource.
    createdAt string
    Created DateTime of the folder.
    description string
    Description of the resource.
    tags string[]
    Tags to associate with the resource.
    id string
    Identifier of the folder. Required if name is not provided.
    identifier string
    Unique identifier of the resource.
    name string
    Name of the resource.
    created_at str
    Created DateTime of the folder.
    description str
    Description of the resource.
    tags Sequence[str]
    Tags to associate with the resource.
    id str
    Identifier of the folder. Required if name is not provided.
    identifier str
    Unique identifier of the resource.
    name str
    Name of the resource.
    createdAt String
    Created DateTime of the folder.
    description String
    Description of the resource.
    tags List<String>
    Tags to associate with the resource.
    id String
    Identifier of the folder. Required if name is not provided.
    identifier String
    Unique identifier of the resource.
    name String
    Name of the resource.

    Package Details

    Repository
    harness pulumi/pulumi-harness
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the harness Terraform Provider.
    harness logo
    Viewing docs for Harness v0.16.5
    published on Saturday, Sep 12, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial