Docs Packages
  1. Packages
  2. Grafana Cloud
  3. API Docs
  4. getDashboards
Grafana v0.5.0 published on Thursday, May 30, 2024 by pulumiverse
pulumiverse/pulumi-grafana

grafana.getDashboards

Explore with Pulumi AI

grafana logo
Grafana v0.5.0 published on Thursday, May 30, 2024 by pulumiverse
pulumiverse/pulumi-grafana

    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,
                   folder_uids: Optional[Sequence[str]] = None,
                   limit: Optional[int] = None,
                   org_id: Optional[str] = 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,
                   folder_uids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                   limit: Optional[pulumi.Input[int]] = None,
                   org_id: Optional[pulumi.Input[str]] = 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>

    Deprecated: Use folder_uids instead.

    FolderUids List<string>
    Limit int
    OrgId string
    Tags List<string>
    FolderIds []int

    Deprecated: Use folder_uids instead.

    FolderUids []string
    Limit int
    OrgId string
    Tags []string
    folderIds List<Integer>

    Deprecated: Use folder_uids instead.

    folderUids List<String>
    limit Integer
    orgId String
    tags List<String>
    folderIds number[]

    Deprecated: Use folder_uids instead.

    folderUids string[]
    limit number
    orgId string
    tags string[]
    folder_ids Sequence[int]

    Deprecated: Use folder_uids instead.

    folder_uids Sequence[str]
    limit int
    org_id str
    tags Sequence[str]
    folderIds List<Number>

    Deprecated: Use folder_uids instead.

    folderUids List<String>
    limit Number
    orgId String
    tags List<String>

    getDashboards Result

    The following output properties are available:

    Dashboards List<Pulumiverse.Grafana.Outputs.GetDashboardsDashboard>
    Id string
    The provider-assigned unique ID for this managed resource.
    FolderIds List<int>

    Deprecated: Use folder_uids instead.

    FolderUids List<string>
    Limit int
    OrgId string
    Tags List<string>
    Dashboards []GetDashboardsDashboard
    Id string
    The provider-assigned unique ID for this managed resource.
    FolderIds []int

    Deprecated: Use folder_uids instead.

    FolderUids []string
    Limit int
    OrgId string
    Tags []string
    dashboards List<GetDashboardsDashboard>
    id String
    The provider-assigned unique ID for this managed resource.
    folderIds List<Integer>

    Deprecated: Use folder_uids instead.

    folderUids List<String>
    limit Integer
    orgId String
    tags List<String>
    dashboards GetDashboardsDashboard[]
    id string
    The provider-assigned unique ID for this managed resource.
    folderIds number[]

    Deprecated: Use folder_uids instead.

    folderUids string[]
    limit number
    orgId string
    tags string[]
    dashboards Sequence[GetDashboardsDashboard]
    id str
    The provider-assigned unique ID for this managed resource.
    folder_ids Sequence[int]

    Deprecated: Use folder_uids instead.

    folder_uids Sequence[str]
    limit int
    org_id str
    tags Sequence[str]
    dashboards List<Property Map>
    id String
    The provider-assigned unique ID for this managed resource.
    folderIds List<Number>

    Deprecated: Use folder_uids instead.

    folderUids List<String>
    limit Number
    orgId String
    tags List<String>

    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
    grafana pulumiverse/pulumi-grafana
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the grafana Terraform Provider.
    grafana logo
    Grafana v0.5.0 published on Thursday, May 30, 2024 by pulumiverse
    pulumiverse/pulumi-grafana