1. Packages
  2. Octopusdeploy Provider
  3. API Docs
  4. TagSet
octopusdeploy 0.43.0 published on Thursday, Apr 17, 2025 by octopusdeploylabs

octopusdeploy.TagSet

Explore with Pulumi AI

This resource manages tag sets in Octopus Deploy.

Example Usage

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

const example = new octopusdeploy.TagSet("example", {description: "Provides tenants with access to certain early access programs."});
// tags are distinct resources and associated with tag sets through tag_set_id
const alpha = new octopusdeploy.Tag("alpha", {
    color: "#00FF00",
    tagSetId: example.id,
});
const beta = new octopusdeploy.Tag("beta", {
    color: "#FF0000",
    tagSetId: example.id,
});
Copy
import pulumi
import pulumi_octopusdeploy as octopusdeploy

example = octopusdeploy.TagSet("example", description="Provides tenants with access to certain early access programs.")
# tags are distinct resources and associated with tag sets through tag_set_id
alpha = octopusdeploy.Tag("alpha",
    color="#00FF00",
    tag_set_id=example.id)
beta = octopusdeploy.Tag("beta",
    color="#FF0000",
    tag_set_id=example.id)
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := octopusdeploy.NewTagSet(ctx, "example", &octopusdeploy.TagSetArgs{
			Description: pulumi.String("Provides tenants with access to certain early access programs."),
		})
		if err != nil {
			return err
		}
		_, err = octopusdeploy.NewTag(ctx, "alpha", &octopusdeploy.TagArgs{
			Color:    pulumi.String("#00FF00"),
			TagSetId: example.ID(),
		})
		if err != nil {
			return err
		}
		_, err = octopusdeploy.NewTag(ctx, "beta", &octopusdeploy.TagArgs{
			Color:    pulumi.String("#FF0000"),
			TagSetId: example.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Octopusdeploy = Pulumi.Octopusdeploy;

return await Deployment.RunAsync(() => 
{
    var example = new Octopusdeploy.TagSet("example", new()
    {
        Description = "Provides tenants with access to certain early access programs.",
    });

    // tags are distinct resources and associated with tag sets through tag_set_id
    var alpha = new Octopusdeploy.Tag("alpha", new()
    {
        Color = "#00FF00",
        TagSetId = example.Id,
    });

    var beta = new Octopusdeploy.Tag("beta", new()
    {
        Color = "#FF0000",
        TagSetId = example.Id,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.octopusdeploy.TagSet;
import com.pulumi.octopusdeploy.TagSetArgs;
import com.pulumi.octopusdeploy.Tag;
import com.pulumi.octopusdeploy.TagArgs;
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 TagSet("example", TagSetArgs.builder()
            .description("Provides tenants with access to certain early access programs.")
            .build());

        // tags are distinct resources and associated with tag sets through tag_set_id
        var alpha = new Tag("alpha", TagArgs.builder()
            .color("#00FF00")
            .tagSetId(example.id())
            .build());

        var beta = new Tag("beta", TagArgs.builder()
            .color("#FF0000")
            .tagSetId(example.id())
            .build());

    }
}
Copy
resources:
  example: # tags are distinct resources and associated with tag sets through tag_set_id
    type: octopusdeploy:TagSet
    properties:
      description: Provides tenants with access to certain early access programs.
  alpha:
    type: octopusdeploy:Tag
    properties:
      color: '#00FF00'
      tagSetId: ${example.id}
  beta:
    type: octopusdeploy:Tag
    properties:
      color: '#FF0000'
      tagSetId: ${example.id}
Copy

Create TagSet Resource

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

Constructor syntax

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

@overload
def TagSet(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           description: Optional[str] = None,
           name: Optional[str] = None,
           sort_order: Optional[float] = None,
           space_id: Optional[str] = None)
func NewTagSet(ctx *Context, name string, args *TagSetArgs, opts ...ResourceOption) (*TagSet, error)
public TagSet(string name, TagSetArgs? args = null, CustomResourceOptions? opts = null)
public TagSet(String name, TagSetArgs args)
public TagSet(String name, TagSetArgs args, CustomResourceOptions options)
type: octopusdeploy:TagSet
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args TagSetArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args TagSetArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args TagSetArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args TagSetArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. TagSetArgs
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 tagSetResource = new Octopusdeploy.TagSet("tagSetResource", new()
{
    Description = "string",
    Name = "string",
    SortOrder = 0,
    SpaceId = "string",
});
Copy
example, err := octopusdeploy.NewTagSet(ctx, "tagSetResource", &octopusdeploy.TagSetArgs{
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
	SortOrder:   pulumi.Float64(0),
	SpaceId:     pulumi.String("string"),
})
Copy
var tagSetResource = new TagSet("tagSetResource", TagSetArgs.builder()
    .description("string")
    .name("string")
    .sortOrder(0)
    .spaceId("string")
    .build());
Copy
tag_set_resource = octopusdeploy.TagSet("tagSetResource",
    description="string",
    name="string",
    sort_order=0,
    space_id="string")
Copy
const tagSetResource = new octopusdeploy.TagSet("tagSetResource", {
    description: "string",
    name: "string",
    sortOrder: 0,
    spaceId: "string",
});
Copy
type: octopusdeploy:TagSet
properties:
    description: string
    name: string
    sortOrder: 0
    spaceId: string
Copy

TagSet 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 TagSet resource accepts the following input properties:

Description string
The description of this tag set.
Name string
The name of this resource.
SortOrder double
The sort order associated with this resource.
SpaceId string
The space ID associated with this resource.
Description string
The description of this tag set.
Name string
The name of this resource.
SortOrder float64
The sort order associated with this resource.
SpaceId string
The space ID associated with this resource.
description String
The description of this tag set.
name String
The name of this resource.
sortOrder Double
The sort order associated with this resource.
spaceId String
The space ID associated with this resource.
description string
The description of this tag set.
name string
The name of this resource.
sortOrder number
The sort order associated with this resource.
spaceId string
The space ID associated with this resource.
description str
The description of this tag set.
name str
The name of this resource.
sort_order float
The sort order associated with this resource.
space_id str
The space ID associated with this resource.
description String
The description of this tag set.
name String
The name of this resource.
sortOrder Number
The sort order associated with this resource.
spaceId String
The space ID associated with this resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the TagSet 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 str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing TagSet Resource

Get an existing TagSet 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?: TagSetState, opts?: CustomResourceOptions): TagSet
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        sort_order: Optional[float] = None,
        space_id: Optional[str] = None) -> TagSet
func GetTagSet(ctx *Context, name string, id IDInput, state *TagSetState, opts ...ResourceOption) (*TagSet, error)
public static TagSet Get(string name, Input<string> id, TagSetState? state, CustomResourceOptions? opts = null)
public static TagSet get(String name, Output<String> id, TagSetState state, CustomResourceOptions options)
resources:  _:    type: octopusdeploy:TagSet    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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
The description of this tag set.
Name string
The name of this resource.
SortOrder double
The sort order associated with this resource.
SpaceId string
The space ID associated with this resource.
Description string
The description of this tag set.
Name string
The name of this resource.
SortOrder float64
The sort order associated with this resource.
SpaceId string
The space ID associated with this resource.
description String
The description of this tag set.
name String
The name of this resource.
sortOrder Double
The sort order associated with this resource.
spaceId String
The space ID associated with this resource.
description string
The description of this tag set.
name string
The name of this resource.
sortOrder number
The sort order associated with this resource.
spaceId string
The space ID associated with this resource.
description str
The description of this tag set.
name str
The name of this resource.
sort_order float
The sort order associated with this resource.
space_id str
The space ID associated with this resource.
description String
The description of this tag set.
name String
The name of this resource.
sortOrder Number
The sort order associated with this resource.
spaceId String
The space ID associated with this resource.

Import

$ pulumi import octopusdeploy:index/tagSet:TagSet [options] octopusdeploy_tag_set.<name> <tag-set-id>
Copy

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

Package Details

Repository
octopusdeploy octopusdeploylabs/terraform-provider-octopusdeploy
License
Notes
This Pulumi package is based on the octopusdeploy Terraform Provider.