honeycombio.getEnvironments

Start a Neo task

Explain and create a honeycombio.getEnvironments resource

Honeycomb 0.42.0 published on Friday, Oct 10, 2025 by honeycombio

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";

const all = honeycombio.getEnvironments({});
const foo = honeycombio.getEnvironments({
    detailFilters: [{
        name: "name",
        valueRegex: "foo_*",
    }],
});

import pulumi
import pulumi_honeycombio as honeycombio

all = honeycombio.get_environments()
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 {
		_, err := honeycombio.GetEnvironments(ctx, &honeycombio.GetEnvironmentsArgs{}, nil)
		if err != nil {
			return err
		}
		_, 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(() => 
{
    var all = Honeycombio.GetEnvironments.Invoke();

    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) {
        final var all = HoneycombioFunctions.getEnvironments();

        final var foo = HoneycombioFunctions.getEnvironments(GetEnvironmentsArgs.builder()
            .detailFilters(GetEnvironmentsDetailFilterArgs.builder()
                .name("name")
                .valueRegex("foo_*")
                .build())
            .build());

    }
}

variables:
  all:
    fn::invoke:
      function: honeycombio:getEnvironments
      arguments: {}
  foo:
    fn::invoke:
      function: honeycombio:getEnvironments
      arguments:
        detailFilters:
          - name: name
            valueRegex: foo_*

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: Optional[pulumi.Input[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

The following arguments are supported:

DetailFilters List<GetEnvironmentsDetailFilter>: a block to further filter results as described below. Multiple detail_filter blocks can be provided to filter by multiple fields. Multiple filters are combined with a logical AND operation, meaning all conditions must be satisfied for an environment to be included in the results.

DetailFilters []GetEnvironmentsDetailFilter: a block to further filter results as described below. Multiple detail_filter blocks can be provided to filter by multiple fields. Multiple filters are combined with a logical AND operation, meaning all conditions must be satisfied for an environment to be included in the results.

detailFilters List<GetEnvironmentsDetailFilter>: a block to further filter results as described below. Multiple detail_filter blocks can be provided to filter by multiple fields. Multiple filters are combined with a logical AND operation, meaning all conditions must be satisfied for an environment to be included in the results.

detailFilters GetEnvironmentsDetailFilter[]: a block to further filter results as described below. Multiple detail_filter blocks can be provided to filter by multiple fields. Multiple filters are combined with a logical AND operation, meaning all conditions must be satisfied for an environment to be included in the results.

detail_filters Sequence[GetEnvironmentsDetailFilter]: a block to further filter results as described below. Multiple detail_filter blocks can be provided to filter by multiple fields. Multiple filters are combined with a logical AND operation, meaning all conditions must be satisfied for an environment to be included in the results.

detailFilters List<Property Map>: a block to further filter results as described below. Multiple detail_filter blocks can be provided to filter by multiple fields. Multiple filters are combined with a logical AND operation, meaning all conditions must be satisfied for an environment to be included in the results.

getEnvironments Result

The following output properties are available:

Id string
Ids List<string>: a list of all the Environment IDs found in the Team.
DetailFilters List<GetEnvironmentsDetailFilter>

Id string
Ids []string: a list of all the Environment IDs found in the Team.
DetailFilters []GetEnvironmentsDetailFilter

id String
ids List<String>: a list of all the Environment IDs found in the Team.
detailFilters List<GetEnvironmentsDetailFilter>

id string
ids string[]: a list of all the Environment IDs found in the Team.
detailFilters GetEnvironmentsDetailFilter[]

id str
ids Sequence[str]: a list of all the Environment IDs found in the Team.
detail_filters Sequence[GetEnvironmentsDetailFilter]

id String
ids List<String>: a list of all the Environment IDs found in the Team.
detailFilters List<Property Map>

Supporting Types

GetEnvironmentsDetailFilter

Name string: The name of the detail field to filter by. This field must match a schema attribute of the honeycombio.Environment resource (e.g., name, color, description).
Operator string: The comparison operator to use for filtering. Defaults to equals. Valid operators include:
Value string: The value of the detail field to match on.
ValueRegex string: A regular expression string to apply to the value of the detail field to match on.
Note one of value or value_regex is required.

Name string: The name of the detail field to filter by. This field must match a schema attribute of the honeycombio.Environment resource (e.g., name, color, description).
Operator string: The comparison operator to use for filtering. Defaults to equals. Valid operators include:
Value string: The value of the detail field to match on.
ValueRegex string: A regular expression string to apply to the value of the detail field to match on.
Note one of value or value_regex is required.

name String: The name of the detail field to filter by. This field must match a schema attribute of the honeycombio.Environment resource (e.g., name, color, description).
operator String: The comparison operator to use for filtering. Defaults to equals. Valid operators include:
value String: The value of the detail field to match on.
valueRegex String: A regular expression string to apply to the value of the detail field to match on.
Note one of value or value_regex is required.

name string: The name of the detail field to filter by. This field must match a schema attribute of the honeycombio.Environment resource (e.g., name, color, description).
operator string: The comparison operator to use for filtering. Defaults to equals. Valid operators include:
value string: The value of the detail field to match on.
valueRegex string: A regular expression string to apply to the value of the detail field to match on.
Note one of value or value_regex is required.

name str: The name of the detail field to filter by. This field must match a schema attribute of the honeycombio.Environment resource (e.g., name, color, description).
operator str: The comparison operator to use for filtering. Defaults to equals. Valid operators include:
value str: The value of the detail field to match on.
value_regex str: A regular expression string to apply to the value of the detail field to match on.
Note one of value or value_regex is required.

name String: The name of the detail field to filter by. This field must match a schema attribute of the honeycombio.Environment resource (e.g., name, color, description).
operator String: The comparison operator to use for filtering. Defaults to equals. Valid operators include:
value String: The value of the detail field to match on.
valueRegex String: A regular expression string to apply to the value of the detail field to match on.
Note one of value or value_regex is required.