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

octopusdeploy.getProjects

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

    Provides information about existing Octopus Deploy projects.

    Example Usage

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

const example = octopusdeploy.getProjects({
    clonedFromProjectId: "Projects-456",
    ids: [
        "Projects-123",
        "Projects-321",
    ],
    isClone: true,
    name: "Default",
    partialName: "Defau",
    skip: 5,
    take: 100,
});

    import pulumi
import pulumi_octopusdeploy as octopusdeploy

example = octopusdeploy.get_projects(cloned_from_project_id="Projects-456",
    ids=[
        "Projects-123",
        "Projects-321",
    ],
    is_clone=True,
    name="Default",
    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.GetProjects(ctx, &octopusdeploy.GetProjectsArgs{
			ClonedFromProjectId: pulumi.StringRef("Projects-456"),
			Ids: []string{
				"Projects-123",
				"Projects-321",
			},
			IsClone:     pulumi.BoolRef(true),
			Name:        pulumi.StringRef("Default"),
			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.GetProjects.Invoke(new()
    {
        ClonedFromProjectId = "Projects-456",
        Ids = new[]
        {
            "Projects-123",
            "Projects-321",
        },
        IsClone = true,
        Name = "Default",
        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.GetProjectsArgs;
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.getProjects(GetProjectsArgs.builder()
            .clonedFromProjectId("Projects-456")
            .ids(            
                "Projects-123",
                "Projects-321")
            .isClone(true)
            .name("Default")
            .partialName("Defau")
            .skip(5)
            .take(100)
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      function: octopusdeploy:getProjects
      arguments:
        clonedFromProjectId: Projects-456
        ids:
          - Projects-123
          - Projects-321
        isClone: true
        name: Default
        partialName: Defau
        skip: 5
        take: 100

    Using getProjects

    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 getProjects(args: GetProjectsArgs, opts?: InvokeOptions): Promise<GetProjectsResult>
function getProjectsOutput(args: GetProjectsOutputArgs, opts?: InvokeOptions): Output<GetProjectsResult>
    def get_projects(cloned_from_project_id: Optional[str] = None,
                 ids: Optional[Sequence[str]] = None,
                 is_clone: Optional[bool] = 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) -> GetProjectsResult
def get_projects_output(cloned_from_project_id: Optional[pulumi.Input[str]] = None,
                 ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                 is_clone: Optional[pulumi.Input[bool]] = 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[GetProjectsResult]
    func GetProjects(ctx *Context, args *GetProjectsArgs, opts ...InvokeOption) (*GetProjectsResult, error)
func GetProjectsOutput(ctx *Context, args *GetProjectsOutputArgs, opts ...InvokeOption) GetProjectsResultOutput

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

    public static class GetProjects 
{
    public static Task<GetProjectsResult> InvokeAsync(GetProjectsArgs args, InvokeOptions? opts = null)
    public static Output<GetProjectsResult> Invoke(GetProjectsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetProjectsResult> getProjects(GetProjectsArgs args, InvokeOptions options)
public static Output<GetProjectsResult> getProjects(GetProjectsArgs args, InvokeOptions options)

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

    The following arguments are supported:

    ClonedFromProjectId string
    A filter to search for cloned resources by a project ID.
    Ids List<string>
    A filter to search by a list of IDs.
    IsClone bool
    A filter to search for cloned resources.
    Name string
    A filter to search by name
    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
    A Space ID to filter by. Will revert what is specified on the provider if not set
    Take double
    A filter to specify the number of items to take (or return) in the response.
    ClonedFromProjectId string
    A filter to search for cloned resources by a project ID.
    Ids []string
    A filter to search by a list of IDs.
    IsClone bool
    A filter to search for cloned resources.
    Name string
    A filter to search by name
    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
    A Space ID to filter by. Will revert what is specified on the provider if not set
    Take float64
    A filter to specify the number of items to take (or return) in the response.
    clonedFromProjectId String
    A filter to search for cloned resources by a project ID.
    ids List<String>
    A filter to search by a list of IDs.
    isClone Boolean
    A filter to search for cloned resources.
    name String
    A filter to search by name
    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
    A Space ID to filter by. Will revert what is specified on the provider if not set
    take Double
    A filter to specify the number of items to take (or return) in the response.
    clonedFromProjectId string
    A filter to search for cloned resources by a project ID.
    ids string[]
    A filter to search by a list of IDs.
    isClone boolean
    A filter to search for cloned resources.
    name string
    A filter to search by name
    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
    A Space ID to filter by. Will revert what is specified on the provider if not set
    take number
    A filter to specify the number of items to take (or return) in the response.
    cloned_from_project_id str
    A filter to search for cloned resources by a project ID.
    ids Sequence[str]
    A filter to search by a list of IDs.
    is_clone bool
    A filter to search for cloned resources.
    name str
    A filter to search by name
    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
    A Space ID to filter by. Will revert what is specified on the provider if not set
    take float
    A filter to specify the number of items to take (or return) in the response.
    clonedFromProjectId String
    A filter to search for cloned resources by a project ID.
    ids List<String>
    A filter to search by a list of IDs.
    isClone Boolean
    A filter to search for cloned resources.
    name String
    A filter to search by name
    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
    A Space ID to filter by. Will revert what is specified on the provider if not set
    take Number
    A filter to specify the number of items to take (or return) in the response.

    getProjects Result

    The following output properties are available:

    Id string
    An auto-generated identifier that includes the timestamp when this data source was last modified.
    Projects List<GetProjectsProject>
    A list of projects that match the filter(s).
    ClonedFromProjectId string
    A filter to search for cloned resources by a project ID.
    Ids List<string>
    A filter to search by a list of IDs.
    IsClone bool
    A filter to search for cloned resources.
    Name string
    A filter to search by name
    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
    A Space ID to filter by. Will revert what is specified on the provider if not set
    Take double
    A filter to specify the number of items to take (or return) in the response.
    Id string
    An auto-generated identifier that includes the timestamp when this data source was last modified.
    Projects []GetProjectsProject
    A list of projects that match the filter(s).
    ClonedFromProjectId string
    A filter to search for cloned resources by a project ID.
    Ids []string
    A filter to search by a list of IDs.
    IsClone bool
    A filter to search for cloned resources.
    Name string
    A filter to search by name
    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
    A Space ID to filter by. Will revert what is specified on the provider if not set
    Take float64
    A filter to specify the number of items to take (or return) in the response.
    id String
    An auto-generated identifier that includes the timestamp when this data source was last modified.
    projects List<GetProjectsProject>
    A list of projects that match the filter(s).
    clonedFromProjectId String
    A filter to search for cloned resources by a project ID.
    ids List<String>
    A filter to search by a list of IDs.
    isClone Boolean
    A filter to search for cloned resources.
    name String
    A filter to search by name
    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
    A Space ID to filter by. Will revert what is specified on the provider if not set
    take Double
    A filter to specify the number of items to take (or return) in the response.
    id string
    An auto-generated identifier that includes the timestamp when this data source was last modified.
    projects GetProjectsProject[]
    A list of projects that match the filter(s).
    clonedFromProjectId string
    A filter to search for cloned resources by a project ID.
    ids string[]
    A filter to search by a list of IDs.
    isClone boolean
    A filter to search for cloned resources.
    name string
    A filter to search by name
    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
    A Space ID to filter by. Will revert what is specified on the provider if not set
    take number
    A filter to specify the number of items to take (or return) in the response.
    id str
    An auto-generated identifier that includes the timestamp when this data source was last modified.
    projects Sequence[GetProjectsProject]
    A list of projects that match the filter(s).
    cloned_from_project_id str
    A filter to search for cloned resources by a project ID.
    ids Sequence[str]
    A filter to search by a list of IDs.
    is_clone bool
    A filter to search for cloned resources.
    name str
    A filter to search by name
    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
    A Space ID to filter by. Will revert what is specified on the provider if not set
    take float
    A filter to specify the number of items to take (or return) in the response.
    id String
    An auto-generated identifier that includes the timestamp when this data source was last modified.
    projects List<Property Map>
    A list of projects that match the filter(s).
    clonedFromProjectId String
    A filter to search for cloned resources by a project ID.
    ids List<String>
    A filter to search by a list of IDs.
    isClone Boolean
    A filter to search for cloned resources.
    name String
    A filter to search by name
    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
    A Space ID to filter by. Will revert what is specified on the provider if not set
    take Number
    A filter to specify the number of items to take (or return) in the response.

    Supporting Types

    GetProjectsProject

    AllowDeploymentsToNoTargets bool

    Deprecated: Deprecated

    AutoCreateRelease bool
    AutoDeployReleaseOverrides List<GetProjectsProjectAutoDeployReleaseOverride>
    ClonedFromProjectId string
    ConnectivityPolicies List<GetProjectsProjectConnectivityPolicy>
    DefaultGuidedFailureMode string
    DefaultToSkipIfAlreadyInstalled bool
    DeploymentChangesTemplate string
    DeploymentProcessId string
    Description string
    The description of this project
    DiscreteChannelRelease bool
    Treats releases of different channels to the same environment as a separate deployment dimension
    GitAnonymousPersistenceSettings List<GetProjectsProjectGitAnonymousPersistenceSetting>
    Git-related persistence settings for a version-controlled project using anonymous authentication.
    GitLibraryPersistenceSettings List<GetProjectsProjectGitLibraryPersistenceSetting>
    Git-related persistence settings for a version-controlled project using library authentication.
    GitUsernamePasswordPersistenceSettings List<GetProjectsProjectGitUsernamePasswordPersistenceSetting>
    Git-related persistence settings for a version-controlled project using username*password authentication.
    Id string
    IncludedLibraryVariableSets List<string>
    IsDisabled bool
    IsDiscreteChannelRelease bool
    IsVersionControlled bool
    JiraServiceManagementExtensionSettings List<GetProjectsProjectJiraServiceManagementExtensionSetting>
    Extension settings for the Jira Service Management (JSM) integration.
    LifecycleId string
    The lifecycle ID associated with this project
    Name string
    The name of the project in Octopus Deploy. This name must be unique.
    ProjectGroupId string
    The project group ID associated with this project.
    ReleaseCreationStrategies List<GetProjectsProjectReleaseCreationStrategy>
    The release creation strategy for the project.
    ReleaseNotesTemplate string
    The template to use for release notes.
    ServicenowExtensionSettings List<GetProjectsProjectServicenowExtensionSetting>
    Extension settings for the ServiceNow integration.
    Slug string
    A human-readable, unique identifier, used to identify a project.
    SpaceId string
    The space ID associated with this project.
    Templates List<GetProjectsProjectTemplate>
    Template parameters for the project.
    TenantedDeploymentParticipation string
    The tenanted deployment mode of the project.
    VariableSetId string
    The ID of the variable set associated with this project.
    VersioningStrategies List<GetProjectsProjectVersioningStrategy>
    The versioning strategy for the project.
    AllowDeploymentsToNoTargets bool

    Deprecated: Deprecated

    AutoCreateRelease bool
    AutoDeployReleaseOverrides []GetProjectsProjectAutoDeployReleaseOverride
    ClonedFromProjectId string
    ConnectivityPolicies []GetProjectsProjectConnectivityPolicy
    DefaultGuidedFailureMode string
    DefaultToSkipIfAlreadyInstalled bool
    DeploymentChangesTemplate string
    DeploymentProcessId string
    Description string
    The description of this project
    DiscreteChannelRelease bool
    Treats releases of different channels to the same environment as a separate deployment dimension
    GitAnonymousPersistenceSettings []GetProjectsProjectGitAnonymousPersistenceSetting
    Git-related persistence settings for a version-controlled project using anonymous authentication.
    GitLibraryPersistenceSettings []GetProjectsProjectGitLibraryPersistenceSetting
    Git-related persistence settings for a version-controlled project using library authentication.
    GitUsernamePasswordPersistenceSettings []GetProjectsProjectGitUsernamePasswordPersistenceSetting
    Git-related persistence settings for a version-controlled project using username*password authentication.
    Id string
    IncludedLibraryVariableSets []string
    IsDisabled bool
    IsDiscreteChannelRelease bool
    IsVersionControlled bool
    JiraServiceManagementExtensionSettings []GetProjectsProjectJiraServiceManagementExtensionSetting
    Extension settings for the Jira Service Management (JSM) integration.
    LifecycleId string
    The lifecycle ID associated with this project
    Name string
    The name of the project in Octopus Deploy. This name must be unique.
    ProjectGroupId string
    The project group ID associated with this project.
    ReleaseCreationStrategies []GetProjectsProjectReleaseCreationStrategy
    The release creation strategy for the project.
    ReleaseNotesTemplate string
    The template to use for release notes.
    ServicenowExtensionSettings []GetProjectsProjectServicenowExtensionSetting
    Extension settings for the ServiceNow integration.
    Slug string
    A human-readable, unique identifier, used to identify a project.
    SpaceId string
    The space ID associated with this project.
    Templates []GetProjectsProjectTemplate
    Template parameters for the project.
    TenantedDeploymentParticipation string
    The tenanted deployment mode of the project.
    VariableSetId string
    The ID of the variable set associated with this project.
    VersioningStrategies []GetProjectsProjectVersioningStrategy
    The versioning strategy for the project.
    allowDeploymentsToNoTargets Boolean

    Deprecated: Deprecated

    autoCreateRelease Boolean
    autoDeployReleaseOverrides List<GetProjectsProjectAutoDeployReleaseOverride>
    clonedFromProjectId String
    connectivityPolicies List<GetProjectsProjectConnectivityPolicy>
    defaultGuidedFailureMode String
    defaultToSkipIfAlreadyInstalled Boolean
    deploymentChangesTemplate String
    deploymentProcessId String
    description String
    The description of this project
    discreteChannelRelease Boolean
    Treats releases of different channels to the same environment as a separate deployment dimension
    gitAnonymousPersistenceSettings List<GetProjectsProjectGitAnonymousPersistenceSetting>
    Git-related persistence settings for a version-controlled project using anonymous authentication.
    gitLibraryPersistenceSettings List<GetProjectsProjectGitLibraryPersistenceSetting>
    Git-related persistence settings for a version-controlled project using library authentication.
    gitUsernamePasswordPersistenceSettings List<GetProjectsProjectGitUsernamePasswordPersistenceSetting>
    Git-related persistence settings for a version-controlled project using username*password authentication.
    id String
    includedLibraryVariableSets List<String>
    isDisabled Boolean
    isDiscreteChannelRelease Boolean
    isVersionControlled Boolean
    jiraServiceManagementExtensionSettings List<GetProjectsProjectJiraServiceManagementExtensionSetting>
    Extension settings for the Jira Service Management (JSM) integration.
    lifecycleId String
    The lifecycle ID associated with this project
    name String
    The name of the project in Octopus Deploy. This name must be unique.
    projectGroupId String
    The project group ID associated with this project.
    releaseCreationStrategies List<GetProjectsProjectReleaseCreationStrategy>
    The release creation strategy for the project.
    releaseNotesTemplate String
    The template to use for release notes.
    servicenowExtensionSettings List<GetProjectsProjectServicenowExtensionSetting>
    Extension settings for the ServiceNow integration.
    slug String
    A human-readable, unique identifier, used to identify a project.
    spaceId String
    The space ID associated with this project.
    templates List<GetProjectsProjectTemplate>
    Template parameters for the project.
    tenantedDeploymentParticipation String
    The tenanted deployment mode of the project.
    variableSetId String
    The ID of the variable set associated with this project.
    versioningStrategies List<GetProjectsProjectVersioningStrategy>
    The versioning strategy for the project.
    allowDeploymentsToNoTargets boolean

    Deprecated: Deprecated

    autoCreateRelease boolean
    autoDeployReleaseOverrides GetProjectsProjectAutoDeployReleaseOverride[]
    clonedFromProjectId string
    connectivityPolicies GetProjectsProjectConnectivityPolicy[]
    defaultGuidedFailureMode string
    defaultToSkipIfAlreadyInstalled boolean
    deploymentChangesTemplate string
    deploymentProcessId string
    description string
    The description of this project
    discreteChannelRelease boolean
    Treats releases of different channels to the same environment as a separate deployment dimension
    gitAnonymousPersistenceSettings GetProjectsProjectGitAnonymousPersistenceSetting[]
    Git-related persistence settings for a version-controlled project using anonymous authentication.
    gitLibraryPersistenceSettings GetProjectsProjectGitLibraryPersistenceSetting[]
    Git-related persistence settings for a version-controlled project using library authentication.
    gitUsernamePasswordPersistenceSettings GetProjectsProjectGitUsernamePasswordPersistenceSetting[]
    Git-related persistence settings for a version-controlled project using username*password authentication.
    id string
    includedLibraryVariableSets string[]
    isDisabled boolean
    isDiscreteChannelRelease boolean
    isVersionControlled boolean
    jiraServiceManagementExtensionSettings GetProjectsProjectJiraServiceManagementExtensionSetting[]
    Extension settings for the Jira Service Management (JSM) integration.
    lifecycleId string
    The lifecycle ID associated with this project
    name string
    The name of the project in Octopus Deploy. This name must be unique.
    projectGroupId string
    The project group ID associated with this project.
    releaseCreationStrategies GetProjectsProjectReleaseCreationStrategy[]
    The release creation strategy for the project.
    releaseNotesTemplate string
    The template to use for release notes.
    servicenowExtensionSettings GetProjectsProjectServicenowExtensionSetting[]
    Extension settings for the ServiceNow integration.
    slug string
    A human-readable, unique identifier, used to identify a project.
    spaceId string
    The space ID associated with this project.
    templates GetProjectsProjectTemplate[]
    Template parameters for the project.
    tenantedDeploymentParticipation string
    The tenanted deployment mode of the project.
    variableSetId string
    The ID of the variable set associated with this project.
    versioningStrategies GetProjectsProjectVersioningStrategy[]
    The versioning strategy for the project.
    allow_deployments_to_no_targets bool

    Deprecated: Deprecated

    auto_create_release bool
    auto_deploy_release_overrides Sequence[GetProjectsProjectAutoDeployReleaseOverride]
    cloned_from_project_id str
    connectivity_policies Sequence[GetProjectsProjectConnectivityPolicy]
    default_guided_failure_mode str
    default_to_skip_if_already_installed bool
    deployment_changes_template str
    deployment_process_id str
    description str
    The description of this project
    discrete_channel_release bool
    Treats releases of different channels to the same environment as a separate deployment dimension
    git_anonymous_persistence_settings Sequence[GetProjectsProjectGitAnonymousPersistenceSetting]
    Git-related persistence settings for a version-controlled project using anonymous authentication.
    git_library_persistence_settings Sequence[GetProjectsProjectGitLibraryPersistenceSetting]
    Git-related persistence settings for a version-controlled project using library authentication.
    git_username_password_persistence_settings Sequence[GetProjectsProjectGitUsernamePasswordPersistenceSetting]
    Git-related persistence settings for a version-controlled project using username*password authentication.
    id str
    included_library_variable_sets Sequence[str]
    is_disabled bool
    is_discrete_channel_release bool
    is_version_controlled bool
    jira_service_management_extension_settings Sequence[GetProjectsProjectJiraServiceManagementExtensionSetting]
    Extension settings for the Jira Service Management (JSM) integration.
    lifecycle_id str
    The lifecycle ID associated with this project
    name str
    The name of the project in Octopus Deploy. This name must be unique.
    project_group_id str
    The project group ID associated with this project.
    release_creation_strategies Sequence[GetProjectsProjectReleaseCreationStrategy]
    The release creation strategy for the project.
    release_notes_template str
    The template to use for release notes.
    servicenow_extension_settings Sequence[GetProjectsProjectServicenowExtensionSetting]
    Extension settings for the ServiceNow integration.
    slug str
    A human-readable, unique identifier, used to identify a project.
    space_id str
    The space ID associated with this project.
    templates Sequence[GetProjectsProjectTemplate]
    Template parameters for the project.
    tenanted_deployment_participation str
    The tenanted deployment mode of the project.
    variable_set_id str
    The ID of the variable set associated with this project.
    versioning_strategies Sequence[GetProjectsProjectVersioningStrategy]
    The versioning strategy for the project.
    allowDeploymentsToNoTargets Boolean

    Deprecated: Deprecated

    autoCreateRelease Boolean
    autoDeployReleaseOverrides List<Property Map>
    clonedFromProjectId String
    connectivityPolicies List<Property Map>
    defaultGuidedFailureMode String
    defaultToSkipIfAlreadyInstalled Boolean
    deploymentChangesTemplate String
    deploymentProcessId String
    description String
    The description of this project
    discreteChannelRelease Boolean
    Treats releases of different channels to the same environment as a separate deployment dimension
    gitAnonymousPersistenceSettings List<Property Map>
    Git-related persistence settings for a version-controlled project using anonymous authentication.
    gitLibraryPersistenceSettings List<Property Map>
    Git-related persistence settings for a version-controlled project using library authentication.
    gitUsernamePasswordPersistenceSettings List<Property Map>
    Git-related persistence settings for a version-controlled project using username*password authentication.
    id String
    includedLibraryVariableSets List<String>
    isDisabled Boolean
    isDiscreteChannelRelease Boolean
    isVersionControlled Boolean
    jiraServiceManagementExtensionSettings List<Property Map>
    Extension settings for the Jira Service Management (JSM) integration.
    lifecycleId String
    The lifecycle ID associated with this project
    name String
    The name of the project in Octopus Deploy. This name must be unique.
    projectGroupId String
    The project group ID associated with this project.
    releaseCreationStrategies List<Property Map>
    The release creation strategy for the project.
    releaseNotesTemplate String
    The template to use for release notes.
    servicenowExtensionSettings List<Property Map>
    Extension settings for the ServiceNow integration.
    slug String
    A human-readable, unique identifier, used to identify a project.
    spaceId String
    The space ID associated with this project.
    templates List<Property Map>
    Template parameters for the project.
    tenantedDeploymentParticipation String
    The tenanted deployment mode of the project.
    variableSetId String
    The ID of the variable set associated with this project.
    versioningStrategies List<Property Map>
    The versioning strategy for the project.

    GetProjectsProjectAutoDeployReleaseOverride

    EnvironmentId string
    The environment ID for the auto deploy release override.
    ReleaseId string
    The release ID for the auto deploy release override.
    TenantId string
    The tenant ID for the auto deploy release override.
    EnvironmentId string
    The environment ID for the auto deploy release override.
    ReleaseId string
    The release ID for the auto deploy release override.
    TenantId string
    The tenant ID for the auto deploy release override.
    environmentId String
    The environment ID for the auto deploy release override.
    releaseId String
    The release ID for the auto deploy release override.
    tenantId String
    The tenant ID for the auto deploy release override.
    environmentId string
    The environment ID for the auto deploy release override.
    releaseId string
    The release ID for the auto deploy release override.
    tenantId string
    The tenant ID for the auto deploy release override.
    environment_id str
    The environment ID for the auto deploy release override.
    release_id str
    The release ID for the auto deploy release override.
    tenant_id str
    The tenant ID for the auto deploy release override.
    environmentId String
    The environment ID for the auto deploy release override.
    releaseId String
    The release ID for the auto deploy release override.
    tenantId String
    The tenant ID for the auto deploy release override.

    GetProjectsProjectConnectivityPolicy

    AllowDeploymentsToNoTargets bool
    Allow deployments to be created when there are no targets.
    ExcludeUnhealthyTargets bool
    Exclude unhealthy targets from deployments.
    SkipMachineBehavior string
    The behavior when a machine is skipped.
    TargetRoles List<string>
    The target roles for the connectivity policy.
    AllowDeploymentsToNoTargets bool
    Allow deployments to be created when there are no targets.
    ExcludeUnhealthyTargets bool
    Exclude unhealthy targets from deployments.
    SkipMachineBehavior string
    The behavior when a machine is skipped.
    TargetRoles []string
    The target roles for the connectivity policy.
    allowDeploymentsToNoTargets Boolean
    Allow deployments to be created when there are no targets.
    excludeUnhealthyTargets Boolean
    Exclude unhealthy targets from deployments.
    skipMachineBehavior String
    The behavior when a machine is skipped.
    targetRoles List<String>
    The target roles for the connectivity policy.
    allowDeploymentsToNoTargets boolean
    Allow deployments to be created when there are no targets.
    excludeUnhealthyTargets boolean
    Exclude unhealthy targets from deployments.
    skipMachineBehavior string
    The behavior when a machine is skipped.
    targetRoles string[]
    The target roles for the connectivity policy.
    allow_deployments_to_no_targets bool
    Allow deployments to be created when there are no targets.
    exclude_unhealthy_targets bool
    Exclude unhealthy targets from deployments.
    skip_machine_behavior str
    The behavior when a machine is skipped.
    target_roles Sequence[str]
    The target roles for the connectivity policy.
    allowDeploymentsToNoTargets Boolean
    Allow deployments to be created when there are no targets.
    excludeUnhealthyTargets Boolean
    Exclude unhealthy targets from deployments.
    skipMachineBehavior String
    The behavior when a machine is skipped.
    targetRoles List<String>
    The target roles for the connectivity policy.

    GetProjectsProjectGitAnonymousPersistenceSetting

    BasePath string
    The base path associated with these version control settings.
    DefaultBranch string
    The default branch associated with these version control settings.
    ProtectedBranches List<string>
    A list of protected branch patterns.
    Url string
    The URL associated with these version control settings.
    BasePath string
    The base path associated with these version control settings.
    DefaultBranch string
    The default branch associated with these version control settings.
    ProtectedBranches []string
    A list of protected branch patterns.
    Url string
    The URL associated with these version control settings.
    basePath String
    The base path associated with these version control settings.
    defaultBranch String
    The default branch associated with these version control settings.
    protectedBranches List<String>
    A list of protected branch patterns.
    url String
    The URL associated with these version control settings.
    basePath string
    The base path associated with these version control settings.
    defaultBranch string
    The default branch associated with these version control settings.
    protectedBranches string[]
    A list of protected branch patterns.
    url string
    The URL associated with these version control settings.
    base_path str
    The base path associated with these version control settings.
    default_branch str
    The default branch associated with these version control settings.
    protected_branches Sequence[str]
    A list of protected branch patterns.
    url str
    The URL associated with these version control settings.
    basePath String
    The base path associated with these version control settings.
    defaultBranch String
    The default branch associated with these version control settings.
    protectedBranches List<String>
    A list of protected branch patterns.
    url String
    The URL associated with these version control settings.

    GetProjectsProjectGitLibraryPersistenceSetting

    BasePath string
    The base path associated with these version control settings.
    DefaultBranch string
    The default branch associated with these version control settings.
    GitCredentialId string
    The ID of the Git credential.
    ProtectedBranches List<string>
    A list of protected branch patterns.
    Url string
    The URL associated with these version control settings.
    BasePath string
    The base path associated with these version control settings.
    DefaultBranch string
    The default branch associated with these version control settings.
    GitCredentialId string
    The ID of the Git credential.
    ProtectedBranches []string
    A list of protected branch patterns.
    Url string
    The URL associated with these version control settings.
    basePath String
    The base path associated with these version control settings.
    defaultBranch String
    The default branch associated with these version control settings.
    gitCredentialId String
    The ID of the Git credential.
    protectedBranches List<String>
    A list of protected branch patterns.
    url String
    The URL associated with these version control settings.
    basePath string
    The base path associated with these version control settings.
    defaultBranch string
    The default branch associated with these version control settings.
    gitCredentialId string
    The ID of the Git credential.
    protectedBranches string[]
    A list of protected branch patterns.
    url string
    The URL associated with these version control settings.
    base_path str
    The base path associated with these version control settings.
    default_branch str
    The default branch associated with these version control settings.
    git_credential_id str
    The ID of the Git credential.
    protected_branches Sequence[str]
    A list of protected branch patterns.
    url str
    The URL associated with these version control settings.
    basePath String
    The base path associated with these version control settings.
    defaultBranch String
    The default branch associated with these version control settings.
    gitCredentialId String
    The ID of the Git credential.
    protectedBranches List<String>
    A list of protected branch patterns.
    url String
    The URL associated with these version control settings.

    GetProjectsProjectGitUsernamePasswordPersistenceSetting

    BasePath string
    The base path associated with these version control settings.
    DefaultBranch string
    The default branch associated with these version control settings.
    Password string
    The password for the Git credential.
    ProtectedBranches List<string>
    A list of protected branch patterns.
    Url string
    The URL associated with these version control settings.
    Username string
    The username for the Git credential.
    BasePath string
    The base path associated with these version control settings.
    DefaultBranch string
    The default branch associated with these version control settings.
    Password string
    The password for the Git credential.
    ProtectedBranches []string
    A list of protected branch patterns.
    Url string
    The URL associated with these version control settings.
    Username string
    The username for the Git credential.
    basePath String
    The base path associated with these version control settings.
    defaultBranch String
    The default branch associated with these version control settings.
    password String
    The password for the Git credential.
    protectedBranches List<String>
    A list of protected branch patterns.
    url String
    The URL associated with these version control settings.
    username String
    The username for the Git credential.
    basePath string
    The base path associated with these version control settings.
    defaultBranch string
    The default branch associated with these version control settings.
    password string
    The password for the Git credential.
    protectedBranches string[]
    A list of protected branch patterns.
    url string
    The URL associated with these version control settings.
    username string
    The username for the Git credential.
    base_path str
    The base path associated with these version control settings.
    default_branch str
    The default branch associated with these version control settings.
    password str
    The password for the Git credential.
    protected_branches Sequence[str]
    A list of protected branch patterns.
    url str
    The URL associated with these version control settings.
    username str
    The username for the Git credential.
    basePath String
    The base path associated with these version control settings.
    defaultBranch String
    The default branch associated with these version control settings.
    password String
    The password for the Git credential.
    protectedBranches List<String>
    A list of protected branch patterns.
    url String
    The URL associated with these version control settings.
    username String
    The username for the Git credential.

    GetProjectsProjectJiraServiceManagementExtensionSetting

    ConnectionId string
    The connection identifier for JSM.
    IsEnabled bool
    Whether the JSM extension is enabled.
    ServiceDeskProjectName string
    The JSM service desk project name.
    ConnectionId string
    The connection identifier for JSM.
    IsEnabled bool
    Whether the JSM extension is enabled.
    ServiceDeskProjectName string
    The JSM service desk project name.
    connectionId String
    The connection identifier for JSM.
    isEnabled Boolean
    Whether the JSM extension is enabled.
    serviceDeskProjectName String
    The JSM service desk project name.
    connectionId string
    The connection identifier for JSM.
    isEnabled boolean
    Whether the JSM extension is enabled.
    serviceDeskProjectName string
    The JSM service desk project name.
    connection_id str
    The connection identifier for JSM.
    is_enabled bool
    Whether the JSM extension is enabled.
    service_desk_project_name str
    The JSM service desk project name.
    connectionId String
    The connection identifier for JSM.
    isEnabled Boolean
    Whether the JSM extension is enabled.
    serviceDeskProjectName String
    The JSM service desk project name.

    GetProjectsProjectReleaseCreationStrategy

    ChannelId string
    The ID of the channel to use for release creation.
    ReleaseCreationPackageStepId string
    The ID of the step containing the package for release creation.
    ReleaseCreationPackages List<GetProjectsProjectReleaseCreationStrategyReleaseCreationPackage>
    Details of the package used for release creation.
    ChannelId string
    The ID of the channel to use for release creation.
    ReleaseCreationPackageStepId string
    The ID of the step containing the package for release creation.
    ReleaseCreationPackages []GetProjectsProjectReleaseCreationStrategyReleaseCreationPackage
    Details of the package used for release creation.
    channelId String
    The ID of the channel to use for release creation.
    releaseCreationPackageStepId String
    The ID of the step containing the package for release creation.
    releaseCreationPackages List<GetProjectsProjectReleaseCreationStrategyReleaseCreationPackage>
    Details of the package used for release creation.
    channelId string
    The ID of the channel to use for release creation.
    releaseCreationPackageStepId string
    The ID of the step containing the package for release creation.
    releaseCreationPackages GetProjectsProjectReleaseCreationStrategyReleaseCreationPackage[]
    Details of the package used for release creation.
    channel_id str
    The ID of the channel to use for release creation.
    release_creation_package_step_id str
    The ID of the step containing the package for release creation.
    release_creation_packages Sequence[GetProjectsProjectReleaseCreationStrategyReleaseCreationPackage]
    Details of the package used for release creation.
    channelId String
    The ID of the channel to use for release creation.
    releaseCreationPackageStepId String
    The ID of the step containing the package for release creation.
    releaseCreationPackages List<Property Map>
    Details of the package used for release creation.

    GetProjectsProjectReleaseCreationStrategyReleaseCreationPackage

    DeploymentAction string
    The deployment action for the release creation package.
    PackageReference string
    The package reference for the release creation package.
    DeploymentAction string
    The deployment action for the release creation package.
    PackageReference string
    The package reference for the release creation package.
    deploymentAction String
    The deployment action for the release creation package.
    packageReference String
    The package reference for the release creation package.
    deploymentAction string
    The deployment action for the release creation package.
    packageReference string
    The package reference for the release creation package.
    deployment_action str
    The deployment action for the release creation package.
    package_reference str
    The package reference for the release creation package.
    deploymentAction String
    The deployment action for the release creation package.
    packageReference String
    The package reference for the release creation package.

    GetProjectsProjectServicenowExtensionSetting

    ConnectionId string
    The connection identifier for ServiceNow.
    IsEnabled bool
    Whether the ServiceNow extension is enabled.
    IsStateAutomaticallyTransitioned bool
    Whether state is automatically transitioned in ServiceNow.
    StandardChangeTemplateName string
    The name of the standard change template in ServiceNow.
    ConnectionId string
    The connection identifier for ServiceNow.
    IsEnabled bool
    Whether the ServiceNow extension is enabled.
    IsStateAutomaticallyTransitioned bool
    Whether state is automatically transitioned in ServiceNow.
    StandardChangeTemplateName string
    The name of the standard change template in ServiceNow.
    connectionId String
    The connection identifier for ServiceNow.
    isEnabled Boolean
    Whether the ServiceNow extension is enabled.
    isStateAutomaticallyTransitioned Boolean
    Whether state is automatically transitioned in ServiceNow.
    standardChangeTemplateName String
    The name of the standard change template in ServiceNow.
    connectionId string
    The connection identifier for ServiceNow.
    isEnabled boolean
    Whether the ServiceNow extension is enabled.
    isStateAutomaticallyTransitioned boolean
    Whether state is automatically transitioned in ServiceNow.
    standardChangeTemplateName string
    The name of the standard change template in ServiceNow.
    connection_id str
    The connection identifier for ServiceNow.
    is_enabled bool
    Whether the ServiceNow extension is enabled.
    is_state_automatically_transitioned bool
    Whether state is automatically transitioned in ServiceNow.
    standard_change_template_name str
    The name of the standard change template in ServiceNow.
    connectionId String
    The connection identifier for ServiceNow.
    isEnabled Boolean
    Whether the ServiceNow extension is enabled.
    isStateAutomaticallyTransitioned Boolean
    Whether state is automatically transitioned in ServiceNow.
    standardChangeTemplateName String
    The name of the standard change template in ServiceNow.

    GetProjectsProjectTemplate

    DefaultValue string
    The default value for the parameter.
    DisplaySettings Dictionary<string, string>
    The display settings for the parameter.
    HelpText string
    The help text for the parameter.
    Id string
    The ID of the template parameter.
    Label string
    The label shown beside the parameter.
    Name string
    The name of the variable set by the parameter.
    DefaultValue string
    The default value for the parameter.
    DisplaySettings map[string]string
    The display settings for the parameter.
    HelpText string
    The help text for the parameter.
    Id string
    The ID of the template parameter.
    Label string
    The label shown beside the parameter.
    Name string
    The name of the variable set by the parameter.
    defaultValue String
    The default value for the parameter.
    displaySettings Map<String,String>
    The display settings for the parameter.
    helpText String
    The help text for the parameter.
    id String
    The ID of the template parameter.
    label String
    The label shown beside the parameter.
    name String
    The name of the variable set by the parameter.
    defaultValue string
    The default value for the parameter.
    displaySettings {[key: string]: string}
    The display settings for the parameter.
    helpText string
    The help text for the parameter.
    id string
    The ID of the template parameter.
    label string
    The label shown beside the parameter.
    name string
    The name of the variable set by the parameter.
    default_value str
    The default value for the parameter.
    display_settings Mapping[str, str]
    The display settings for the parameter.
    help_text str
    The help text for the parameter.
    id str
    The ID of the template parameter.
    label str
    The label shown beside the parameter.
    name str
    The name of the variable set by the parameter.
    defaultValue String
    The default value for the parameter.
    displaySettings Map<String>
    The display settings for the parameter.
    helpText String
    The help text for the parameter.
    id String
    The ID of the template parameter.
    label String
    The label shown beside the parameter.
    name String
    The name of the variable set by the parameter.

    GetProjectsProjectVersioningStrategy

    DonorPackageStepId string
    The ID of the step containing the donor package.
    DonorPackages List<GetProjectsProjectVersioningStrategyDonorPackage>
    Template string
    The template to use for version numbers.
    DonorPackageStepId string
    The ID of the step containing the donor package.
    DonorPackages []GetProjectsProjectVersioningStrategyDonorPackage
    Template string
    The template to use for version numbers.
    donorPackageStepId String
    The ID of the step containing the donor package.
    donorPackages List<GetProjectsProjectVersioningStrategyDonorPackage>
    template String
    The template to use for version numbers.
    donorPackageStepId string
    The ID of the step containing the donor package.
    donorPackages GetProjectsProjectVersioningStrategyDonorPackage[]
    template string
    The template to use for version numbers.
    donor_package_step_id str
    The ID of the step containing the donor package.
    donor_packages Sequence[GetProjectsProjectVersioningStrategyDonorPackage]
    template str
    The template to use for version numbers.
    donorPackageStepId String
    The ID of the step containing the donor package.
    donorPackages List<Property Map>
    template String
    The template to use for version numbers.

    GetProjectsProjectVersioningStrategyDonorPackage

    DeploymentAction string
    The deployment action for the donor package.
    PackageReference string
    The package reference for the donor package.
    DeploymentAction string
    The deployment action for the donor package.
    PackageReference string
    The package reference for the donor package.
    deploymentAction String
    The deployment action for the donor package.
    packageReference String
    The package reference for the donor package.
    deploymentAction string
    The deployment action for the donor package.
    packageReference string
    The package reference for the donor package.
    deployment_action str
    The deployment action for the donor package.
    package_reference str
    The package reference for the donor package.
    deploymentAction String
    The deployment action for the donor package.
    packageReference String
    The package reference for the donor package.

    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