1. Packages
  2. Signalfx Provider
  3. API Docs
  4. getDimensionValues
SignalFx v7.13.0 published on Friday, Jun 13, 2025 by Pulumi

signalfx.getDimensionValues

Explore with Pulumi AI

signalfx logo
SignalFx v7.13.0 published on Friday, Jun 13, 2025 by Pulumi

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

    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.13.0 published on Friday, Jun 13, 2025 by Pulumi