1. Packages
  2. Harness Provider
  3. API Docs
  4. platform
  5. getDashboards
Harness v0.7.5 published on Thursday, Jun 19, 2025 by Pulumi

harness.platform.getDashboards

Explore with Pulumi AI

harness logo
Harness v0.7.5 published on Thursday, Jun 19, 2025 by Pulumi

    Data source for retrieving a Harness Dashboard.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as harness from "@pulumi/harness";
    
    const example = harness.platform.getDashboards({
        id: "48525",
    });
    
    import pulumi
    import pulumi_harness as harness
    
    example = harness.platform.get_dashboards(id="48525")
    
    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 {
    		_, err := platform.LookupDashboards(ctx, &platform.LookupDashboardsArgs{
    			Id: "48525",
    		}, 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(() => 
    {
        var example = Harness.Platform.GetDashboards.Invoke(new()
        {
            Id = "48525",
        });
    
    });
    
    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.GetDashboardsArgs;
    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 example = PlatformFunctions.getDashboards(GetDashboardsArgs.builder()
                .id("48525")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          function: harness:platform:getDashboards
          arguments:
            id: '48525'
    

    Using getDashboards

    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 getDashboards(args: GetDashboardsArgs, opts?: InvokeOptions): Promise<GetDashboardsResult>
    function getDashboardsOutput(args: GetDashboardsOutputArgs, opts?: InvokeOptions): Output<GetDashboardsResult>
    def get_dashboards(id: Optional[str] = None,
                       identifier: Optional[str] = None,
                       name: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetDashboardsResult
    def get_dashboards_output(id: Optional[pulumi.Input[str]] = None,
                       identifier: Optional[pulumi.Input[str]] = None,
                       name: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetDashboardsResult]
    func LookupDashboards(ctx *Context, args *LookupDashboardsArgs, opts ...InvokeOption) (*LookupDashboardsResult, error)
    func LookupDashboardsOutput(ctx *Context, args *LookupDashboardsOutputArgs, opts ...InvokeOption) LookupDashboardsResultOutput

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

    public static class GetDashboards 
    {
        public static Task<GetDashboardsResult> InvokeAsync(GetDashboardsArgs args, InvokeOptions? opts = null)
        public static Output<GetDashboardsResult> Invoke(GetDashboardsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetDashboardsResult> getDashboards(GetDashboardsArgs args, InvokeOptions options)
    public static Output<GetDashboardsResult> getDashboards(GetDashboardsArgs args, InvokeOptions options)
    
    fn::invoke:
      function: harness:platform/getDashboards:getDashboards
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    Identifier of the dashboard.
    Identifier string
    Name string
    Name of the Dashboard.
    Id string
    Identifier of the dashboard.
    Identifier string
    Name string
    Name of the Dashboard.
    id String
    Identifier of the dashboard.
    identifier String
    name String
    Name of the Dashboard.
    id string
    Identifier of the dashboard.
    identifier string
    name string
    Name of the Dashboard.
    id str
    Identifier of the dashboard.
    identifier str
    name str
    Name of the Dashboard.
    id String
    Identifier of the dashboard.
    identifier String
    name String
    Name of the Dashboard.

    getDashboards Result

    The following output properties are available:

    CreatedAt string
    Created at timestamp of the Dashboard.
    DashboardId string
    Unique identifier of the Dashboard.
    DataSources List<string>
    Data Sources within the Dashboard.
    Description string
    Description of the Dashboard.
    FolderId string
    Unique identifier of the Folder.
    Id string
    Identifier of the dashboard.
    Models List<string>
    Data Models within the Dashboard.
    ResourceIdentifier string
    Resource identifier of the dashboard.
    Tags List<string>
    Title string
    Title of the Dashboard.
    Type string
    Type of the dashboard.
    ViewCount int
    View count of the dashboard.
    Identifier string
    Name string
    Name of the Dashboard.
    CreatedAt string
    Created at timestamp of the Dashboard.
    DashboardId string
    Unique identifier of the Dashboard.
    DataSources []string
    Data Sources within the Dashboard.
    Description string
    Description of the Dashboard.
    FolderId string
    Unique identifier of the Folder.
    Id string
    Identifier of the dashboard.
    Models []string
    Data Models within the Dashboard.
    ResourceIdentifier string
    Resource identifier of the dashboard.
    Tags []string
    Title string
    Title of the Dashboard.
    Type string
    Type of the dashboard.
    ViewCount int
    View count of the dashboard.
    Identifier string
    Name string
    Name of the Dashboard.
    createdAt String
    Created at timestamp of the Dashboard.
    dashboardId String
    Unique identifier of the Dashboard.
    dataSources List<String>
    Data Sources within the Dashboard.
    description String
    Description of the Dashboard.
    folderId String
    Unique identifier of the Folder.
    id String
    Identifier of the dashboard.
    models List<String>
    Data Models within the Dashboard.
    resourceIdentifier String
    Resource identifier of the dashboard.
    tags List<String>
    title String
    Title of the Dashboard.
    type String
    Type of the dashboard.
    viewCount Integer
    View count of the dashboard.
    identifier String
    name String
    Name of the Dashboard.
    createdAt string
    Created at timestamp of the Dashboard.
    dashboardId string
    Unique identifier of the Dashboard.
    dataSources string[]
    Data Sources within the Dashboard.
    description string
    Description of the Dashboard.
    folderId string
    Unique identifier of the Folder.
    id string
    Identifier of the dashboard.
    models string[]
    Data Models within the Dashboard.
    resourceIdentifier string
    Resource identifier of the dashboard.
    tags string[]
    title string
    Title of the Dashboard.
    type string
    Type of the dashboard.
    viewCount number
    View count of the dashboard.
    identifier string
    name string
    Name of the Dashboard.
    created_at str
    Created at timestamp of the Dashboard.
    dashboard_id str
    Unique identifier of the Dashboard.
    data_sources Sequence[str]
    Data Sources within the Dashboard.
    description str
    Description of the Dashboard.
    folder_id str
    Unique identifier of the Folder.
    id str
    Identifier of the dashboard.
    models Sequence[str]
    Data Models within the Dashboard.
    resource_identifier str
    Resource identifier of the dashboard.
    tags Sequence[str]
    title str
    Title of the Dashboard.
    type str
    Type of the dashboard.
    view_count int
    View count of the dashboard.
    identifier str
    name str
    Name of the Dashboard.
    createdAt String
    Created at timestamp of the Dashboard.
    dashboardId String
    Unique identifier of the Dashboard.
    dataSources List<String>
    Data Sources within the Dashboard.
    description String
    Description of the Dashboard.
    folderId String
    Unique identifier of the Folder.
    id String
    Identifier of the dashboard.
    models List<String>
    Data Models within the Dashboard.
    resourceIdentifier String
    Resource identifier of the dashboard.
    tags List<String>
    title String
    Title of the Dashboard.
    type String
    Type of the dashboard.
    viewCount Number
    View count of the dashboard.
    identifier String
    name String
    Name of the Dashboard.

    Package Details

    Repository
    harness pulumi/pulumi-harness
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the harness Terraform Provider.
    harness logo
    Harness v0.7.5 published on Thursday, Jun 19, 2025 by Pulumi