1. Packages
  2. Octopusdeploy Provider
  3. API Docs
  4. getFeeds
octopusdeploy 0.43.1 published on Wednesday, Apr 30, 2025 by octopusdeploylabs

octopusdeploy.getFeeds

Explore with Pulumi AI

octopusdeploy logo
octopusdeploy 0.43.1 published on Wednesday, Apr 30, 2025 by octopusdeploylabs

    Provides information about existing feeds.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as octopusdeploy from "@pulumi/octopusdeploy";
    
    const example = octopusdeploy.getFeeds({
        feedType: "NuGet",
        ids: [
            "Feeds-123",
            "Feeds-321",
        ],
        partialName: "Develop",
        skip: 5,
        take: 100,
    });
    
    import pulumi
    import pulumi_octopusdeploy as octopusdeploy
    
    example = octopusdeploy.get_feeds(feed_type="NuGet",
        ids=[
            "Feeds-123",
            "Feeds-321",
        ],
        partial_name="Develop",
        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.GetFeeds(ctx, &octopusdeploy.GetFeedsArgs{
    			FeedType: pulumi.StringRef("NuGet"),
    			Ids: []string{
    				"Feeds-123",
    				"Feeds-321",
    			},
    			PartialName: pulumi.StringRef("Develop"),
    			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.GetFeeds.Invoke(new()
        {
            FeedType = "NuGet",
            Ids = new[]
            {
                "Feeds-123",
                "Feeds-321",
            },
            PartialName = "Develop",
            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.GetFeedsArgs;
    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.getFeeds(GetFeedsArgs.builder()
                .feedType("NuGet")
                .ids(            
                    "Feeds-123",
                    "Feeds-321")
                .partialName("Develop")
                .skip(5)
                .take(100)
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          function: octopusdeploy:getFeeds
          arguments:
            feedType: NuGet
            ids:
              - Feeds-123
              - Feeds-321
            partialName: Develop
            skip: 5
            take: 100
    

    Using getFeeds

    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 getFeeds(args: GetFeedsArgs, opts?: InvokeOptions): Promise<GetFeedsResult>
    function getFeedsOutput(args: GetFeedsOutputArgs, opts?: InvokeOptions): Output<GetFeedsResult>
    def get_feeds(feed_type: Optional[str] = None,
                  ids: Optional[Sequence[str]] = None,
                  name: Optional[str] = None,
                  partial_name: Optional[str] = None,
                  skip: Optional[float] = None,
                  space_id: Optional[str] = None,
                  take: Optional[float] = None,
                  opts: Optional[InvokeOptions] = None) -> GetFeedsResult
    def get_feeds_output(feed_type: Optional[pulumi.Input[str]] = None,
                  ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                  name: Optional[pulumi.Input[str]] = None,
                  partial_name: 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[GetFeedsResult]
    func GetFeeds(ctx *Context, args *GetFeedsArgs, opts ...InvokeOption) (*GetFeedsResult, error)
    func GetFeedsOutput(ctx *Context, args *GetFeedsOutputArgs, opts ...InvokeOption) GetFeedsResultOutput

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

    public static class GetFeeds 
    {
        public static Task<GetFeedsResult> InvokeAsync(GetFeedsArgs args, InvokeOptions? opts = null)
        public static Output<GetFeedsResult> Invoke(GetFeedsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetFeedsResult> getFeeds(GetFeedsArgs args, InvokeOptions options)
    public static Output<GetFeedsResult> getFeeds(GetFeedsArgs args, InvokeOptions options)
    
    fn::invoke:
      function: octopusdeploy:index/getFeeds:getFeeds
      arguments:
        # arguments dictionary

    The following arguments are supported:

    FeedType string
    A filter to search by feed type. Valid feed types are AwsElasticContainerRegistry, BuiltIn, Docker, GitHub, Helm, Maven, NuGet, S3, OciRegistry or OctopusProject.
    Ids List<string>
    A filter to search by a list of IDs.
    Name string
    The name of this resource.
    PartialName string
    A filter to search by a partial name.
    Skip double
    A filter to specify the number of items to skip in the response.
    SpaceId string
    The space ID associated with this feeds.
    Take double
    A filter to specify the number of items to take (or return) in the response.
    FeedType string
    A filter to search by feed type. Valid feed types are AwsElasticContainerRegistry, BuiltIn, Docker, GitHub, Helm, Maven, NuGet, S3, OciRegistry or OctopusProject.
    Ids []string
    A filter to search by a list of IDs.
    Name string
    The name of this resource.
    PartialName string
    A filter to search by a partial name.
    Skip float64
    A filter to specify the number of items to skip in the response.
    SpaceId string
    The space ID associated with this feeds.
    Take float64
    A filter to specify the number of items to take (or return) in the response.
    feedType String
    A filter to search by feed type. Valid feed types are AwsElasticContainerRegistry, BuiltIn, Docker, GitHub, Helm, Maven, NuGet, S3, OciRegistry or OctopusProject.
    ids List<String>
    A filter to search by a list of IDs.
    name String
    The name of this resource.
    partialName String
    A filter to search by a partial name.
    skip Double
    A filter to specify the number of items to skip in the response.
    spaceId String
    The space ID associated with this feeds.
    take Double
    A filter to specify the number of items to take (or return) in the response.
    feedType string
    A filter to search by feed type. Valid feed types are AwsElasticContainerRegistry, BuiltIn, Docker, GitHub, Helm, Maven, NuGet, S3, OciRegistry or OctopusProject.
    ids string[]
    A filter to search by a list of IDs.
    name string
    The name of this resource.
    partialName string
    A filter to search by a partial name.
    skip number
    A filter to specify the number of items to skip in the response.
    spaceId string
    The space ID associated with this feeds.
    take number
    A filter to specify the number of items to take (or return) in the response.
    feed_type str
    A filter to search by feed type. Valid feed types are AwsElasticContainerRegistry, BuiltIn, Docker, GitHub, Helm, Maven, NuGet, S3, OciRegistry or OctopusProject.
    ids Sequence[str]
    A filter to search by a list of IDs.
    name str
    The name of this resource.
    partial_name str
    A filter to search by a partial name.
    skip float
    A filter to specify the number of items to skip in the response.
    space_id str
    The space ID associated with this feeds.
    take float
    A filter to specify the number of items to take (or return) in the response.
    feedType String
    A filter to search by feed type. Valid feed types are AwsElasticContainerRegistry, BuiltIn, Docker, GitHub, Helm, Maven, NuGet, S3, OciRegistry or OctopusProject.
    ids List<String>
    A filter to search by a list of IDs.
    name String
    The name of this resource.
    partialName String
    A filter to search by a partial name.
    skip Number
    A filter to specify the number of items to skip in the response.
    spaceId String
    The space ID associated with this feeds.
    take Number
    A filter to specify the number of items to take (or return) in the response.

    getFeeds Result

    The following output properties are available:

    Feeds List<GetFeedsFeed>
    Id string
    The unique ID for this resource.
    SpaceId string
    The space ID associated with this feeds.
    FeedType string
    A filter to search by feed type. Valid feed types are AwsElasticContainerRegistry, BuiltIn, Docker, GitHub, Helm, Maven, NuGet, S3, OciRegistry or OctopusProject.
    Ids List<string>
    A filter to search by a list of IDs.
    Name string
    The name of this resource.
    PartialName string
    A filter to search by a partial name.
    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.
    Feeds []GetFeedsFeed
    Id string
    The unique ID for this resource.
    SpaceId string
    The space ID associated with this feeds.
    FeedType string
    A filter to search by feed type. Valid feed types are AwsElasticContainerRegistry, BuiltIn, Docker, GitHub, Helm, Maven, NuGet, S3, OciRegistry or OctopusProject.
    Ids []string
    A filter to search by a list of IDs.
    Name string
    The name of this resource.
    PartialName string
    A filter to search by a partial name.
    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.
    feeds List<GetFeedsFeed>
    id String
    The unique ID for this resource.
    spaceId String
    The space ID associated with this feeds.
    feedType String
    A filter to search by feed type. Valid feed types are AwsElasticContainerRegistry, BuiltIn, Docker, GitHub, Helm, Maven, NuGet, S3, OciRegistry or OctopusProject.
    ids List<String>
    A filter to search by a list of IDs.
    name String
    The name of this resource.
    partialName String
    A filter to search by a partial name.
    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.
    feeds GetFeedsFeed[]
    id string
    The unique ID for this resource.
    spaceId string
    The space ID associated with this feeds.
    feedType string
    A filter to search by feed type. Valid feed types are AwsElasticContainerRegistry, BuiltIn, Docker, GitHub, Helm, Maven, NuGet, S3, OciRegistry or OctopusProject.
    ids string[]
    A filter to search by a list of IDs.
    name string
    The name of this resource.
    partialName string
    A filter to search by a partial name.
    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.
    feeds Sequence[GetFeedsFeed]
    id str
    The unique ID for this resource.
    space_id str
    The space ID associated with this feeds.
    feed_type str
    A filter to search by feed type. Valid feed types are AwsElasticContainerRegistry, BuiltIn, Docker, GitHub, Helm, Maven, NuGet, S3, OciRegistry or OctopusProject.
    ids Sequence[str]
    A filter to search by a list of IDs.
    name str
    The name of this resource.
    partial_name str
    A filter to search by a partial name.
    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.
    feeds List<Property Map>
    id String
    The unique ID for this resource.
    spaceId String
    The space ID associated with this feeds.
    feedType String
    A filter to search by feed type. Valid feed types are AwsElasticContainerRegistry, BuiltIn, Docker, GitHub, Helm, Maven, NuGet, S3, OciRegistry or OctopusProject.
    ids List<String>
    A filter to search by a list of IDs.
    name String
    The name of this resource.
    partialName String
    A filter to search by a partial name.
    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

    GetFeedsFeed

    AccessKey string
    The AWS access key to use when authenticating against Amazon Web Services.
    ApiVersion string
    DeleteUnreleasedPackagesAfterDays double
    DownloadAttempts double
    The number of times a deployment should attempt to download a package from this feed before failing.
    DownloadRetryBackoffSeconds double
    The number of seconds to apply as a linear back off between download attempts.
    FeedType string
    A filter to search by feed type. Valid feed types are AwsElasticContainerRegistry, BuiltIn, Docker, GitHub, Helm, Maven, NuGet, S3, OciRegistry or OctopusProject.
    FeedUri string
    Id string
    The unique ID for this resource.
    IsEnhancedMode bool
    Name string
    The name of this resource.
    PackageAcquisitionLocationOptions List<string>
    Password string
    The password associated with this resource.
    Region string
    RegistryPath string
    SecretKey string
    SpaceId string
    The space ID associated with this feeds.
    UseMachineCredentials bool
    When true will use Amazon Web Services credentials configured on the worker.
    Username string
    The username associated with this resource.
    AccessKey string
    The AWS access key to use when authenticating against Amazon Web Services.
    ApiVersion string
    DeleteUnreleasedPackagesAfterDays float64
    DownloadAttempts float64
    The number of times a deployment should attempt to download a package from this feed before failing.
    DownloadRetryBackoffSeconds float64
    The number of seconds to apply as a linear back off between download attempts.
    FeedType string
    A filter to search by feed type. Valid feed types are AwsElasticContainerRegistry, BuiltIn, Docker, GitHub, Helm, Maven, NuGet, S3, OciRegistry or OctopusProject.
    FeedUri string
    Id string
    The unique ID for this resource.
    IsEnhancedMode bool
    Name string
    The name of this resource.
    PackageAcquisitionLocationOptions []string
    Password string
    The password associated with this resource.
    Region string
    RegistryPath string
    SecretKey string
    SpaceId string
    The space ID associated with this feeds.
    UseMachineCredentials bool
    When true will use Amazon Web Services credentials configured on the worker.
    Username string
    The username associated with this resource.
    accessKey String
    The AWS access key to use when authenticating against Amazon Web Services.
    apiVersion String
    deleteUnreleasedPackagesAfterDays Double
    downloadAttempts Double
    The number of times a deployment should attempt to download a package from this feed before failing.
    downloadRetryBackoffSeconds Double
    The number of seconds to apply as a linear back off between download attempts.
    feedType String
    A filter to search by feed type. Valid feed types are AwsElasticContainerRegistry, BuiltIn, Docker, GitHub, Helm, Maven, NuGet, S3, OciRegistry or OctopusProject.
    feedUri String
    id String
    The unique ID for this resource.
    isEnhancedMode Boolean
    name String
    The name of this resource.
    packageAcquisitionLocationOptions List<String>
    password String
    The password associated with this resource.
    region String
    registryPath String
    secretKey String
    spaceId String
    The space ID associated with this feeds.
    useMachineCredentials Boolean
    When true will use Amazon Web Services credentials configured on the worker.
    username String
    The username associated with this resource.
    accessKey string
    The AWS access key to use when authenticating against Amazon Web Services.
    apiVersion string
    deleteUnreleasedPackagesAfterDays number
    downloadAttempts number
    The number of times a deployment should attempt to download a package from this feed before failing.
    downloadRetryBackoffSeconds number
    The number of seconds to apply as a linear back off between download attempts.
    feedType string
    A filter to search by feed type. Valid feed types are AwsElasticContainerRegistry, BuiltIn, Docker, GitHub, Helm, Maven, NuGet, S3, OciRegistry or OctopusProject.
    feedUri string
    id string
    The unique ID for this resource.
    isEnhancedMode boolean
    name string
    The name of this resource.
    packageAcquisitionLocationOptions string[]
    password string
    The password associated with this resource.
    region string
    registryPath string
    secretKey string
    spaceId string
    The space ID associated with this feeds.
    useMachineCredentials boolean
    When true will use Amazon Web Services credentials configured on the worker.
    username string
    The username associated with this resource.
    access_key str
    The AWS access key to use when authenticating against Amazon Web Services.
    api_version str
    delete_unreleased_packages_after_days float
    download_attempts float
    The number of times a deployment should attempt to download a package from this feed before failing.
    download_retry_backoff_seconds float
    The number of seconds to apply as a linear back off between download attempts.
    feed_type str
    A filter to search by feed type. Valid feed types are AwsElasticContainerRegistry, BuiltIn, Docker, GitHub, Helm, Maven, NuGet, S3, OciRegistry or OctopusProject.
    feed_uri str
    id str
    The unique ID for this resource.
    is_enhanced_mode bool
    name str
    The name of this resource.
    package_acquisition_location_options Sequence[str]
    password str
    The password associated with this resource.
    region str
    registry_path str
    secret_key str
    space_id str
    The space ID associated with this feeds.
    use_machine_credentials bool
    When true will use Amazon Web Services credentials configured on the worker.
    username str
    The username associated with this resource.
    accessKey String
    The AWS access key to use when authenticating against Amazon Web Services.
    apiVersion String
    deleteUnreleasedPackagesAfterDays Number
    downloadAttempts Number
    The number of times a deployment should attempt to download a package from this feed before failing.
    downloadRetryBackoffSeconds Number
    The number of seconds to apply as a linear back off between download attempts.
    feedType String
    A filter to search by feed type. Valid feed types are AwsElasticContainerRegistry, BuiltIn, Docker, GitHub, Helm, Maven, NuGet, S3, OciRegistry or OctopusProject.
    feedUri String
    id String
    The unique ID for this resource.
    isEnhancedMode Boolean
    name String
    The name of this resource.
    packageAcquisitionLocationOptions List<String>
    password String
    The password associated with this resource.
    region String
    registryPath String
    secretKey String
    spaceId String
    The space ID associated with this feeds.
    useMachineCredentials Boolean
    When true will use Amazon Web Services credentials configured on the worker.
    username String
    The username associated with this resource.

    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