Grafana v0.5.1 published on Wednesday, Jun 12, 2024 by pulumiverse
grafana.getDashboards
Explore with Pulumi AI
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,
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:
- Folder
Ids List<int> - Deprecated, use
folder_uids
instead. - Folder
Uids List<string> - UIDs of Grafana folders containing dashboards. Specify to filter for dashboards by folder (eg.
["General"]
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
. - Org
Id string - The Organization ID. If not set, the Org ID defined in the provider block will be used.
- 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.
- Folder
Ids []int - Deprecated, use
folder_uids
instead. - Folder
Uids []string - UIDs of Grafana folders containing dashboards. Specify to filter for dashboards by folder (eg.
["General"]
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
. - Org
Id string - The Organization ID. If not set, the Org ID defined in the provider block will be used.
- []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 List<Integer> - Deprecated, use
folder_uids
instead. - folder
Uids List<String> - UIDs of Grafana folders containing dashboards. Specify to filter for dashboards by folder (eg.
["General"]
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
. - org
Id String - The Organization ID. If not set, the Org ID defined in the provider block will be used.
- 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.
- folder
Ids number[] - Deprecated, use
folder_uids
instead. - folder
Uids string[] - UIDs of Grafana folders containing dashboards. Specify to filter for dashboards by folder (eg.
["General"]
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
. - org
Id string - The Organization ID. If not set, the Org ID defined in the provider block will be used.
- 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] - Deprecated, use
folder_uids
instead. - folder_
uids Sequence[str] - UIDs of Grafana folders containing dashboards. Specify to filter for dashboards by folder (eg.
["General"]
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
. - org_
id str - The Organization ID. If not set, the Org ID defined in the provider block will be used.
- 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.
- folder
Ids List<Number> - Deprecated, use
folder_uids
instead. - folder
Uids List<String> - UIDs of Grafana folders containing dashboards. Specify to filter for dashboards by folder (eg.
["General"]
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
. - org
Id String - The Organization ID. If not set, the Org ID defined in the provider block will be used.
- 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<Pulumiverse.
Grafana. Outputs. Get Dashboards Dashboard> - Id string
- The provider-assigned unique ID for this managed resource.
- Folder
Ids List<int> - Deprecated, use
folder_uids
instead. - Folder
Uids List<string> - UIDs of Grafana folders containing dashboards. Specify to filter for dashboards by folder (eg.
["General"]
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
. - Org
Id string - The Organization ID. If not set, the Org ID defined in the provider block will be used.
- 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
[]Get
Dashboards Dashboard - Id string
- The provider-assigned unique ID for this managed resource.
- Folder
Ids []int - Deprecated, use
folder_uids
instead. - Folder
Uids []string - UIDs of Grafana folders containing dashboards. Specify to filter for dashboards by folder (eg.
["General"]
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
. - Org
Id string - The Organization ID. If not set, the Org ID defined in the provider block will be used.
- []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<Get
Dashboards Dashboard> - id String
- The provider-assigned unique ID for this managed resource.
- folder
Ids List<Integer> - Deprecated, use
folder_uids
instead. - folder
Uids List<String> - UIDs of Grafana folders containing dashboards. Specify to filter for dashboards by folder (eg.
["General"]
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
. - org
Id String - The Organization ID. If not set, the Org ID defined in the provider block will be used.
- 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
Get
Dashboards Dashboard[] - id string
- The provider-assigned unique ID for this managed resource.
- folder
Ids number[] - Deprecated, use
folder_uids
instead. - folder
Uids string[] - UIDs of Grafana folders containing dashboards. Specify to filter for dashboards by folder (eg.
["General"]
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
. - org
Id string - The Organization ID. If not set, the Org ID defined in the provider block will be used.
- 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[Get
Dashboards Dashboard] - id str
- The provider-assigned unique ID for this managed resource.
- folder_
ids Sequence[int] - Deprecated, use
folder_uids
instead. - folder_
uids Sequence[str] - UIDs of Grafana folders containing dashboards. Specify to filter for dashboards by folder (eg.
["General"]
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
. - org_
id str - The Organization ID. If not set, the Org ID defined in the provider block will be used.
- 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.
- folder
Ids List<Number> - Deprecated, use
folder_uids
instead. - folder
Uids List<String> - UIDs of Grafana folders containing dashboards. Specify to filter for dashboards by folder (eg.
["General"]
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
. - org
Id String - The Organization ID. If not set, the Org ID defined in the provider block will be used.
- 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
- Folder
Title string - Title string
- Uid string
- Folder
Title string - Title string
- Uid string
- folder
Title String - title String
- uid String
- folder
Title string - title string
- uid string
- folder_
title str - title str
- uid str
- folder
Title 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.