1. Registry
  2. Packages
  3. Logzio Provider
  4. API Docs
  5. getUnifiedDashboard
Viewing docs for logzio 1.29.0
published on Friday, Sep 25, 2026 by logzio
Viewing docs for logzio 1.29.0
published on Friday, Sep 25, 2026 by logzio

    # Unified Dashboard Data Source

    Use this data source to read an existing Perses-based unified dashboard from a specific Logz.io unified project.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as logzio from "@pulumi/logzio";
    
    const cpuUsage = logzio.getUnifiedDashboard({
        folderId: "my-project-id",
        dashboardUid: "my-dashboard-uid",
    });
    export const dashboardDocument = cpuUsage.then(cpuUsage => cpuUsage.dashboardJson);
    
    import pulumi
    import pulumi_logzio as logzio
    
    cpu_usage = logzio.get_unified_dashboard(folder_id="my-project-id",
        dashboard_uid="my-dashboard-uid")
    pulumi.export("dashboardDocument", cpu_usage.dashboard_json)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/logzio/logzio"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		cpuUsage, err := logzio.LookupUnifiedDashboard(ctx, &logzio.LookupUnifiedDashboardArgs{
    			FolderId:     "my-project-id",
    			DashboardUid: "my-dashboard-uid",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("dashboardDocument", cpuUsage.DashboardJson)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Logzio = Pulumi.Logzio;
    
    return await Deployment.RunAsync(() => 
    {
        var cpuUsage = Logzio.GetUnifiedDashboard.Invoke(new()
        {
            FolderId = "my-project-id",
            DashboardUid = "my-dashboard-uid",
        });
    
        return new Dictionary<string, object?>
        {
            ["dashboardDocument"] = cpuUsage.Apply(getUnifiedDashboardResult => getUnifiedDashboardResult.DashboardJson),
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.logzio.LogzioFunctions;
    import com.pulumi.logzio.inputs.GetUnifiedDashboardArgs;
    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 cpuUsage = LogzioFunctions.getUnifiedDashboard(GetUnifiedDashboardArgs.builder()
                .folderId("my-project-id")
                .dashboardUid("my-dashboard-uid")
                .build());
    
            ctx.export("dashboardDocument", cpuUsage.dashboardJson());
        }
    }
    
    variables:
      cpuUsage:
        fn::invoke:
          function: logzio:getUnifiedDashboard
          arguments:
            folderId: my-project-id
            dashboardUid: my-dashboard-uid
    outputs:
      dashboardDocument: ${cpuUsage.dashboardJson}
    
    Example coming soon!
    

    Using getUnifiedDashboard

    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 getUnifiedDashboard(args: GetUnifiedDashboardArgs, opts?: InvokeOptions): Promise<GetUnifiedDashboardResult>
    function getUnifiedDashboardOutput(args: GetUnifiedDashboardOutputArgs, opts?: InvokeOutputOptions): Output<GetUnifiedDashboardResult>
    def get_unified_dashboard(dashboard_uid: Optional[str] = None,
                              folder_id: Optional[str] = None,
                              id: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetUnifiedDashboardResult
    def get_unified_dashboard_output(dashboard_uid: pulumi.Input[Optional[str]] = None,
                              folder_id: pulumi.Input[Optional[str]] = None,
                              id: pulumi.Input[Optional[str]] = None,
                              opts: Optional[InvokeOutputOptions] = None) -> Output[GetUnifiedDashboardResult]
    func LookupUnifiedDashboard(ctx *Context, args *LookupUnifiedDashboardArgs, opts ...InvokeOption) (*LookupUnifiedDashboardResult, error)
    func LookupUnifiedDashboardOutput(ctx *Context, args *LookupUnifiedDashboardOutputArgs, opts ...InvokeOption) LookupUnifiedDashboardResultOutput

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

    public static class GetUnifiedDashboard 
    {
        public static Task<GetUnifiedDashboardResult> InvokeAsync(GetUnifiedDashboardArgs args, InvokeOptions? opts = null)
        public static Output<GetUnifiedDashboardResult> Invoke(GetUnifiedDashboardInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetUnifiedDashboardResult> Invoke(GetUnifiedDashboardInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetUnifiedDashboardResult> getUnifiedDashboard(GetUnifiedDashboardArgs args, InvokeOptions options)
    public static Output<GetUnifiedDashboardResult> getUnifiedDashboard(GetUnifiedDashboardArgs args, InvokeOptions options)
    public static Output<GetUnifiedDashboardResult> getUnifiedDashboard(GetUnifiedDashboardArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: logzio:index/getUnifiedDashboard:getUnifiedDashboard
      arguments:
        # arguments dictionary
    data "logzio_get_unified_dashboard" "name" {
        # arguments
    }

    The following arguments are supported:

    DashboardUid string
    FolderId string
    The unique identifier of the unified project containing the dashboard.
    Id string
    DashboardUid string
    FolderId string
    The unique identifier of the unified project containing the dashboard.
    Id string
    dashboard_uid string
    folder_id string
    The unique identifier of the unified project containing the dashboard.
    id string
    dashboardUid String
    folderId String
    The unique identifier of the unified project containing the dashboard.
    id String
    dashboardUid string
    folderId string
    The unique identifier of the unified project containing the dashboard.
    id string
    dashboard_uid str
    folder_id str
    The unique identifier of the unified project containing the dashboard.
    id str
    dashboardUid String
    folderId String
    The unique identifier of the unified project containing the dashboard.
    id String

    getUnifiedDashboard Result

    The following output properties are available:

    DashboardJson string
    (String) The normalized Perses dashboard document. It uses the same normalization as the logzio.UnifiedDashboard resource: the document is preserved, but the server-owned metadata keys (project, version, createdAt, updatedAt) are removed. Every other metadata key, such as tags, is kept.
    DashboardUid string
    (String) The requested stable dashboard identifier.
    FolderId string
    (String) The requested unified project identifier.
    Id string
    Name string
    (String) The dashboard's Perses metadata.name.
    Version double
    (Int) The dashboard version.
    DashboardJson string
    (String) The normalized Perses dashboard document. It uses the same normalization as the logzio.UnifiedDashboard resource: the document is preserved, but the server-owned metadata keys (project, version, createdAt, updatedAt) are removed. Every other metadata key, such as tags, is kept.
    DashboardUid string
    (String) The requested stable dashboard identifier.
    FolderId string
    (String) The requested unified project identifier.
    Id string
    Name string
    (String) The dashboard's Perses metadata.name.
    Version float64
    (Int) The dashboard version.
    dashboard_json string
    (String) The normalized Perses dashboard document. It uses the same normalization as the logzio.UnifiedDashboard resource: the document is preserved, but the server-owned metadata keys (project, version, createdAt, updatedAt) are removed. Every other metadata key, such as tags, is kept.
    dashboard_uid string
    (String) The requested stable dashboard identifier.
    folder_id string
    (String) The requested unified project identifier.
    id string
    name string
    (String) The dashboard's Perses metadata.name.
    version number
    (Int) The dashboard version.
    dashboardJson String
    (String) The normalized Perses dashboard document. It uses the same normalization as the logzio.UnifiedDashboard resource: the document is preserved, but the server-owned metadata keys (project, version, createdAt, updatedAt) are removed. Every other metadata key, such as tags, is kept.
    dashboardUid String
    (String) The requested stable dashboard identifier.
    folderId String
    (String) The requested unified project identifier.
    id String
    name String
    (String) The dashboard's Perses metadata.name.
    version Double
    (Int) The dashboard version.
    dashboardJson string
    (String) The normalized Perses dashboard document. It uses the same normalization as the logzio.UnifiedDashboard resource: the document is preserved, but the server-owned metadata keys (project, version, createdAt, updatedAt) are removed. Every other metadata key, such as tags, is kept.
    dashboardUid string
    (String) The requested stable dashboard identifier.
    folderId string
    (String) The requested unified project identifier.
    id string
    name string
    (String) The dashboard's Perses metadata.name.
    version number
    (Int) The dashboard version.
    dashboard_json str
    (String) The normalized Perses dashboard document. It uses the same normalization as the logzio.UnifiedDashboard resource: the document is preserved, but the server-owned metadata keys (project, version, createdAt, updatedAt) are removed. Every other metadata key, such as tags, is kept.
    dashboard_uid str
    (String) The requested stable dashboard identifier.
    folder_id str
    (String) The requested unified project identifier.
    id str
    name str
    (String) The dashboard's Perses metadata.name.
    version float
    (Int) The dashboard version.
    dashboardJson String
    (String) The normalized Perses dashboard document. It uses the same normalization as the logzio.UnifiedDashboard resource: the document is preserved, but the server-owned metadata keys (project, version, createdAt, updatedAt) are removed. Every other metadata key, such as tags, is kept.
    dashboardUid String
    (String) The requested stable dashboard identifier.
    folderId String
    (String) The requested unified project identifier.
    id String
    name String
    (String) The dashboard's Perses metadata.name.
    version Number
    (Int) The dashboard version.

    Package Details

    Repository
    logzio logzio/terraform-provider-logzio
    License
    Notes
    This Pulumi package is based on the logzio Terraform Provider.
    Viewing docs for logzio 1.29.0
    published on Friday, Sep 25, 2026 by logzio

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial