1. Packages
  2. Signalfx Provider
  3. API Docs
  4. getDimensionValues
SignalFx v7.20.0 published on Saturday, Dec 20, 2025 by Pulumi
Schema (JSON)
pulumi/pulumi-signalfx

signalfx.getDimensionValues

signalfx logo
SignalFx v7.20.0 published on Saturday, Dec 20, 2025 by Pulumi
Schema (JSON)
pulumi/pulumi-signalfx

    This data sources allows for obtaining a list of dimension values by on query provided.

    import * as pulumi from "@pulumi/pulumi";
import * as signalfx from "@pulumi/signalfx";
import * as std from "@pulumi/std";

const mydashboardgroup0 = new signalfx.DashboardGroup("mydashboardgroup0", {
    name: "My team dashboard group",
    description: "Cool dashboard group",
});
const hosts = signalfx.getDimensionValues({
    query: "key:host",
});
const hostCharts: signalfx.TimeChart[] = [];
for (const range = {value: 0}; range.value < std.index.toset({
    input: hosts.values,
}).result; range.value++) {
    hostCharts.push(new signalfx.TimeChart(`host_charts-${range.value}`, {
        name: `CPU Total Idle ${range.value}`,
        plotType: "ColumnChart",
        axesIncludeZero: true,
        colorBy: "Metric",
        programText: `A = data(\"cpu.idle\", filter('host', '${range.key}').publish(label=\"CPU\")
`,
    }));
}
const mydashboard1 = new signalfx.Dashboard("mydashboard1", {
    name: "My Dashboard",
    dashboardGroup: mydashboardgroup0.id,
    timeRange: "-30m",
    grids: [{
        chartIds: std.index.toset({
            input: hostCharts.map(v => (v.id)),
        }).result,
        width: 3,
        height: 1,
    }],
});

    import pulumi
import pulumi_signalfx as signalfx
import pulumi_std as std

mydashboardgroup0 = signalfx.DashboardGroup("mydashboardgroup0",
    name="My team dashboard group",
    description="Cool dashboard group")
hosts = signalfx.get_dimension_values(query="key:host")
host_charts = []
for range in [{"value": i} for i in range(0, std.index.toset(input=hosts.values).result)]:
    host_charts.append(signalfx.TimeChart(f"host_charts-{range['value']}",
        name=f"CPU Total Idle {range['value']}",
        plot_type="ColumnChart",
        axes_include_zero=True,
        color_by="Metric",
        program_text=f"A = data(\\\"cpu.idle\\\", filter('host', '{range['key']}').publish(label=\\\"CPU\\\")\n"))
mydashboard1 = signalfx.Dashboard("mydashboard1",
    name="My Dashboard",
    dashboard_group=mydashboardgroup0.id,
    time_range="-30m",
    grids=[{
        "chart_ids": std.index.toset(input=[v.id for v in host_charts])["result"],
        "width": 3,
        "height": 1,
    }])

    Example coming soon!

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using SignalFx = Pulumi.SignalFx;
using Std = Pulumi.Std;

return await Deployment.RunAsync(() => 
{
    var mydashboardgroup0 = new SignalFx.DashboardGroup("mydashboardgroup0", new()
    {
        Name = "My team dashboard group",
        Description = "Cool dashboard group",
    });

    var hosts = SignalFx.GetDimensionValues.Invoke(new()
    {
        Query = "key:host",
    });

    var hostCharts = new List<SignalFx.TimeChart>();
    for (var rangeIndex = 0; rangeIndex < Std.Index.Toset.Invoke(new()
    {
        Input = hosts.Apply(getDimensionValuesResult => getDimensionValuesResult.Values),
    }).Result; rangeIndex++)
    {
        var range = new { Value = rangeIndex };
        hostCharts.Add(new SignalFx.TimeChart($"host_charts-{range.Value}", new()
        {
            Name = $"CPU Total Idle {range.Value}",
            PlotType = "ColumnChart",
            AxesIncludeZero = true,
            ColorBy = "Metric",
            ProgramText = @$"A = data(\""cpu.idle\"", filter('host', '{range.Key}').publish(label=\""CPU\"")
",
        }));
    }
    var mydashboard1 = new SignalFx.Dashboard("mydashboard1", new()
    {
        Name = "My Dashboard",
        DashboardGroup = mydashboardgroup0.Id,
        TimeRange = "-30m",
        Grids = new[]
        {
            new SignalFx.Inputs.DashboardGridArgs
            {
                ChartIds = Std.Index.Toset.Invoke(new()
                {
                    Input = hostCharts.Select(v => 
                    {
                        return v.Id;
                    }).ToList(),
                }).Result,
                Width = 3,
                Height = 1,
            },
        },
    });

});

    Example coming soon!

    Example coming soon!

    Using getDimensionValues

    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 getDimensionValues(args: GetDimensionValuesArgs, opts?: InvokeOptions): Promise<GetDimensionValuesResult>
function getDimensionValuesOutput(args: GetDimensionValuesOutputArgs, opts?: InvokeOptions): Output<GetDimensionValuesResult>
    def get_dimension_values(limit: Optional[int] = None,
                         order_by: Optional[str] = None,
                         query: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetDimensionValuesResult
def get_dimension_values_output(limit: Optional[pulumi.Input[int]] = None,
                         order_by: Optional[pulumi.Input[str]] = None,
                         query: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetDimensionValuesResult]
    func GetDimensionValues(ctx *Context, args *GetDimensionValuesArgs, opts ...InvokeOption) (*GetDimensionValuesResult, error)
func GetDimensionValuesOutput(ctx *Context, args *GetDimensionValuesOutputArgs, opts ...InvokeOption) GetDimensionValuesResultOutput

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

    public static class GetDimensionValues 
{
    public static Task<GetDimensionValuesResult> InvokeAsync(GetDimensionValuesArgs args, InvokeOptions? opts = null)
    public static Output<GetDimensionValuesResult> Invoke(GetDimensionValuesInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetDimensionValuesResult> getDimensionValues(GetDimensionValuesArgs args, InvokeOptions options)
public static Output<GetDimensionValuesResult> getDimensionValues(GetDimensionValuesArgs args, InvokeOptions options)

    fn::invoke:
  function: signalfx:index/getDimensionValues:getDimensionValues
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Query string
    Acepts a query string that allows for defining a key value deintion, wild card matching on values, or where the dimension value exists. Refer to https://dev.splunk.com/observability/reference/api/metrics_metadata/latest#endpoint-retrieve-dimensions-query for more details
    Limit int
    This allows you to define how many dimensions are returned as the values output.
    OrderBy string
    Query string
    Acepts a query string that allows for defining a key value deintion, wild card matching on values, or where the dimension value exists. Refer to https://dev.splunk.com/observability/reference/api/metrics_metadata/latest#endpoint-retrieve-dimensions-query for more details
    Limit int
    This allows you to define how many dimensions are returned as the values output.
    OrderBy string
    query String
    Acepts a query string that allows for defining a key value deintion, wild card matching on values, or where the dimension value exists. Refer to https://dev.splunk.com/observability/reference/api/metrics_metadata/latest#endpoint-retrieve-dimensions-query for more details
    limit Integer
    This allows you to define how many dimensions are returned as the values output.
    orderBy String
    query string
    Acepts a query string that allows for defining a key value deintion, wild card matching on values, or where the dimension value exists. Refer to https://dev.splunk.com/observability/reference/api/metrics_metadata/latest#endpoint-retrieve-dimensions-query for more details
    limit number
    This allows you to define how many dimensions are returned as the values output.
    orderBy string
    query str
    Acepts a query string that allows for defining a key value deintion, wild card matching on values, or where the dimension value exists. Refer to https://dev.splunk.com/observability/reference/api/metrics_metadata/latest#endpoint-retrieve-dimensions-query for more details
    limit int
    This allows you to define how many dimensions are returned as the values output.
    order_by str
    query String
    Acepts a query string that allows for defining a key value deintion, wild card matching on values, or where the dimension value exists. Refer to https://dev.splunk.com/observability/reference/api/metrics_metadata/latest#endpoint-retrieve-dimensions-query for more details
    limit Number
    This allows you to define how many dimensions are returned as the values output.
    orderBy String

    getDimensionValues Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Query string
    Acepts a query string that allows for defining a key value deintion, wild card matching on values, or where the dimension value exists. Refer to https://dev.splunk.com/observability/reference/api/metrics_metadata/latest#endpoint-retrieve-dimensions-query for more details
    Values List<string>
    List of all the match dimension values that the provided query, ordered by order_by field
    Limit int
    This allows you to define how many dimensions are returned as the values output.
    OrderBy string
    Id string
    The provider-assigned unique ID for this managed resource.
    Query string
    Acepts a query string that allows for defining a key value deintion, wild card matching on values, or where the dimension value exists. Refer to https://dev.splunk.com/observability/reference/api/metrics_metadata/latest#endpoint-retrieve-dimensions-query for more details
    Values []string
    List of all the match dimension values that the provided query, ordered by order_by field
    Limit int
    This allows you to define how many dimensions are returned as the values output.
    OrderBy string
    id String
    The provider-assigned unique ID for this managed resource.
    query String
    Acepts a query string that allows for defining a key value deintion, wild card matching on values, or where the dimension value exists. Refer to https://dev.splunk.com/observability/reference/api/metrics_metadata/latest#endpoint-retrieve-dimensions-query for more details
    values List<String>
    List of all the match dimension values that the provided query, ordered by order_by field
    limit Integer
    This allows you to define how many dimensions are returned as the values output.
    orderBy String
    id string
    The provider-assigned unique ID for this managed resource.
    query string
    Acepts a query string that allows for defining a key value deintion, wild card matching on values, or where the dimension value exists. Refer to https://dev.splunk.com/observability/reference/api/metrics_metadata/latest#endpoint-retrieve-dimensions-query for more details
    values string[]
    List of all the match dimension values that the provided query, ordered by order_by field
    limit number
    This allows you to define how many dimensions are returned as the values output.
    orderBy string
    id str
    The provider-assigned unique ID for this managed resource.
    query str
    Acepts a query string that allows for defining a key value deintion, wild card matching on values, or where the dimension value exists. Refer to https://dev.splunk.com/observability/reference/api/metrics_metadata/latest#endpoint-retrieve-dimensions-query for more details
    values Sequence[str]
    List of all the match dimension values that the provided query, ordered by order_by field
    limit int
    This allows you to define how many dimensions are returned as the values output.
    order_by str
    id String
    The provider-assigned unique ID for this managed resource.
    query String
    Acepts a query string that allows for defining a key value deintion, wild card matching on values, or where the dimension value exists. Refer to https://dev.splunk.com/observability/reference/api/metrics_metadata/latest#endpoint-retrieve-dimensions-query for more details
    values List<String>
    List of all the match dimension values that the provided query, ordered by order_by field
    limit Number
    This allows you to define how many dimensions are returned as the values output.
    orderBy String

    Package Details

    Repository
    SignalFx pulumi/pulumi-signalfx
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the signalfx Terraform Provider.
    signalfx logo
    SignalFx v7.20.0 published on Saturday, Dec 20, 2025 by Pulumi
    Schema (JSON)
    pulumi/pulumi-signalfx
      Meet Neo: Your AI Platform Teammate