Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Grafana Cloud
  4. API Docs
  5. agento11y
  6. Collection
Viewing docs for Grafana v2.38.0
published on Friday, Aug 7, 2026 by pulumiverse
Schema (JSON)
pulumiverse/pulumi-grafana

grafana.agento11y.Collection

grafana logo
Viewing docs for Grafana v2.38.0
published on Friday, Aug 7, 2026 by pulumiverse
Schema (JSON)
pulumiverse/pulumi-grafana

    Manages a Grafana Agent Observability collection: a named group of saved conversations. Rule actions add matching conversations to a collection, so use this resource to reference a collection from grafana.agento11y.RuleAction without hardcoding a server-generated ID.

    Terraform does not manage collection membership. Rule actions and the Agent Observability UI add and remove members.

    Requires a Grafana instance with the grafana-agento11y-app plugin installed. Writes require a user or service account with the grafana-agento11y-app.eval:write permission, which only the Admin basic role grants by default.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as grafana from "@pulumiverse/grafana";

const example = new grafana.agento11y.Collection("example", {
    name: "Failed evaluations",
    description: "Conversations where every evaluator failed.",
});

    import pulumi
import pulumiverse_grafana as grafana

example = grafana.agento11y.Collection("example",
    name="Failed evaluations",
    description="Conversations where every evaluator failed.")

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-grafana/sdk/v2/go/grafana/agento11y"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := agento11y.NewCollection(ctx, "example", &agento11y.CollectionArgs{
			Name:        pulumi.String("Failed evaluations"),
			Description: pulumi.String("Conversations where every evaluator failed."),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Grafana = Pulumiverse.Grafana;

return await Deployment.RunAsync(() => 
{
    var example = new Grafana.Agento11y.Collection("example", new()
    {
        Name = "Failed evaluations",
        Description = "Conversations where every evaluator failed.",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.grafana.agento11y.Collection;
import com.pulumi.grafana.agento11y.CollectionArgs;
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) {
        var example = new Collection("example", CollectionArgs.builder()
            .name("Failed evaluations")
            .description("Conversations where every evaluator failed.")
            .build());

    }
}

    resources:
  example:
    type: grafana:agento11y:Collection
    properties:
      name: Failed evaluations
      description: Conversations where every evaluator failed.

    Example coming soon!

    Create Collection Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Collection(name: string, args?: CollectionArgs, opts?: CustomResourceOptions);
    @overload
def Collection(resource_name: str,
               args: Optional[CollectionArgs] = None,
               opts: Optional[ResourceOptions] = None)

@overload
def Collection(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               description: Optional[str] = None,
               name: Optional[str] = None)
    func NewCollection(ctx *Context, name string, args *CollectionArgs, opts ...ResourceOption) (*Collection, error)
    public Collection(string name, CollectionArgs? args = null, CustomResourceOptions? opts = null)
    public Collection(String name, CollectionArgs args)
public Collection(String name, CollectionArgs args, CustomResourceOptions options)

    type: grafana:agento11y:Collection
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "grafana_agento11y_collection" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args CollectionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args CollectionArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args CollectionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CollectionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CollectionArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var collectionResource = new Grafana.Agento11y.Collection("collectionResource", new()
{
    Description = "string",
    Name = "string",
});

    example, err := agento11y.NewCollection(ctx, "collectionResource", &agento11y.CollectionArgs{
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
})

    resource "grafana_agento11y_collection" "collectionResource" {
  lifecycle {
    create_before_destroy = true
  }
  description = "string"
  name        = "string"
}

    var collectionResource = new Collection("collectionResource", CollectionArgs.builder()
    .description("string")
    .name("string")
    .build());

    collection_resource = grafana.agento11y.Collection("collectionResource",
    description="string",
    name="string")

    const collectionResource = new grafana.agento11y.Collection("collectionResource", {
    description: "string",
    name: "string",
});

    type: grafana:agento11y:Collection
properties:
    description: string
    name: string

    Collection Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Collection resource accepts the following input properties:

    Description string
    Description of the collection. Remove this attribute to clear the stored description; an empty string is not accepted.
    Name string
    Display name of the collection. Names are not unique.
    Description string
    Description of the collection. Remove this attribute to clear the stored description; an empty string is not accepted.
    Name string
    Display name of the collection. Names are not unique.
    description string
    Description of the collection. Remove this attribute to clear the stored description; an empty string is not accepted.
    name string
    Display name of the collection. Names are not unique.
    description String
    Description of the collection. Remove this attribute to clear the stored description; an empty string is not accepted.
    name String
    Display name of the collection. Names are not unique.
    description string
    Description of the collection. Remove this attribute to clear the stored description; an empty string is not accepted.
    name string
    Display name of the collection. Names are not unique.
    description str
    Description of the collection. Remove this attribute to clear the stored description; an empty string is not accepted.
    name str
    Display name of the collection. Names are not unique.
    description String
    Description of the collection. Remove this attribute to clear the stored description; an empty string is not accepted.
    name String
    Display name of the collection. Names are not unique.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Collection resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Collection Resource

    Get an existing Collection resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: CollectionState, opts?: CustomResourceOptions): Collection
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        name: Optional[str] = None) -> Collection
    func GetCollection(ctx *Context, name string, id IDInput, state *CollectionState, opts ...ResourceOption) (*Collection, error)
    public static Collection Get(string name, Input<string> id, CollectionState? state, CustomResourceOptions? opts = null)
    public static Collection get(String name, Output<String> id, CollectionState state, CustomResourceOptions options)
    resources:  _:    type: grafana:agento11y:Collection    get:      id: ${id}
    import {
  to = grafana_agento11y_collection.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Description string
    Description of the collection. Remove this attribute to clear the stored description; an empty string is not accepted.
    Name string
    Display name of the collection. Names are not unique.
    Description string
    Description of the collection. Remove this attribute to clear the stored description; an empty string is not accepted.
    Name string
    Display name of the collection. Names are not unique.
    description string
    Description of the collection. Remove this attribute to clear the stored description; an empty string is not accepted.
    name string
    Display name of the collection. Names are not unique.
    description String
    Description of the collection. Remove this attribute to clear the stored description; an empty string is not accepted.
    name String
    Display name of the collection. Names are not unique.
    description string
    Description of the collection. Remove this attribute to clear the stored description; an empty string is not accepted.
    name string
    Display name of the collection. Names are not unique.
    description str
    Description of the collection. Remove this attribute to clear the stored description; an empty string is not accepted.
    name str
    Display name of the collection. Names are not unique.
    description String
    Description of the collection. Remove this attribute to clear the stored description; an empty string is not accepted.
    name String
    Display name of the collection. Names are not unique.

    Import

    terraform import grafana_agento11y_collection.name "{{ collection_id }}"

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    grafana pulumiverse/pulumi-grafana
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the grafana Terraform Provider.
    grafana logo
    Viewing docs for Grafana v2.38.0
    published on Friday, Aug 7, 2026 by pulumiverse
    Schema (JSON)
    pulumiverse/pulumi-grafana

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial