1. Packages
  2. Packages
  3. Honeycombio Provider
  4. API Docs
  5. getEnvironments
Viewing docs for Honeycomb 0.49.0
published on Friday, May 1, 2026 by honeycombio
Schema (JSON)
honeycombio/terraform-provider-honeycombio

honeycombio.getEnvironments

Viewing docs for Honeycomb 0.49.0
published on Friday, May 1, 2026 by honeycombio
Schema (JSON)
honeycombio/terraform-provider-honeycombio

    # Data Source: honeycombio.getEnvironments

    The Environments data source retrieves the Team’s environments.

    This data source requires the provider be configured with a Management Key with environments:read in the configured scopes.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as honeycombio from "@pulumi/honeycombio";

// returns all Environments
const all = honeycombio.getEnvironments({});
// only returns the Environments starting with 'foo_'
const foo = honeycombio.getEnvironments({
    detailFilters: [{
        name: "name",
        valueRegex: "foo_*",
    }],
});

    import pulumi
import pulumi_honeycombio as honeycombio

# returns all Environments
all = honeycombio.get_environments()
# only returns the Environments starting with 'foo_'
foo = honeycombio.get_environments(detail_filters=[{
    "name": "name",
    "value_regex": "foo_*",
}])

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/honeycombio/honeycombio"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// returns all Environments
		_, err := honeycombio.GetEnvironments(ctx, &honeycombio.GetEnvironmentsArgs{}, nil)
		if err != nil {
			return err
		}
		// only returns the Environments starting with 'foo_'
		_, err = honeycombio.GetEnvironments(ctx, &honeycombio.GetEnvironmentsArgs{
			DetailFilters: []honeycombio.GetEnvironmentsDetailFilter{
				{
					Name:       "name",
					ValueRegex: pulumi.StringRef("foo_*"),
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Honeycombio = Pulumi.Honeycombio;

return await Deployment.RunAsync(() => 
{
    // returns all Environments
    var all = Honeycombio.GetEnvironments.Invoke();

    // only returns the Environments starting with 'foo_'
    var foo = Honeycombio.GetEnvironments.Invoke(new()
    {
        DetailFilters = new[]
        {
            new Honeycombio.Inputs.GetEnvironmentsDetailFilterInputArgs
            {
                Name = "name",
                ValueRegex = "foo_*",
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.honeycombio.HoneycombioFunctions;
import com.pulumi.honeycombio.inputs.GetEnvironmentsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        // returns all Environments
        final var all = HoneycombioFunctions.getEnvironments(GetEnvironmentsArgs.builder()
            .build());

        // only returns the Environments starting with 'foo_'
        final var foo = HoneycombioFunctions.getEnvironments(GetEnvironmentsArgs.builder()
            .detailFilters(GetEnvironmentsDetailFilterArgs.builder()
                .name("name")
                .valueRegex("foo_*")
                .build())
            .build());

    }
}

    variables:
  # returns all Environments
  all:
    fn::invoke:
      function: honeycombio:getEnvironments
      arguments: {}
  # only returns the Environments starting with 'foo_'
  foo:
    fn::invoke:
      function: honeycombio:getEnvironments
      arguments:
        detailFilters:
          - name: name
            valueRegex: foo_*

    Example coming soon!

    Using getEnvironments

    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 getEnvironments(args: GetEnvironmentsArgs, opts?: InvokeOptions): Promise<GetEnvironmentsResult>
function getEnvironmentsOutput(args: GetEnvironmentsOutputArgs, opts?: InvokeOptions): Output<GetEnvironmentsResult>
    def get_environments(detail_filters: Optional[Sequence[GetEnvironmentsDetailFilter]] = None,
                     opts: Optional[InvokeOptions] = None) -> GetEnvironmentsResult
def get_environments_output(detail_filters: pulumi.Input[Optional[Sequence[pulumi.Input[GetEnvironmentsDetailFilterArgs]]]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetEnvironmentsResult]
    func GetEnvironments(ctx *Context, args *GetEnvironmentsArgs, opts ...InvokeOption) (*GetEnvironmentsResult, error)
func GetEnvironmentsOutput(ctx *Context, args *GetEnvironmentsOutputArgs, opts ...InvokeOption) GetEnvironmentsResultOutput

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

    public static class GetEnvironments 
{
    public static Task<GetEnvironmentsResult> InvokeAsync(GetEnvironmentsArgs args, InvokeOptions? opts = null)
    public static Output<GetEnvironmentsResult> Invoke(GetEnvironmentsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetEnvironmentsResult> getEnvironments(GetEnvironmentsArgs args, InvokeOptions options)
public static Output<GetEnvironmentsResult> getEnvironments(GetEnvironmentsArgs args, InvokeOptions options)

    fn::invoke:
  function: honeycombio:index/getEnvironments:getEnvironments
  arguments:
    # arguments dictionary
    data "honeycombio_getenvironments" "name" {
    # arguments
}

    The following arguments are supported:

    getEnvironments Result

    The following output properties are available:

    id string
    ids list(string)
    detail_filters list(object)

    Supporting Types

    GetEnvironmentsDetailFilter

    Name string
    The name of the detail field to filter by. This must match a schema attribute of the resource (e.g., name, description, id).
    Operator string
    The comparison operator to use for filtering. Defaults to equals. Valid operators include:

    • equals, =, eq - Exact match comparison
    • not-equals, !=, ne - Inverse exact match comparison
    • contains, in - Substring inclusion check
    • does-not-contain, not-in - Inverse substring inclusion check
    • starts-with - Prefix matching
    • does-not-start-with - Inverse prefix matching
    • ends-with - Suffix matching
    • does-not-end-with - Inverse suffix matching
    • >, gt - Numeric greater than comparison
    • >=, ge - Numeric greater than or equal comparison
    • <, lt - Numeric less than comparison
    • <=, le - Numeric less than or equal comparison
    • does-not-exist - Field absence check
    Value string
    The value of the detail field to match on. Required unless value_regex is set or operator is does-not-exist.
    ValueRegex string
    A regular expression string to apply to the value of the detail field to match on. Required unless value is set or operator is does-not-exist.
    Name string
    The name of the detail field to filter by. This must match a schema attribute of the resource (e.g., name, description, id).
    Operator string
    The comparison operator to use for filtering. Defaults to equals. Valid operators include:

    • equals, =, eq - Exact match comparison
    • not-equals, !=, ne - Inverse exact match comparison
    • contains, in - Substring inclusion check
    • does-not-contain, not-in - Inverse substring inclusion check
    • starts-with - Prefix matching
    • does-not-start-with - Inverse prefix matching
    • ends-with - Suffix matching
    • does-not-end-with - Inverse suffix matching
    • >, gt - Numeric greater than comparison
    • >=, ge - Numeric greater than or equal comparison
    • <, lt - Numeric less than comparison
    • <=, le - Numeric less than or equal comparison
    • does-not-exist - Field absence check
    Value string
    The value of the detail field to match on. Required unless value_regex is set or operator is does-not-exist.
    ValueRegex string
    A regular expression string to apply to the value of the detail field to match on. Required unless value is set or operator is does-not-exist.
    name string
    The name of the detail field to filter by. This must match a schema attribute of the resource (e.g., name, description, id).
    operator string
    The comparison operator to use for filtering. Defaults to equals. Valid operators include:

    • equals, =, eq - Exact match comparison
    • not-equals, !=, ne - Inverse exact match comparison
    • contains, in - Substring inclusion check
    • does-not-contain, not-in - Inverse substring inclusion check
    • starts-with - Prefix matching
    • does-not-start-with - Inverse prefix matching
    • ends-with - Suffix matching
    • does-not-end-with - Inverse suffix matching
    • >, gt - Numeric greater than comparison
    • >=, ge - Numeric greater than or equal comparison
    • <, lt - Numeric less than comparison
    • <=, le - Numeric less than or equal comparison
    • does-not-exist - Field absence check
    value string
    The value of the detail field to match on. Required unless value_regex is set or operator is does-not-exist.
    value_regex string
    A regular expression string to apply to the value of the detail field to match on. Required unless value is set or operator is does-not-exist.
    name String
    The name of the detail field to filter by. This must match a schema attribute of the resource (e.g., name, description, id).
    operator String
    The comparison operator to use for filtering. Defaults to equals. Valid operators include:

    • equals, =, eq - Exact match comparison
    • not-equals, !=, ne - Inverse exact match comparison
    • contains, in - Substring inclusion check
    • does-not-contain, not-in - Inverse substring inclusion check
    • starts-with - Prefix matching
    • does-not-start-with - Inverse prefix matching
    • ends-with - Suffix matching
    • does-not-end-with - Inverse suffix matching
    • >, gt - Numeric greater than comparison
    • >=, ge - Numeric greater than or equal comparison
    • <, lt - Numeric less than comparison
    • <=, le - Numeric less than or equal comparison
    • does-not-exist - Field absence check
    value String
    The value of the detail field to match on. Required unless value_regex is set or operator is does-not-exist.
    valueRegex String
    A regular expression string to apply to the value of the detail field to match on. Required unless value is set or operator is does-not-exist.
    name string
    The name of the detail field to filter by. This must match a schema attribute of the resource (e.g., name, description, id).
    operator string
    The comparison operator to use for filtering. Defaults to equals. Valid operators include:

    • equals, =, eq - Exact match comparison
    • not-equals, !=, ne - Inverse exact match comparison
    • contains, in - Substring inclusion check
    • does-not-contain, not-in - Inverse substring inclusion check
    • starts-with - Prefix matching
    • does-not-start-with - Inverse prefix matching
    • ends-with - Suffix matching
    • does-not-end-with - Inverse suffix matching
    • >, gt - Numeric greater than comparison
    • >=, ge - Numeric greater than or equal comparison
    • <, lt - Numeric less than comparison
    • <=, le - Numeric less than or equal comparison
    • does-not-exist - Field absence check
    value string
    The value of the detail field to match on. Required unless value_regex is set or operator is does-not-exist.
    valueRegex string
    A regular expression string to apply to the value of the detail field to match on. Required unless value is set or operator is does-not-exist.
    name str
    The name of the detail field to filter by. This must match a schema attribute of the resource (e.g., name, description, id).
    operator str
    The comparison operator to use for filtering. Defaults to equals. Valid operators include:

    • equals, =, eq - Exact match comparison
    • not-equals, !=, ne - Inverse exact match comparison
    • contains, in - Substring inclusion check
    • does-not-contain, not-in - Inverse substring inclusion check
    • starts-with - Prefix matching
    • does-not-start-with - Inverse prefix matching
    • ends-with - Suffix matching
    • does-not-end-with - Inverse suffix matching
    • >, gt - Numeric greater than comparison
    • >=, ge - Numeric greater than or equal comparison
    • <, lt - Numeric less than comparison
    • <=, le - Numeric less than or equal comparison
    • does-not-exist - Field absence check
    value str
    The value of the detail field to match on. Required unless value_regex is set or operator is does-not-exist.
    value_regex str
    A regular expression string to apply to the value of the detail field to match on. Required unless value is set or operator is does-not-exist.
    name String
    The name of the detail field to filter by. This must match a schema attribute of the resource (e.g., name, description, id).
    operator String
    The comparison operator to use for filtering. Defaults to equals. Valid operators include:

    • equals, =, eq - Exact match comparison
    • not-equals, !=, ne - Inverse exact match comparison
    • contains, in - Substring inclusion check
    • does-not-contain, not-in - Inverse substring inclusion check
    • starts-with - Prefix matching
    • does-not-start-with - Inverse prefix matching
    • ends-with - Suffix matching
    • does-not-end-with - Inverse suffix matching
    • >, gt - Numeric greater than comparison
    • >=, ge - Numeric greater than or equal comparison
    • <, lt - Numeric less than comparison
    • <=, le - Numeric less than or equal comparison
    • does-not-exist - Field absence check
    value String
    The value of the detail field to match on. Required unless value_regex is set or operator is does-not-exist.
    valueRegex String
    A regular expression string to apply to the value of the detail field to match on. Required unless value is set or operator is does-not-exist.

    Package Details

    Repository
    honeycombio honeycombio/terraform-provider-honeycombio
    License
    Notes
    This Pulumi package is based on the honeycombio Terraform Provider.
    Viewing docs for Honeycomb 0.49.0
    published on Friday, May 1, 2026 by honeycombio
    Schema (JSON)
    honeycombio/terraform-provider-honeycombio
      Try Pulumi Cloud free. Your team will thank you.