Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Octopusdeploy Provider
  3. API Docs
  4. Tag
octopusdeploy 0.43.1 published on Wednesday, Apr 30, 2025 by octopusdeploylabs
octopusdeploylabs/terraform-provider-octopusdeploy

octopusdeploy.Tag

Explore with Pulumi AI

octopusdeploy logo
octopusdeploy 0.43.1 published on Wednesday, Apr 30, 2025 by octopusdeploylabs
octopusdeploylabs/terraform-provider-octopusdeploy

    This resource manages tags in Octopus Deploy.

    Create Tag Resource

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

    Constructor syntax

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

@overload
def Tag(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        color: Optional[str] = None,
        tag_set_id: Optional[str] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        sort_order: Optional[float] = None,
        tag_set_space_id: Optional[str] = None)
    func NewTag(ctx *Context, name string, args TagArgs, opts ...ResourceOption) (*Tag, error)
    public Tag(string name, TagArgs args, CustomResourceOptions? opts = null)
    public Tag(String name, TagArgs args)
public Tag(String name, TagArgs args, CustomResourceOptions options)

    type: octopusdeploy:Tag
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args TagArgs
    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 TagArgs
    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 TagArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TagArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TagArgs
    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 tagResource = new Octopusdeploy.Tag("tagResource", new()
{
    Color = "string",
    TagSetId = "string",
    Description = "string",
    Name = "string",
    SortOrder = 0,
    TagSetSpaceId = "string",
});

    example, err := octopusdeploy.NewTag(ctx, "tagResource", &octopusdeploy.TagArgs{
	Color:         pulumi.String("string"),
	TagSetId:      pulumi.String("string"),
	Description:   pulumi.String("string"),
	Name:          pulumi.String("string"),
	SortOrder:     pulumi.Float64(0),
	TagSetSpaceId: pulumi.String("string"),
})

    var tagResource = new Tag("tagResource", TagArgs.builder()
    .color("string")
    .tagSetId("string")
    .description("string")
    .name("string")
    .sortOrder(0)
    .tagSetSpaceId("string")
    .build());

    tag_resource = octopusdeploy.Tag("tagResource",
    color="string",
    tag_set_id="string",
    description="string",
    name="string",
    sort_order=0,
    tag_set_space_id="string")

    const tagResource = new octopusdeploy.Tag("tagResource", {
    color: "string",
    tagSetId: "string",
    description: "string",
    name: "string",
    sortOrder: 0,
    tagSetSpaceId: "string",
});

    type: octopusdeploy:Tag
properties:
    color: string
    description: string
    name: string
    sortOrder: 0
    tagSetId: string
    tagSetSpaceId: string

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

    Color string
    The color of the tag.
    TagSetId string
    The ID of the associated tag set.
    Description string
    The description of the tag.
    Name string
    The name of the tag.
    SortOrder double
    The sort order of the tag.
    TagSetSpaceId string
    The Space ID of the associated tag set. Required if the tag set is not in the same space as what is configured on the provider.
    Color string
    The color of the tag.
    TagSetId string
    The ID of the associated tag set.
    Description string
    The description of the tag.
    Name string
    The name of the tag.
    SortOrder float64
    The sort order of the tag.
    TagSetSpaceId string
    The Space ID of the associated tag set. Required if the tag set is not in the same space as what is configured on the provider.
    color String
    The color of the tag.
    tagSetId String
    The ID of the associated tag set.
    description String
    The description of the tag.
    name String
    The name of the tag.
    sortOrder Double
    The sort order of the tag.
    tagSetSpaceId String
    The Space ID of the associated tag set. Required if the tag set is not in the same space as what is configured on the provider.
    color string
    The color of the tag.
    tagSetId string
    The ID of the associated tag set.
    description string
    The description of the tag.
    name string
    The name of the tag.
    sortOrder number
    The sort order of the tag.
    tagSetSpaceId string
    The Space ID of the associated tag set. Required if the tag set is not in the same space as what is configured on the provider.
    color str
    The color of the tag.
    tag_set_id str
    The ID of the associated tag set.
    description str
    The description of the tag.
    name str
    The name of the tag.
    sort_order float
    The sort order of the tag.
    tag_set_space_id str
    The Space ID of the associated tag set. Required if the tag set is not in the same space as what is configured on the provider.
    color String
    The color of the tag.
    tagSetId String
    The ID of the associated tag set.
    description String
    The description of the tag.
    name String
    The name of the tag.
    sortOrder Number
    The sort order of the tag.
    tagSetSpaceId String
    The Space ID of the associated tag set. Required if the tag set is not in the same space as what is configured on the provider.

    Outputs

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

    CanonicalTagName string
    The canonical name of the tag.
    Id string
    The provider-assigned unique ID for this managed resource.
    CanonicalTagName string
    The canonical name of the tag.
    Id string
    The provider-assigned unique ID for this managed resource.
    canonicalTagName String
    The canonical name of the tag.
    id String
    The provider-assigned unique ID for this managed resource.
    canonicalTagName string
    The canonical name of the tag.
    id string
    The provider-assigned unique ID for this managed resource.
    canonical_tag_name str
    The canonical name of the tag.
    id str
    The provider-assigned unique ID for this managed resource.
    canonicalTagName String
    The canonical name of the tag.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Tag Resource

    Get an existing Tag 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?: TagState, opts?: CustomResourceOptions): Tag
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        canonical_tag_name: Optional[str] = None,
        color: Optional[str] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        sort_order: Optional[float] = None,
        tag_set_id: Optional[str] = None,
        tag_set_space_id: Optional[str] = None) -> Tag
    func GetTag(ctx *Context, name string, id IDInput, state *TagState, opts ...ResourceOption) (*Tag, error)
    public static Tag Get(string name, Input<string> id, TagState? state, CustomResourceOptions? opts = null)
    public static Tag get(String name, Output<String> id, TagState state, CustomResourceOptions options)
    resources:  _:    type: octopusdeploy:Tag    get:      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:
    CanonicalTagName string
    The canonical name of the tag.
    Color string
    The color of the tag.
    Description string
    The description of the tag.
    Name string
    The name of the tag.
    SortOrder double
    The sort order of the tag.
    TagSetId string
    The ID of the associated tag set.
    TagSetSpaceId string
    The Space ID of the associated tag set. Required if the tag set is not in the same space as what is configured on the provider.
    CanonicalTagName string
    The canonical name of the tag.
    Color string
    The color of the tag.
    Description string
    The description of the tag.
    Name string
    The name of the tag.
    SortOrder float64
    The sort order of the tag.
    TagSetId string
    The ID of the associated tag set.
    TagSetSpaceId string
    The Space ID of the associated tag set. Required if the tag set is not in the same space as what is configured on the provider.
    canonicalTagName String
    The canonical name of the tag.
    color String
    The color of the tag.
    description String
    The description of the tag.
    name String
    The name of the tag.
    sortOrder Double
    The sort order of the tag.
    tagSetId String
    The ID of the associated tag set.
    tagSetSpaceId String
    The Space ID of the associated tag set. Required if the tag set is not in the same space as what is configured on the provider.
    canonicalTagName string
    The canonical name of the tag.
    color string
    The color of the tag.
    description string
    The description of the tag.
    name string
    The name of the tag.
    sortOrder number
    The sort order of the tag.
    tagSetId string
    The ID of the associated tag set.
    tagSetSpaceId string
    The Space ID of the associated tag set. Required if the tag set is not in the same space as what is configured on the provider.
    canonical_tag_name str
    The canonical name of the tag.
    color str
    The color of the tag.
    description str
    The description of the tag.
    name str
    The name of the tag.
    sort_order float
    The sort order of the tag.
    tag_set_id str
    The ID of the associated tag set.
    tag_set_space_id str
    The Space ID of the associated tag set. Required if the tag set is not in the same space as what is configured on the provider.
    canonicalTagName String
    The canonical name of the tag.
    color String
    The color of the tag.
    description String
    The description of the tag.
    name String
    The name of the tag.
    sortOrder Number
    The sort order of the tag.
    tagSetId String
    The ID of the associated tag set.
    tagSetSpaceId String
    The Space ID of the associated tag set. Required if the tag set is not in the same space as what is configured on the provider.

    Package Details

    Repository
    octopusdeploy octopusdeploylabs/terraform-provider-octopusdeploy
    License
    Notes
    This Pulumi package is based on the octopusdeploy Terraform Provider.
    octopusdeploy logo
    octopusdeploy 0.43.1 published on Wednesday, Apr 30, 2025 by octopusdeploylabs
    octopusdeploylabs/terraform-provider-octopusdeploy