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

octopusdeploy.Channel

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 channels in Octopus Deploy.

    Example Usage

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

const example = new octopusdeploy.Channel("example", {projectId: "Projects-123"});

    import pulumi
import pulumi_octopusdeploy as octopusdeploy

example = octopusdeploy.Channel("example", project_id="Projects-123")

    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 {
		_, err := octopusdeploy.NewChannel(ctx, "example", &octopusdeploy.ChannelArgs{
			ProjectId: pulumi.String("Projects-123"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = new Octopusdeploy.Channel("example", new()
    {
        ProjectId = "Projects-123",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.octopusdeploy.Channel;
import com.pulumi.octopusdeploy.ChannelArgs;
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 Channel("example", ChannelArgs.builder()
            .projectId("Projects-123")
            .build());

    }
}

    resources:
  example:
    type: octopusdeploy:Channel
    properties:
      projectId: Projects-123

    Create Channel Resource

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

    Constructor syntax

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

@overload
def Channel(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            project_id: Optional[str] = None,
            channel_id: Optional[str] = None,
            description: Optional[str] = None,
            is_default: Optional[bool] = None,
            lifecycle_id: Optional[str] = None,
            name: Optional[str] = None,
            rules: Optional[Sequence[ChannelRuleArgs]] = None,
            space_id: Optional[str] = None,
            tenant_tags: Optional[Sequence[str]] = None)
    func NewChannel(ctx *Context, name string, args ChannelArgs, opts ...ResourceOption) (*Channel, error)
    public Channel(string name, ChannelArgs args, CustomResourceOptions? opts = null)
    public Channel(String name, ChannelArgs args)
public Channel(String name, ChannelArgs args, CustomResourceOptions options)

    type: octopusdeploy:Channel
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 ChannelArgs
    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 ChannelArgs
    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 ChannelArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ChannelArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ChannelArgs
    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 channelResource = new Octopusdeploy.Channel("channelResource", new()
{
    ProjectId = "string",
    ChannelId = "string",
    Description = "string",
    IsDefault = false,
    LifecycleId = "string",
    Name = "string",
    Rules = new[]
    {
        new Octopusdeploy.Inputs.ChannelRuleArgs
        {
            ActionPackages = new[]
            {
                new Octopusdeploy.Inputs.ChannelRuleActionPackageArgs
                {
                    DeploymentAction = "string",
                    PackageReference = "string",
                },
            },
            Id = "string",
            Tag = "string",
            VersionRange = "string",
        },
    },
    SpaceId = "string",
    TenantTags = new[]
    {
        "string",
    },
});

    example, err := octopusdeploy.NewChannel(ctx, "channelResource", &octopusdeploy.ChannelArgs{
	ProjectId:   pulumi.String("string"),
	ChannelId:   pulumi.String("string"),
	Description: pulumi.String("string"),
	IsDefault:   pulumi.Bool(false),
	LifecycleId: pulumi.String("string"),
	Name:        pulumi.String("string"),
	Rules: octopusdeploy.ChannelRuleArray{
		&octopusdeploy.ChannelRuleArgs{
			ActionPackages: octopusdeploy.ChannelRuleActionPackageArray{
				&octopusdeploy.ChannelRuleActionPackageArgs{
					DeploymentAction: pulumi.String("string"),
					PackageReference: pulumi.String("string"),
				},
			},
			Id:           pulumi.String("string"),
			Tag:          pulumi.String("string"),
			VersionRange: pulumi.String("string"),
		},
	},
	SpaceId: pulumi.String("string"),
	TenantTags: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var channelResource = new Channel("channelResource", ChannelArgs.builder()
    .projectId("string")
    .channelId("string")
    .description("string")
    .isDefault(false)
    .lifecycleId("string")
    .name("string")
    .rules(ChannelRuleArgs.builder()
        .actionPackages(ChannelRuleActionPackageArgs.builder()
            .deploymentAction("string")
            .packageReference("string")
            .build())
        .id("string")
        .tag("string")
        .versionRange("string")
        .build())
    .spaceId("string")
    .tenantTags("string")
    .build());

    channel_resource = octopusdeploy.Channel("channelResource",
    project_id="string",
    channel_id="string",
    description="string",
    is_default=False,
    lifecycle_id="string",
    name="string",
    rules=[{
        "action_packages": [{
            "deployment_action": "string",
            "package_reference": "string",
        }],
        "id": "string",
        "tag": "string",
        "version_range": "string",
    }],
    space_id="string",
    tenant_tags=["string"])

    const channelResource = new octopusdeploy.Channel("channelResource", {
    projectId: "string",
    channelId: "string",
    description: "string",
    isDefault: false,
    lifecycleId: "string",
    name: "string",
    rules: [{
        actionPackages: [{
            deploymentAction: "string",
            packageReference: "string",
        }],
        id: "string",
        tag: "string",
        versionRange: "string",
    }],
    spaceId: "string",
    tenantTags: ["string"],
});

    type: octopusdeploy:Channel
properties:
    channelId: string
    description: string
    isDefault: false
    lifecycleId: string
    name: string
    projectId: string
    rules:
        - actionPackages:
            - deploymentAction: string
              packageReference: string
          id: string
          tag: string
          versionRange: string
    spaceId: string
    tenantTags:
        - string

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

    ProjectId string
    The project ID associated with this channel.
    ChannelId string
    The unique ID for this resource.
    Description string
    The description of this channel.
    IsDefault bool
    Indicates if this is the default channel for the associated project.
    LifecycleId string
    The lifecycle ID associated with this channel.
    Name string
    The name of this resource.
    Rules List<ChannelRule>
    A list of rules associated with this channel.
    SpaceId string
    The space ID associated with this resource.
    TenantTags List<string>
    A list of tenant tags associated with this resource.
    ProjectId string
    The project ID associated with this channel.
    ChannelId string
    The unique ID for this resource.
    Description string
    The description of this channel.
    IsDefault bool
    Indicates if this is the default channel for the associated project.
    LifecycleId string
    The lifecycle ID associated with this channel.
    Name string
    The name of this resource.
    Rules []ChannelRuleArgs
    A list of rules associated with this channel.
    SpaceId string
    The space ID associated with this resource.
    TenantTags []string
    A list of tenant tags associated with this resource.
    projectId String
    The project ID associated with this channel.
    channelId String
    The unique ID for this resource.
    description String
    The description of this channel.
    isDefault Boolean
    Indicates if this is the default channel for the associated project.
    lifecycleId String
    The lifecycle ID associated with this channel.
    name String
    The name of this resource.
    rules List<ChannelRule>
    A list of rules associated with this channel.
    spaceId String
    The space ID associated with this resource.
    tenantTags List<String>
    A list of tenant tags associated with this resource.
    projectId string
    The project ID associated with this channel.
    channelId string
    The unique ID for this resource.
    description string
    The description of this channel.
    isDefault boolean
    Indicates if this is the default channel for the associated project.
    lifecycleId string
    The lifecycle ID associated with this channel.
    name string
    The name of this resource.
    rules ChannelRule[]
    A list of rules associated with this channel.
    spaceId string
    The space ID associated with this resource.
    tenantTags string[]
    A list of tenant tags associated with this resource.
    project_id str
    The project ID associated with this channel.
    channel_id str
    The unique ID for this resource.
    description str
    The description of this channel.
    is_default bool
    Indicates if this is the default channel for the associated project.
    lifecycle_id str
    The lifecycle ID associated with this channel.
    name str
    The name of this resource.
    rules Sequence[ChannelRuleArgs]
    A list of rules associated with this channel.
    space_id str
    The space ID associated with this resource.
    tenant_tags Sequence[str]
    A list of tenant tags associated with this resource.
    projectId String
    The project ID associated with this channel.
    channelId String
    The unique ID for this resource.
    description String
    The description of this channel.
    isDefault Boolean
    Indicates if this is the default channel for the associated project.
    lifecycleId String
    The lifecycle ID associated with this channel.
    name String
    The name of this resource.
    rules List<Property Map>
    A list of rules associated with this channel.
    spaceId String
    The space ID associated with this resource.
    tenantTags List<String>
    A list of tenant tags associated with this resource.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Channel 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 Channel Resource

    Get an existing Channel 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?: ChannelState, opts?: CustomResourceOptions): Channel
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        channel_id: Optional[str] = None,
        description: Optional[str] = None,
        is_default: Optional[bool] = None,
        lifecycle_id: Optional[str] = None,
        name: Optional[str] = None,
        project_id: Optional[str] = None,
        rules: Optional[Sequence[ChannelRuleArgs]] = None,
        space_id: Optional[str] = None,
        tenant_tags: Optional[Sequence[str]] = None) -> Channel
    func GetChannel(ctx *Context, name string, id IDInput, state *ChannelState, opts ...ResourceOption) (*Channel, error)
    public static Channel Get(string name, Input<string> id, ChannelState? state, CustomResourceOptions? opts = null)
    public static Channel get(String name, Output<String> id, ChannelState state, CustomResourceOptions options)
    resources:  _:    type: octopusdeploy:Channel    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:
    ChannelId string
    The unique ID for this resource.
    Description string
    The description of this channel.
    IsDefault bool
    Indicates if this is the default channel for the associated project.
    LifecycleId string
    The lifecycle ID associated with this channel.
    Name string
    The name of this resource.
    ProjectId string
    The project ID associated with this channel.
    Rules List<ChannelRule>
    A list of rules associated with this channel.
    SpaceId string
    The space ID associated with this resource.
    TenantTags List<string>
    A list of tenant tags associated with this resource.
    ChannelId string
    The unique ID for this resource.
    Description string
    The description of this channel.
    IsDefault bool
    Indicates if this is the default channel for the associated project.
    LifecycleId string
    The lifecycle ID associated with this channel.
    Name string
    The name of this resource.
    ProjectId string
    The project ID associated with this channel.
    Rules []ChannelRuleArgs
    A list of rules associated with this channel.
    SpaceId string
    The space ID associated with this resource.
    TenantTags []string
    A list of tenant tags associated with this resource.
    channelId String
    The unique ID for this resource.
    description String
    The description of this channel.
    isDefault Boolean
    Indicates if this is the default channel for the associated project.
    lifecycleId String
    The lifecycle ID associated with this channel.
    name String
    The name of this resource.
    projectId String
    The project ID associated with this channel.
    rules List<ChannelRule>
    A list of rules associated with this channel.
    spaceId String
    The space ID associated with this resource.
    tenantTags List<String>
    A list of tenant tags associated with this resource.
    channelId string
    The unique ID for this resource.
    description string
    The description of this channel.
    isDefault boolean
    Indicates if this is the default channel for the associated project.
    lifecycleId string
    The lifecycle ID associated with this channel.
    name string
    The name of this resource.
    projectId string
    The project ID associated with this channel.
    rules ChannelRule[]
    A list of rules associated with this channel.
    spaceId string
    The space ID associated with this resource.
    tenantTags string[]
    A list of tenant tags associated with this resource.
    channel_id str
    The unique ID for this resource.
    description str
    The description of this channel.
    is_default bool
    Indicates if this is the default channel for the associated project.
    lifecycle_id str
    The lifecycle ID associated with this channel.
    name str
    The name of this resource.
    project_id str
    The project ID associated with this channel.
    rules Sequence[ChannelRuleArgs]
    A list of rules associated with this channel.
    space_id str
    The space ID associated with this resource.
    tenant_tags Sequence[str]
    A list of tenant tags associated with this resource.
    channelId String
    The unique ID for this resource.
    description String
    The description of this channel.
    isDefault Boolean
    Indicates if this is the default channel for the associated project.
    lifecycleId String
    The lifecycle ID associated with this channel.
    name String
    The name of this resource.
    projectId String
    The project ID associated with this channel.
    rules List<Property Map>
    A list of rules associated with this channel.
    spaceId String
    The space ID associated with this resource.
    tenantTags List<String>
    A list of tenant tags associated with this resource.

    Supporting Types

    ChannelRule, ChannelRuleArgs

    ActionPackages List<ChannelRuleActionPackage>
    Id string
    The unique ID for this resource.
    Tag string
    VersionRange string
    ActionPackages []ChannelRuleActionPackage
    Id string
    The unique ID for this resource.
    Tag string
    VersionRange string
    actionPackages List<ChannelRuleActionPackage>
    id String
    The unique ID for this resource.
    tag String
    versionRange String
    actionPackages ChannelRuleActionPackage[]
    id string
    The unique ID for this resource.
    tag string
    versionRange string
    action_packages Sequence[ChannelRuleActionPackage]
    id str
    The unique ID for this resource.
    tag str
    version_range str
    actionPackages List<Property Map>
    id String
    The unique ID for this resource.
    tag String
    versionRange String

    ChannelRuleActionPackage, ChannelRuleActionPackageArgs

    Import

    $ pulumi import octopusdeploy:index/channel:Channel [options] octopusdeploy_channel.<name> <channel-id>

    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.
    octopusdeploy logo
    octopusdeploy 0.43.1 published on Wednesday, Apr 30, 2025 by octopusdeploylabs
    octopusdeploylabs/terraform-provider-octopusdeploy