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

octopusdeploy.getLifecycles

Explore with Pulumi AI

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

    Provides information about existing lifecycles.

    Example Usage

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

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

    import pulumi
import pulumi_octopusdeploy as octopusdeploy

example = octopusdeploy.get_lifecycles(ids=[
        "Lifecycles-123",
        "Lifecycles-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.GetLifecycles(ctx, &octopusdeploy.GetLifecyclesArgs{
			Ids: []string{
				"Lifecycles-123",
				"Lifecycles-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.GetLifecycles.Invoke(new()
    {
        Ids = new[]
        {
            "Lifecycles-123",
            "Lifecycles-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.GetLifecyclesArgs;
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.getLifecycles(GetLifecyclesArgs.builder()
            .ids(            
                "Lifecycles-123",
                "Lifecycles-321")
            .partialName("Defau")
            .skip(5)
            .take(100)
            .build());

    }
}

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

    Using getLifecycles

    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 getLifecycles(args: GetLifecyclesArgs, opts?: InvokeOptions): Promise<GetLifecyclesResult>
function getLifecyclesOutput(args: GetLifecyclesOutputArgs, opts?: InvokeOptions): Output<GetLifecyclesResult>
    def get_lifecycles(ids: Optional[Sequence[str]] = None,
                   partial_name: Optional[str] = None,
                   skip: Optional[float] = None,
                   space_id: Optional[str] = None,
                   take: Optional[float] = None,
                   opts: Optional[InvokeOptions] = None) -> GetLifecyclesResult
def get_lifecycles_output(ids: Optional[pulumi.Input[Sequence[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[GetLifecyclesResult]
    func GetLifecycles(ctx *Context, args *GetLifecyclesArgs, opts ...InvokeOption) (*GetLifecyclesResult, error)
func GetLifecyclesOutput(ctx *Context, args *GetLifecyclesOutputArgs, opts ...InvokeOption) GetLifecyclesResultOutput

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

    public static class GetLifecycles 
{
    public static Task<GetLifecyclesResult> InvokeAsync(GetLifecyclesArgs args, InvokeOptions? opts = null)
    public static Output<GetLifecyclesResult> Invoke(GetLifecyclesInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetLifecyclesResult> getLifecycles(GetLifecyclesArgs args, InvokeOptions options)
public static Output<GetLifecyclesResult> getLifecycles(GetLifecyclesArgs args, InvokeOptions options)

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

    The following arguments are supported:

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

    getLifecycles Result

    The following output properties are available:

    Id string
    The ID of the lifecycle.
    Lifecycles List<GetLifecyclesLifecycle>
    Ids List<string>
    A list of lifecycle IDs to filter by.
    PartialName string
    A partial name to filter lifecycles by.
    Skip double
    A filter to specify the number of items to skip in the response.
    SpaceId string
    The space ID associated with this lifecycle.
    Take double
    A filter to specify the number of items to take (or return) in the response.
    Id string
    The ID of the lifecycle.
    Lifecycles []GetLifecyclesLifecycle
    Ids []string
    A list of lifecycle IDs to filter by.
    PartialName string
    A partial name to filter lifecycles by.
    Skip float64
    A filter to specify the number of items to skip in the response.
    SpaceId string
    The space ID associated with this lifecycle.
    Take float64
    A filter to specify the number of items to take (or return) in the response.
    id String
    The ID of the lifecycle.
    lifecycles List<GetLifecyclesLifecycle>
    ids List<String>
    A list of lifecycle IDs to filter by.
    partialName String
    A partial name to filter lifecycles by.
    skip Double
    A filter to specify the number of items to skip in the response.
    spaceId String
    The space ID associated with this lifecycle.
    take Double
    A filter to specify the number of items to take (or return) in the response.
    id string
    The ID of the lifecycle.
    lifecycles GetLifecyclesLifecycle[]
    ids string[]
    A list of lifecycle IDs to filter by.
    partialName string
    A partial name to filter lifecycles by.
    skip number
    A filter to specify the number of items to skip in the response.
    spaceId string
    The space ID associated with this lifecycle.
    take number
    A filter to specify the number of items to take (or return) in the response.
    id str
    The ID of the lifecycle.
    lifecycles Sequence[GetLifecyclesLifecycle]
    ids Sequence[str]
    A list of lifecycle IDs to filter by.
    partial_name str
    A partial name to filter lifecycles by.
    skip float
    A filter to specify the number of items to skip in the response.
    space_id str
    The space ID associated with this lifecycle.
    take float
    A filter to specify the number of items to take (or return) in the response.
    id String
    The ID of the lifecycle.
    lifecycles List<Property Map>
    ids List<String>
    A list of lifecycle IDs to filter by.
    partialName String
    A partial name to filter lifecycles by.
    skip Number
    A filter to specify the number of items to skip in the response.
    spaceId String
    The space ID associated with this lifecycle.
    take Number
    A filter to specify the number of items to take (or return) in the response.

    Supporting Types

    GetLifecyclesLifecycle

    Description string
    The description of the lifecycle.
    Id string
    The ID of the lifecycle.
    Name string
    The name of the lifecycle.
    Phases List<GetLifecyclesLifecyclePhase>
    ReleaseRetentionPolicies List<GetLifecyclesLifecycleReleaseRetentionPolicy>
    SpaceId string
    The space ID associated with this lifecycle.
    TentacleRetentionPolicies List<GetLifecyclesLifecycleTentacleRetentionPolicy>
    Description string
    The description of the lifecycle.
    Id string
    The ID of the lifecycle.
    Name string
    The name of the lifecycle.
    Phases []GetLifecyclesLifecyclePhase
    ReleaseRetentionPolicies []GetLifecyclesLifecycleReleaseRetentionPolicy
    SpaceId string
    The space ID associated with this lifecycle.
    TentacleRetentionPolicies []GetLifecyclesLifecycleTentacleRetentionPolicy
    description String
    The description of the lifecycle.
    id String
    The ID of the lifecycle.
    name String
    The name of the lifecycle.
    phases List<GetLifecyclesLifecyclePhase>
    releaseRetentionPolicies List<GetLifecyclesLifecycleReleaseRetentionPolicy>
    spaceId String
    The space ID associated with this lifecycle.
    tentacleRetentionPolicies List<GetLifecyclesLifecycleTentacleRetentionPolicy>
    description string
    The description of the lifecycle.
    id string
    The ID of the lifecycle.
    name string
    The name of the lifecycle.
    phases GetLifecyclesLifecyclePhase[]
    releaseRetentionPolicies GetLifecyclesLifecycleReleaseRetentionPolicy[]
    spaceId string
    The space ID associated with this lifecycle.
    tentacleRetentionPolicies GetLifecyclesLifecycleTentacleRetentionPolicy[]
    description String
    The description of the lifecycle.
    id String
    The ID of the lifecycle.
    name String
    The name of the lifecycle.
    phases List<Property Map>
    releaseRetentionPolicies List<Property Map>
    spaceId String
    The space ID associated with this lifecycle.
    tentacleRetentionPolicies List<Property Map>

    GetLifecyclesLifecyclePhase

    AutomaticDeploymentTargets List<string>
    The automatic deployment targets for this phase.
    Id string
    The ID of the phase.
    IsOptionalPhase bool
    Whether this phase is optional.
    IsPriorityPhase bool
    Deployments will be prioritized in this phase
    MinimumEnvironmentsBeforePromotion double
    The minimum number of environments before promotion.
    Name string
    The name of the phase.
    OptionalDeploymentTargets List<string>
    The optional deployment targets for this phase.
    ReleaseRetentionPolicies List<GetLifecyclesLifecyclePhaseReleaseRetentionPolicy>
    TentacleRetentionPolicies List<GetLifecyclesLifecyclePhaseTentacleRetentionPolicy>
    AutomaticDeploymentTargets []string
    The automatic deployment targets for this phase.
    Id string
    The ID of the phase.
    IsOptionalPhase bool
    Whether this phase is optional.
    IsPriorityPhase bool
    Deployments will be prioritized in this phase
    MinimumEnvironmentsBeforePromotion float64
    The minimum number of environments before promotion.
    Name string
    The name of the phase.
    OptionalDeploymentTargets []string
    The optional deployment targets for this phase.
    ReleaseRetentionPolicies []GetLifecyclesLifecyclePhaseReleaseRetentionPolicy
    TentacleRetentionPolicies []GetLifecyclesLifecyclePhaseTentacleRetentionPolicy
    automaticDeploymentTargets List<String>
    The automatic deployment targets for this phase.
    id String
    The ID of the phase.
    isOptionalPhase Boolean
    Whether this phase is optional.
    isPriorityPhase Boolean
    Deployments will be prioritized in this phase
    minimumEnvironmentsBeforePromotion Double
    The minimum number of environments before promotion.
    name String
    The name of the phase.
    optionalDeploymentTargets List<String>
    The optional deployment targets for this phase.
    releaseRetentionPolicies List<GetLifecyclesLifecyclePhaseReleaseRetentionPolicy>
    tentacleRetentionPolicies List<GetLifecyclesLifecyclePhaseTentacleRetentionPolicy>
    automaticDeploymentTargets string[]
    The automatic deployment targets for this phase.
    id string
    The ID of the phase.
    isOptionalPhase boolean
    Whether this phase is optional.
    isPriorityPhase boolean
    Deployments will be prioritized in this phase
    minimumEnvironmentsBeforePromotion number
    The minimum number of environments before promotion.
    name string
    The name of the phase.
    optionalDeploymentTargets string[]
    The optional deployment targets for this phase.
    releaseRetentionPolicies GetLifecyclesLifecyclePhaseReleaseRetentionPolicy[]
    tentacleRetentionPolicies GetLifecyclesLifecyclePhaseTentacleRetentionPolicy[]
    automatic_deployment_targets Sequence[str]
    The automatic deployment targets for this phase.
    id str
    The ID of the phase.
    is_optional_phase bool
    Whether this phase is optional.
    is_priority_phase bool
    Deployments will be prioritized in this phase
    minimum_environments_before_promotion float
    The minimum number of environments before promotion.
    name str
    The name of the phase.
    optional_deployment_targets Sequence[str]
    The optional deployment targets for this phase.
    release_retention_policies Sequence[GetLifecyclesLifecyclePhaseReleaseRetentionPolicy]
    tentacle_retention_policies Sequence[GetLifecyclesLifecyclePhaseTentacleRetentionPolicy]
    automaticDeploymentTargets List<String>
    The automatic deployment targets for this phase.
    id String
    The ID of the phase.
    isOptionalPhase Boolean
    Whether this phase is optional.
    isPriorityPhase Boolean
    Deployments will be prioritized in this phase
    minimumEnvironmentsBeforePromotion Number
    The minimum number of environments before promotion.
    name String
    The name of the phase.
    optionalDeploymentTargets List<String>
    The optional deployment targets for this phase.
    releaseRetentionPolicies List<Property Map>
    tentacleRetentionPolicies List<Property Map>

    GetLifecyclesLifecyclePhaseReleaseRetentionPolicy

    QuantityToKeep double
    The quantity of releases to keep.
    ShouldKeepForever bool
    Whether releases should be kept forever.
    Unit string
    The unit of time for the retention policy.
    QuantityToKeep float64
    The quantity of releases to keep.
    ShouldKeepForever bool
    Whether releases should be kept forever.
    Unit string
    The unit of time for the retention policy.
    quantityToKeep Double
    The quantity of releases to keep.
    shouldKeepForever Boolean
    Whether releases should be kept forever.
    unit String
    The unit of time for the retention policy.
    quantityToKeep number
    The quantity of releases to keep.
    shouldKeepForever boolean
    Whether releases should be kept forever.
    unit string
    The unit of time for the retention policy.
    quantity_to_keep float
    The quantity of releases to keep.
    should_keep_forever bool
    Whether releases should be kept forever.
    unit str
    The unit of time for the retention policy.
    quantityToKeep Number
    The quantity of releases to keep.
    shouldKeepForever Boolean
    Whether releases should be kept forever.
    unit String
    The unit of time for the retention policy.

    GetLifecyclesLifecyclePhaseTentacleRetentionPolicy

    QuantityToKeep double
    The quantity of releases to keep.
    ShouldKeepForever bool
    Whether releases should be kept forever.
    Unit string
    The unit of time for the retention policy.
    QuantityToKeep float64
    The quantity of releases to keep.
    ShouldKeepForever bool
    Whether releases should be kept forever.
    Unit string
    The unit of time for the retention policy.
    quantityToKeep Double
    The quantity of releases to keep.
    shouldKeepForever Boolean
    Whether releases should be kept forever.
    unit String
    The unit of time for the retention policy.
    quantityToKeep number
    The quantity of releases to keep.
    shouldKeepForever boolean
    Whether releases should be kept forever.
    unit string
    The unit of time for the retention policy.
    quantity_to_keep float
    The quantity of releases to keep.
    should_keep_forever bool
    Whether releases should be kept forever.
    unit str
    The unit of time for the retention policy.
    quantityToKeep Number
    The quantity of releases to keep.
    shouldKeepForever Boolean
    Whether releases should be kept forever.
    unit String
    The unit of time for the retention policy.

    GetLifecyclesLifecycleReleaseRetentionPolicy

    QuantityToKeep double
    The quantity of releases to keep.
    ShouldKeepForever bool
    Whether releases should be kept forever.
    Unit string
    The unit of time for the retention policy.
    QuantityToKeep float64
    The quantity of releases to keep.
    ShouldKeepForever bool
    Whether releases should be kept forever.
    Unit string
    The unit of time for the retention policy.
    quantityToKeep Double
    The quantity of releases to keep.
    shouldKeepForever Boolean
    Whether releases should be kept forever.
    unit String
    The unit of time for the retention policy.
    quantityToKeep number
    The quantity of releases to keep.
    shouldKeepForever boolean
    Whether releases should be kept forever.
    unit string
    The unit of time for the retention policy.
    quantity_to_keep float
    The quantity of releases to keep.
    should_keep_forever bool
    Whether releases should be kept forever.
    unit str
    The unit of time for the retention policy.
    quantityToKeep Number
    The quantity of releases to keep.
    shouldKeepForever Boolean
    Whether releases should be kept forever.
    unit String
    The unit of time for the retention policy.

    GetLifecyclesLifecycleTentacleRetentionPolicy

    QuantityToKeep double
    The quantity of releases to keep.
    ShouldKeepForever bool
    Whether releases should be kept forever.
    Unit string
    The unit of time for the retention policy.
    QuantityToKeep float64
    The quantity of releases to keep.
    ShouldKeepForever bool
    Whether releases should be kept forever.
    Unit string
    The unit of time for the retention policy.
    quantityToKeep Double
    The quantity of releases to keep.
    shouldKeepForever Boolean
    Whether releases should be kept forever.
    unit String
    The unit of time for the retention policy.
    quantityToKeep number
    The quantity of releases to keep.
    shouldKeepForever boolean
    Whether releases should be kept forever.
    unit string
    The unit of time for the retention policy.
    quantity_to_keep float
    The quantity of releases to keep.
    should_keep_forever bool
    Whether releases should be kept forever.
    unit str
    The unit of time for the retention policy.
    quantityToKeep Number
    The quantity of releases to keep.
    shouldKeepForever Boolean
    Whether releases should be kept forever.
    unit String
    The unit of time for the retention policy.

    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