Grafana

v0.0.3 published on Sunday, Sep 18, 2022 by lbrlabs

getDashboards

Datasource for retrieving all dashboards. Specify list of folder IDs to search in for dashboards.

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(folder_ids: Optional[Sequence[int]] = None,
                   limit: Optional[int] = None,
                   tags: Optional[Sequence[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> GetDashboardsResult
def get_dashboards_output(folder_ids: Optional[pulumi.Input[Sequence[pulumi.Input[int]]]] = None,
                   limit: Optional[pulumi.Input[int]] = None,
                   tags: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetDashboardsResult]
func GetDashboards(ctx *Context, args *GetDashboardsArgs, opts ...InvokeOption) (*GetDashboardsResult, error)
func GetDashboardsOutput(ctx *Context, args *GetDashboardsOutputArgs, opts ...InvokeOption) GetDashboardsResultOutput

> Note: This function is named GetDashboards 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)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: grafana:index/getDashboards:getDashboards
  Arguments:
    # Arguments dictionary

The following arguments are supported:

FolderIds List<int>

Numerical IDs of Grafana folders containing dashboards. Specify to filter for dashboards by folder (eg. [0] for General folder), or leave blank to get all dashboards in all folders.

Limit int

Maximum number of dashboard search results to return. Defaults to 5000.

Tags List<string>

List of string Grafana dashboard tags to search for, eg. ["prod"]. Used only as search input, i.e., attribute value will remain unchanged.

FolderIds []int

Numerical IDs of Grafana folders containing dashboards. Specify to filter for dashboards by folder (eg. [0] for General folder), or leave blank to get all dashboards in all folders.

Limit int

Maximum number of dashboard search results to return. Defaults to 5000.

Tags []string

List of string Grafana dashboard tags to search for, eg. ["prod"]. Used only as search input, i.e., attribute value will remain unchanged.

folderIds List<Integer>

Numerical IDs of Grafana folders containing dashboards. Specify to filter for dashboards by folder (eg. [0] for General folder), or leave blank to get all dashboards in all folders.

limit Integer

Maximum number of dashboard search results to return. Defaults to 5000.

tags List<String>

List of string Grafana dashboard tags to search for, eg. ["prod"]. Used only as search input, i.e., attribute value will remain unchanged.

folderIds number[]

Numerical IDs of Grafana folders containing dashboards. Specify to filter for dashboards by folder (eg. [0] for General folder), or leave blank to get all dashboards in all folders.

limit number

Maximum number of dashboard search results to return. Defaults to 5000.

tags string[]

List of string Grafana dashboard tags to search for, eg. ["prod"]. Used only as search input, i.e., attribute value will remain unchanged.

folder_ids Sequence[int]

Numerical IDs of Grafana folders containing dashboards. Specify to filter for dashboards by folder (eg. [0] for General folder), or leave blank to get all dashboards in all folders.

limit int

Maximum number of dashboard search results to return. Defaults to 5000.

tags Sequence[str]

List of string Grafana dashboard tags to search for, eg. ["prod"]. Used only as search input, i.e., attribute value will remain unchanged.

folderIds List<Number>

Numerical IDs of Grafana folders containing dashboards. Specify to filter for dashboards by folder (eg. [0] for General folder), or leave blank to get all dashboards in all folders.

limit Number

Maximum number of dashboard search results to return. Defaults to 5000.

tags List<String>

List of string Grafana dashboard tags to search for, eg. ["prod"]. Used only as search input, i.e., attribute value will remain unchanged.

getDashboards Result

The following output properties are available:

Dashboards List<Lbrlabs.PulumiPackage.Grafana.Outputs.GetDashboardsDashboard>
Id string

The provider-assigned unique ID for this managed resource.

FolderIds List<int>

Numerical IDs of Grafana folders containing dashboards. Specify to filter for dashboards by folder (eg. [0] for General folder), or leave blank to get all dashboards in all folders.

Limit int

Maximum number of dashboard search results to return. Defaults to 5000.

Tags List<string>

List of string Grafana dashboard tags to search for, eg. ["prod"]. Used only as search input, i.e., attribute value will remain unchanged.

Dashboards []GetDashboardsDashboard
Id string

The provider-assigned unique ID for this managed resource.

FolderIds []int

Numerical IDs of Grafana folders containing dashboards. Specify to filter for dashboards by folder (eg. [0] for General folder), or leave blank to get all dashboards in all folders.

Limit int

Maximum number of dashboard search results to return. Defaults to 5000.

Tags []string

List of string Grafana dashboard tags to search for, eg. ["prod"]. Used only as search input, i.e., attribute value will remain unchanged.

dashboards List<GetDashboardsDashboard>
id String

The provider-assigned unique ID for this managed resource.

folderIds List<Integer>

Numerical IDs of Grafana folders containing dashboards. Specify to filter for dashboards by folder (eg. [0] for General folder), or leave blank to get all dashboards in all folders.

limit Integer

Maximum number of dashboard search results to return. Defaults to 5000.

tags List<String>

List of string Grafana dashboard tags to search for, eg. ["prod"]. Used only as search input, i.e., attribute value will remain unchanged.

dashboards GetDashboardsDashboard[]
id string

The provider-assigned unique ID for this managed resource.

folderIds number[]

Numerical IDs of Grafana folders containing dashboards. Specify to filter for dashboards by folder (eg. [0] for General folder), or leave blank to get all dashboards in all folders.

limit number

Maximum number of dashboard search results to return. Defaults to 5000.

tags string[]

List of string Grafana dashboard tags to search for, eg. ["prod"]. Used only as search input, i.e., attribute value will remain unchanged.

dashboards Sequence[GetDashboardsDashboard]
id str

The provider-assigned unique ID for this managed resource.

folder_ids Sequence[int]

Numerical IDs of Grafana folders containing dashboards. Specify to filter for dashboards by folder (eg. [0] for General folder), or leave blank to get all dashboards in all folders.

limit int

Maximum number of dashboard search results to return. Defaults to 5000.

tags Sequence[str]

List of string Grafana dashboard tags to search for, eg. ["prod"]. Used only as search input, i.e., attribute value will remain unchanged.

dashboards List<Property Map>
id String

The provider-assigned unique ID for this managed resource.

folderIds List<Number>

Numerical IDs of Grafana folders containing dashboards. Specify to filter for dashboards by folder (eg. [0] for General folder), or leave blank to get all dashboards in all folders.

limit Number

Maximum number of dashboard search results to return. Defaults to 5000.

tags List<String>

List of string Grafana dashboard tags to search for, eg. ["prod"]. Used only as search input, i.e., attribute value will remain unchanged.

Supporting Types

GetDashboardsDashboard

FolderTitle string
Title string
Uid string
FolderTitle string
Title string
Uid string
folderTitle String
title String
uid String
folderTitle string
title string
uid string
folderTitle String
title String
uid String

Package Details

Repository
https://github.com/lbrlabs/pulumi-grafana
License
Apache-2.0
Notes

This Pulumi package is based on the grafana Terraform Provider.