1. Packages
  2. Octopusdeploy Provider
  3. API Docs
  4. getChannels
octopusdeploy 0.43.2 published on Friday, May 30, 2025 by octopusdeploylabs
octopusdeploylabs/terraform-provider-octopusdeploy

octopusdeploy.getChannels

Start a Neo task
Explain and create an octopusdeploy.getChannels resource
octopusdeploy logo
octopusdeploy 0.43.2 published on Friday, May 30, 2025 by octopusdeploylabs
octopusdeploylabs/terraform-provider-octopusdeploy

    Provides information about existing channels.

    Example Usage

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

const example = octopusdeploy.getChannels({
    ids: [
        "Channels-123",
        "Channels-321",
    ],
    partialName: "Defau",
    skip: 5,
    take: 100,
});

    import pulumi
import pulumi_octopusdeploy as octopusdeploy

example = octopusdeploy.get_channels(ids=[
        "Channels-123",
        "Channels-321",
    ],
    partial_name="Defau",
    skip=5,
    take=100)

    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.GetChannels(ctx, &octopusdeploy.GetChannelsArgs{
			Ids: []string{
				"Channels-123",
				"Channels-321",
			},
			PartialName: pulumi.StringRef("Defau"),
			Skip:        pulumi.Float64Ref(5),
			Take:        pulumi.Float64Ref(100),
		}, nil)
		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 = Octopusdeploy.GetChannels.Invoke(new()
    {
        Ids = new[]
        {
            "Channels-123",
            "Channels-321",
        },
        PartialName = "Defau",
        Skip = 5,
        Take = 100,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.octopusdeploy.OctopusdeployFunctions;
import com.pulumi.octopusdeploy.inputs.GetChannelsArgs;
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 example = OctopusdeployFunctions.getChannels(GetChannelsArgs.builder()
            .ids(            
                "Channels-123",
                "Channels-321")
            .partialName("Defau")
            .skip(5)
            .take(100)
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      function: octopusdeploy:getChannels
      arguments:
        ids:
          - Channels-123
          - Channels-321
        partialName: Defau
        skip: 5
        take: 100

    Using getChannels

    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 getChannels(args: GetChannelsArgs, opts?: InvokeOptions): Promise<GetChannelsResult>
function getChannelsOutput(args: GetChannelsOutputArgs, opts?: InvokeOptions): Output<GetChannelsResult>
    def get_channels(id: Optional[str] = None,
                 ids: Optional[Sequence[str]] = None,
                 partial_name: Optional[str] = None,
                 project_id: Optional[str] = None,
                 skip: Optional[float] = None,
                 space_id: Optional[str] = None,
                 take: Optional[float] = None,
                 opts: Optional[InvokeOptions] = None) -> GetChannelsResult
def get_channels_output(id: Optional[pulumi.Input[str]] = None,
                 ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                 partial_name: Optional[pulumi.Input[str]] = None,
                 project_id: Optional[pulumi.Input[str]] = None,
                 skip: Optional[pulumi.Input[float]] = None,
                 space_id: Optional[pulumi.Input[str]] = None,
                 take: Optional[pulumi.Input[float]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetChannelsResult]
    func GetChannels(ctx *Context, args *GetChannelsArgs, opts ...InvokeOption) (*GetChannelsResult, error)
func GetChannelsOutput(ctx *Context, args *GetChannelsOutputArgs, opts ...InvokeOption) GetChannelsResultOutput

    > Note: This function is named GetChannels in the Go SDK.

    public static class GetChannels 
{
    public static Task<GetChannelsResult> InvokeAsync(GetChannelsArgs args, InvokeOptions? opts = null)
    public static Output<GetChannelsResult> Invoke(GetChannelsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetChannelsResult> getChannels(GetChannelsArgs args, InvokeOptions options)
public static Output<GetChannelsResult> getChannels(GetChannelsArgs args, InvokeOptions options)

    fn::invoke:
  function: octopusdeploy:index/getChannels:getChannels
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Id string
    The ID of this resource.
    Ids List<string>
    A filter to search by a list of IDs.
    PartialName string
    A filter to search by the partial match of a name.
    ProjectId string
    A filter to search by a project ID.
    Skip double
    A filter to specify the number of items to skip in the response.
    SpaceId string
    The space ID associated with this resource.
    Take double
    A filter to specify the number of items to take (or return) in the response.
    Id string
    The ID of this resource.
    Ids []string
    A filter to search by a list of IDs.
    PartialName string
    A filter to search by the partial match of a name.
    ProjectId string
    A filter to search by a project ID.
    Skip float64
    A filter to specify the number of items to skip in the response.
    SpaceId string
    The space ID associated with this resource.
    Take float64
    A filter to specify the number of items to take (or return) in the response.
    id String
    The ID of this resource.
    ids List<String>
    A filter to search by a list of IDs.
    partialName String
    A filter to search by the partial match of a name.
    projectId String
    A filter to search by a project ID.
    skip Double
    A filter to specify the number of items to skip in the response.
    spaceId String
    The space ID associated with this resource.
    take Double
    A filter to specify the number of items to take (or return) in the response.
    id string
    The ID of this resource.
    ids string[]
    A filter to search by a list of IDs.
    partialName string
    A filter to search by the partial match of a name.
    projectId string
    A filter to search by a project ID.
    skip number
    A filter to specify the number of items to skip in the response.
    spaceId string
    The space ID associated with this resource.
    take number
    A filter to specify the number of items to take (or return) in the response.
    id str
    The ID of this resource.
    ids Sequence[str]
    A filter to search by a list of IDs.
    partial_name str
    A filter to search by the partial match of a name.
    project_id str
    A filter to search by a project ID.
    skip float
    A filter to specify the number of items to skip in the response.
    space_id str
    The space ID associated with this resource.
    take float
    A filter to specify the number of items to take (or return) in the response.
    id String
    The ID of this resource.
    ids List<String>
    A filter to search by a list of IDs.
    partialName String
    A filter to search by the partial match of a name.
    projectId String
    A filter to search by a project ID.
    skip Number
    A filter to specify the number of items to skip in the response.
    spaceId String
    The space ID associated with this resource.
    take Number
    A filter to specify the number of items to take (or return) in the response.

    getChannels Result

    The following output properties are available:

    Channels List<GetChannelsChannel>
    A channel that matches the specified filter(s).
    Id string
    The ID of this resource.
    SpaceId string
    The space ID associated with this resource.
    Ids List<string>
    A filter to search by a list of IDs.
    PartialName string
    A filter to search by the partial match of a name.
    ProjectId string
    A filter to search by a project ID.
    Skip double
    A filter to specify the number of items to skip in the response.
    Take double
    A filter to specify the number of items to take (or return) in the response.
    Channels []GetChannelsChannel
    A channel that matches the specified filter(s).
    Id string
    The ID of this resource.
    SpaceId string
    The space ID associated with this resource.
    Ids []string
    A filter to search by a list of IDs.
    PartialName string
    A filter to search by the partial match of a name.
    ProjectId string
    A filter to search by a project ID.
    Skip float64
    A filter to specify the number of items to skip in the response.
    Take float64
    A filter to specify the number of items to take (or return) in the response.
    channels List<GetChannelsChannel>
    A channel that matches the specified filter(s).
    id String
    The ID of this resource.
    spaceId String
    The space ID associated with this resource.
    ids List<String>
    A filter to search by a list of IDs.
    partialName String
    A filter to search by the partial match of a name.
    projectId String
    A filter to search by a project ID.
    skip Double
    A filter to specify the number of items to skip in the response.
    take Double
    A filter to specify the number of items to take (or return) in the response.
    channels GetChannelsChannel[]
    A channel that matches the specified filter(s).
    id string
    The ID of this resource.
    spaceId string
    The space ID associated with this resource.
    ids string[]
    A filter to search by a list of IDs.
    partialName string
    A filter to search by the partial match of a name.
    projectId string
    A filter to search by a project ID.
    skip number
    A filter to specify the number of items to skip in the response.
    take number
    A filter to specify the number of items to take (or return) in the response.
    channels Sequence[GetChannelsChannel]
    A channel that matches the specified filter(s).
    id str
    The ID of this resource.
    space_id str
    The space ID associated with this resource.
    ids Sequence[str]
    A filter to search by a list of IDs.
    partial_name str
    A filter to search by the partial match of a name.
    project_id str
    A filter to search by a project ID.
    skip float
    A filter to specify the number of items to skip in the response.
    take float
    A filter to specify the number of items to take (or return) in the response.
    channels List<Property Map>
    A channel that matches the specified filter(s).
    id String
    The ID of this resource.
    spaceId String
    The space ID associated with this resource.
    ids List<String>
    A filter to search by a list of IDs.
    partialName String
    A filter to search by the partial match of a name.
    projectId String
    A filter to search by a project ID.
    skip Number
    A filter to specify the number of items to skip in the response.
    take Number
    A filter to specify the number of items to take (or return) in the response.

    Supporting Types

    GetChannelsChannel

    description String
    id String
    isDefault Boolean
    lifecycleId String
    name String
    projectId String
    rules List<GetChannelsChannelRule>
    spaceId String
    tenantTags List<String>
    description String
    id String
    isDefault Boolean
    lifecycleId String
    name String
    projectId String
    rules List<Property Map>
    spaceId String
    tenantTags List<String>

    GetChannelsChannelRule

    GetChannelsChannelRuleActionPackage

    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.2 published on Friday, May 30, 2025 by octopusdeploylabs
    octopusdeploylabs/terraform-provider-octopusdeploy
      Meet Neo: Your AI Platform Teammate