octopusdeploy 0.43.1 published on Wednesday, Apr 30, 2025 by octopusdeploylabs
octopusdeploy.getProjects
Explore with Pulumi AI
octopusdeploy 0.43.1 published on Wednesday, Apr 30, 2025 by octopusdeploylabs
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 dictionaryThe following arguments are supported:
- ClonedFrom stringProject Id 
- 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.
- ClonedFrom stringProject Id 
- 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.
- clonedFrom StringProject Id 
- 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.
- clonedFrom stringProject Id 
- 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_ strproject_ id 
- 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.
- clonedFrom StringProject Id 
- 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<GetProjects Project> 
- A list of projects that match the filter(s).
- ClonedFrom stringProject Id 
- 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
[]GetProjects Project 
- A list of projects that match the filter(s).
- ClonedFrom stringProject Id 
- 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<GetProjects Project> 
- A list of projects that match the filter(s).
- clonedFrom StringProject Id 
- 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
GetProjects Project[] 
- A list of projects that match the filter(s).
- clonedFrom stringProject Id 
- 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[GetProjects Project] 
- A list of projects that match the filter(s).
- cloned_from_ strproject_ id 
- 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).
- clonedFrom StringProject Id 
- 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  
- AllowDeployments boolTo No Targets 
- AutoCreate boolRelease 
- AutoDeploy List<GetRelease Overrides Projects Project Auto Deploy Release Override> 
- ClonedFrom stringProject Id 
- ConnectivityPolicies List<GetProjects Project Connectivity Policy> 
- DefaultGuided stringFailure Mode 
- DefaultTo boolSkip If Already Installed 
- DeploymentChanges stringTemplate 
- DeploymentProcess stringId 
- Description string
- The description of this project
- DiscreteChannel boolRelease 
- Treats releases of different channels to the same environment as a separate deployment dimension
- GitAnonymous List<GetPersistence Settings Projects Project Git Anonymous Persistence Setting> 
- Git-related persistence settings for a version-controlled project using anonymous authentication.
- GitLibrary List<GetPersistence Settings Projects Project Git Library Persistence Setting> 
- Git-related persistence settings for a version-controlled project using library authentication.
- GitUsername List<GetPassword Persistence Settings Projects Project Git Username Password Persistence Setting> 
- Git-related persistence settings for a version-controlled project using username*password authentication.
- Id string
- IncludedLibrary List<string>Variable Sets 
- IsDisabled bool
- IsDiscrete boolChannel Release 
- IsVersion boolControlled 
- JiraService List<GetManagement Extension Settings Projects Project Jira Service Management Extension Setting> 
- 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.
- ProjectGroup stringId 
- The project group ID associated with this project.
- ReleaseCreation List<GetStrategies Projects Project Release Creation Strategy> 
- The release creation strategy for the project.
- ReleaseNotes stringTemplate 
- The template to use for release notes.
- ServicenowExtension List<GetSettings Projects Project Servicenow Extension Setting> 
- 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<GetProjects Project Template> 
- Template parameters for the project.
- TenantedDeployment stringParticipation 
- The tenanted deployment mode of the project.
- VariableSet stringId 
- The ID of the variable set associated with this project.
- VersioningStrategies List<GetProjects Project Versioning Strategy> 
- The versioning strategy for the project.
- AllowDeployments boolTo No Targets 
- AutoCreate boolRelease 
- AutoDeploy []GetRelease Overrides Projects Project Auto Deploy Release Override 
- ClonedFrom stringProject Id 
- ConnectivityPolicies []GetProjects Project Connectivity Policy 
- DefaultGuided stringFailure Mode 
- DefaultTo boolSkip If Already Installed 
- DeploymentChanges stringTemplate 
- DeploymentProcess stringId 
- Description string
- The description of this project
- DiscreteChannel boolRelease 
- Treats releases of different channels to the same environment as a separate deployment dimension
- GitAnonymous []GetPersistence Settings Projects Project Git Anonymous Persistence Setting 
- Git-related persistence settings for a version-controlled project using anonymous authentication.
- GitLibrary []GetPersistence Settings Projects Project Git Library Persistence Setting 
- Git-related persistence settings for a version-controlled project using library authentication.
- GitUsername []GetPassword Persistence Settings Projects Project Git Username Password Persistence Setting 
- Git-related persistence settings for a version-controlled project using username*password authentication.
- Id string
- IncludedLibrary []stringVariable Sets 
- IsDisabled bool
- IsDiscrete boolChannel Release 
- IsVersion boolControlled 
- JiraService []GetManagement Extension Settings Projects Project Jira Service Management Extension Setting 
- 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.
- ProjectGroup stringId 
- The project group ID associated with this project.
- ReleaseCreation []GetStrategies Projects Project Release Creation Strategy 
- The release creation strategy for the project.
- ReleaseNotes stringTemplate 
- The template to use for release notes.
- ServicenowExtension []GetSettings Projects Project Servicenow Extension Setting 
- 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
[]GetProjects Project Template 
- Template parameters for the project.
- TenantedDeployment stringParticipation 
- The tenanted deployment mode of the project.
- VariableSet stringId 
- The ID of the variable set associated with this project.
- VersioningStrategies []GetProjects Project Versioning Strategy 
- The versioning strategy for the project.
- allowDeployments BooleanTo No Targets 
- autoCreate BooleanRelease 
- autoDeploy List<GetRelease Overrides Projects Project Auto Deploy Release Override> 
- clonedFrom StringProject Id 
- connectivityPolicies List<GetProjects Project Connectivity Policy> 
- defaultGuided StringFailure Mode 
- defaultTo BooleanSkip If Already Installed 
- deploymentChanges StringTemplate 
- deploymentProcess StringId 
- description String
- The description of this project
- discreteChannel BooleanRelease 
- Treats releases of different channels to the same environment as a separate deployment dimension
- gitAnonymous List<GetPersistence Settings Projects Project Git Anonymous Persistence Setting> 
- Git-related persistence settings for a version-controlled project using anonymous authentication.
- gitLibrary List<GetPersistence Settings Projects Project Git Library Persistence Setting> 
- Git-related persistence settings for a version-controlled project using library authentication.
- gitUsername List<GetPassword Persistence Settings Projects Project Git Username Password Persistence Setting> 
- Git-related persistence settings for a version-controlled project using username*password authentication.
- id String
- includedLibrary List<String>Variable Sets 
- isDisabled Boolean
- isDiscrete BooleanChannel Release 
- isVersion BooleanControlled 
- jiraService List<GetManagement Extension Settings Projects Project Jira Service Management Extension Setting> 
- 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.
- projectGroup StringId 
- The project group ID associated with this project.
- releaseCreation List<GetStrategies Projects Project Release Creation Strategy> 
- The release creation strategy for the project.
- releaseNotes StringTemplate 
- The template to use for release notes.
- servicenowExtension List<GetSettings Projects Project Servicenow Extension Setting> 
- 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<GetProjects Project Template> 
- Template parameters for the project.
- tenantedDeployment StringParticipation 
- The tenanted deployment mode of the project.
- variableSet StringId 
- The ID of the variable set associated with this project.
- versioningStrategies List<GetProjects Project Versioning Strategy> 
- The versioning strategy for the project.
- allowDeployments booleanTo No Targets 
- autoCreate booleanRelease 
- autoDeploy GetRelease Overrides Projects Project Auto Deploy Release Override[] 
- clonedFrom stringProject Id 
- connectivityPolicies GetProjects Project Connectivity Policy[] 
- defaultGuided stringFailure Mode 
- defaultTo booleanSkip If Already Installed 
- deploymentChanges stringTemplate 
- deploymentProcess stringId 
- description string
- The description of this project
- discreteChannel booleanRelease 
- Treats releases of different channels to the same environment as a separate deployment dimension
- gitAnonymous GetPersistence Settings Projects Project Git Anonymous Persistence Setting[] 
- Git-related persistence settings for a version-controlled project using anonymous authentication.
- gitLibrary GetPersistence Settings Projects Project Git Library Persistence Setting[] 
- Git-related persistence settings for a version-controlled project using library authentication.
- gitUsername GetPassword Persistence Settings Projects Project Git Username Password Persistence Setting[] 
- Git-related persistence settings for a version-controlled project using username*password authentication.
- id string
- includedLibrary string[]Variable Sets 
- isDisabled boolean
- isDiscrete booleanChannel Release 
- isVersion booleanControlled 
- jiraService GetManagement Extension Settings Projects Project Jira Service Management Extension Setting[] 
- 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.
- projectGroup stringId 
- The project group ID associated with this project.
- releaseCreation GetStrategies Projects Project Release Creation Strategy[] 
- The release creation strategy for the project.
- releaseNotes stringTemplate 
- The template to use for release notes.
- servicenowExtension GetSettings Projects Project Servicenow Extension Setting[] 
- 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
GetProjects Project Template[] 
- Template parameters for the project.
- tenantedDeployment stringParticipation 
- The tenanted deployment mode of the project.
- variableSet stringId 
- The ID of the variable set associated with this project.
- versioningStrategies GetProjects Project Versioning Strategy[] 
- The versioning strategy for the project.
- allow_deployments_ boolto_ no_ targets 
- auto_create_ boolrelease 
- auto_deploy_ Sequence[Getrelease_ overrides Projects Project Auto Deploy Release Override] 
- cloned_from_ strproject_ id 
- connectivity_policies Sequence[GetProjects Project Connectivity Policy] 
- default_guided_ strfailure_ mode 
- default_to_ boolskip_ if_ already_ installed 
- deployment_changes_ strtemplate 
- deployment_process_ strid 
- description str
- The description of this project
- discrete_channel_ boolrelease 
- Treats releases of different channels to the same environment as a separate deployment dimension
- git_anonymous_ Sequence[Getpersistence_ settings Projects Project Git Anonymous Persistence Setting] 
- Git-related persistence settings for a version-controlled project using anonymous authentication.
- git_library_ Sequence[Getpersistence_ settings Projects Project Git Library Persistence Setting] 
- Git-related persistence settings for a version-controlled project using library authentication.
- git_username_ Sequence[Getpassword_ persistence_ settings Projects Project Git Username Password Persistence Setting] 
- Git-related persistence settings for a version-controlled project using username*password authentication.
- id str
- included_library_ Sequence[str]variable_ sets 
- is_disabled bool
- is_discrete_ boolchannel_ release 
- is_version_ boolcontrolled 
- jira_service_ Sequence[Getmanagement_ extension_ settings Projects Project Jira Service Management Extension Setting] 
- 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_ strid 
- The project group ID associated with this project.
- release_creation_ Sequence[Getstrategies Projects Project Release Creation Strategy] 
- The release creation strategy for the project.
- release_notes_ strtemplate 
- The template to use for release notes.
- servicenow_extension_ Sequence[Getsettings Projects Project Servicenow Extension Setting] 
- 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[GetProjects Project Template] 
- Template parameters for the project.
- tenanted_deployment_ strparticipation 
- The tenanted deployment mode of the project.
- variable_set_ strid 
- The ID of the variable set associated with this project.
- versioning_strategies Sequence[GetProjects Project Versioning Strategy] 
- The versioning strategy for the project.
- allowDeployments BooleanTo No Targets 
- autoCreate BooleanRelease 
- autoDeploy List<Property Map>Release Overrides 
- clonedFrom StringProject Id 
- connectivityPolicies List<Property Map>
- defaultGuided StringFailure Mode 
- defaultTo BooleanSkip If Already Installed 
- deploymentChanges StringTemplate 
- deploymentProcess StringId 
- description String
- The description of this project
- discreteChannel BooleanRelease 
- Treats releases of different channels to the same environment as a separate deployment dimension
- gitAnonymous List<Property Map>Persistence Settings 
- Git-related persistence settings for a version-controlled project using anonymous authentication.
- gitLibrary List<Property Map>Persistence Settings 
- Git-related persistence settings for a version-controlled project using library authentication.
- gitUsername List<Property Map>Password Persistence Settings 
- Git-related persistence settings for a version-controlled project using username*password authentication.
- id String
- includedLibrary List<String>Variable Sets 
- isDisabled Boolean
- isDiscrete BooleanChannel Release 
- isVersion BooleanControlled 
- jiraService List<Property Map>Management Extension Settings 
- 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.
- projectGroup StringId 
- The project group ID associated with this project.
- releaseCreation List<Property Map>Strategies 
- The release creation strategy for the project.
- releaseNotes StringTemplate 
- The template to use for release notes.
- servicenowExtension List<Property Map>Settings 
- 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.
- tenantedDeployment StringParticipation 
- The tenanted deployment mode of the project.
- variableSet StringId 
- 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    
- AllowDeployments boolTo No Targets 
- Allow deployments to be created when there are no targets.
- ExcludeUnhealthy boolTargets 
- Exclude unhealthy targets from deployments.
- SkipMachine stringBehavior 
- The behavior when a machine is skipped.
- TargetRoles List<string>
- The target roles for the connectivity policy.
- AllowDeployments boolTo No Targets 
- Allow deployments to be created when there are no targets.
- ExcludeUnhealthy boolTargets 
- Exclude unhealthy targets from deployments.
- SkipMachine stringBehavior 
- The behavior when a machine is skipped.
- TargetRoles []string
- The target roles for the connectivity policy.
- allowDeployments BooleanTo No Targets 
- Allow deployments to be created when there are no targets.
- excludeUnhealthy BooleanTargets 
- Exclude unhealthy targets from deployments.
- skipMachine StringBehavior 
- The behavior when a machine is skipped.
- targetRoles List<String>
- The target roles for the connectivity policy.
- allowDeployments booleanTo No Targets 
- Allow deployments to be created when there are no targets.
- excludeUnhealthy booleanTargets 
- Exclude unhealthy targets from deployments.
- skipMachine stringBehavior 
- The behavior when a machine is skipped.
- targetRoles string[]
- The target roles for the connectivity policy.
- allow_deployments_ boolto_ no_ targets 
- Allow deployments to be created when there are no targets.
- exclude_unhealthy_ booltargets 
- Exclude unhealthy targets from deployments.
- skip_machine_ strbehavior 
- The behavior when a machine is skipped.
- target_roles Sequence[str]
- The target roles for the connectivity policy.
- allowDeployments BooleanTo No Targets 
- Allow deployments to be created when there are no targets.
- excludeUnhealthy BooleanTargets 
- Exclude unhealthy targets from deployments.
- skipMachine StringBehavior 
- 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.
- GitCredential stringId 
- 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.
- GitCredential stringId 
- 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.
- gitCredential StringId 
- 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.
- gitCredential stringId 
- 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_ strid 
- 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.
- gitCredential StringId 
- 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.
- ServiceDesk stringProject Name 
- The JSM service desk project name.
- ConnectionId string
- The connection identifier for JSM.
- IsEnabled bool
- Whether the JSM extension is enabled.
- ServiceDesk stringProject Name 
- The JSM service desk project name.
- connectionId String
- The connection identifier for JSM.
- isEnabled Boolean
- Whether the JSM extension is enabled.
- serviceDesk StringProject Name 
- The JSM service desk project name.
- connectionId string
- The connection identifier for JSM.
- isEnabled boolean
- Whether the JSM extension is enabled.
- serviceDesk stringProject Name 
- 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_ strproject_ name 
- The JSM service desk project name.
- connectionId String
- The connection identifier for JSM.
- isEnabled Boolean
- Whether the JSM extension is enabled.
- serviceDesk StringProject Name 
- The JSM service desk project name.
GetProjectsProjectReleaseCreationStrategy     
- ChannelId string
- The ID of the channel to use for release creation.
- ReleaseCreation stringPackage Step Id 
- The ID of the step containing the package for release creation.
- ReleaseCreation List<GetPackages Projects Project Release Creation Strategy Release Creation Package> 
- Details of the package used for release creation.
- ChannelId string
- The ID of the channel to use for release creation.
- ReleaseCreation stringPackage Step Id 
- The ID of the step containing the package for release creation.
- ReleaseCreation []GetPackages Projects Project Release Creation Strategy Release Creation Package 
- Details of the package used for release creation.
- channelId String
- The ID of the channel to use for release creation.
- releaseCreation StringPackage Step Id 
- The ID of the step containing the package for release creation.
- releaseCreation List<GetPackages Projects Project Release Creation Strategy Release Creation Package> 
- Details of the package used for release creation.
- channelId string
- The ID of the channel to use for release creation.
- releaseCreation stringPackage Step Id 
- The ID of the step containing the package for release creation.
- releaseCreation GetPackages Projects Project Release Creation Strategy Release Creation Package[] 
- Details of the package used for release creation.
- channel_id str
- The ID of the channel to use for release creation.
- release_creation_ strpackage_ step_ id 
- The ID of the step containing the package for release creation.
- release_creation_ Sequence[Getpackages Projects Project Release Creation Strategy Release Creation Package] 
- Details of the package used for release creation.
- channelId String
- The ID of the channel to use for release creation.
- releaseCreation StringPackage Step Id 
- The ID of the step containing the package for release creation.
- releaseCreation List<Property Map>Packages 
- 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.
- IsState boolAutomatically Transitioned 
- Whether state is automatically transitioned in ServiceNow.
- StandardChange stringTemplate Name 
- The name of the standard change template in ServiceNow.
- ConnectionId string
- The connection identifier for ServiceNow.
- IsEnabled bool
- Whether the ServiceNow extension is enabled.
- IsState boolAutomatically Transitioned 
- Whether state is automatically transitioned in ServiceNow.
- StandardChange stringTemplate Name 
- The name of the standard change template in ServiceNow.
- connectionId String
- The connection identifier for ServiceNow.
- isEnabled Boolean
- Whether the ServiceNow extension is enabled.
- isState BooleanAutomatically Transitioned 
- Whether state is automatically transitioned in ServiceNow.
- standardChange StringTemplate Name 
- The name of the standard change template in ServiceNow.
- connectionId string
- The connection identifier for ServiceNow.
- isEnabled boolean
- Whether the ServiceNow extension is enabled.
- isState booleanAutomatically Transitioned 
- Whether state is automatically transitioned in ServiceNow.
- standardChange stringTemplate Name 
- 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_ boolautomatically_ transitioned 
- Whether state is automatically transitioned in ServiceNow.
- standard_change_ strtemplate_ name 
- The name of the standard change template in ServiceNow.
- connectionId String
- The connection identifier for ServiceNow.
- isEnabled Boolean
- Whether the ServiceNow extension is enabled.
- isState BooleanAutomatically Transitioned 
- Whether state is automatically transitioned in ServiceNow.
- standardChange StringTemplate Name 
- 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    
- DonorPackage stringStep Id 
- The ID of the step containing the donor package.
- DonorPackages List<GetProjects Project Versioning Strategy Donor Package> 
- Template string
- The template to use for version numbers.
- DonorPackage stringStep Id 
- The ID of the step containing the donor package.
- DonorPackages []GetProjects Project Versioning Strategy Donor Package 
- Template string
- The template to use for version numbers.
- donorPackage StringStep Id 
- The ID of the step containing the donor package.
- donorPackages List<GetProjects Project Versioning Strategy Donor Package> 
- template String
- The template to use for version numbers.
- donorPackage stringStep Id 
- The ID of the step containing the donor package.
- donorPackages GetProjects Project Versioning Strategy Donor Package[] 
- template string
- The template to use for version numbers.
- donor_package_ strstep_ id 
- The ID of the step containing the donor package.
- donor_packages Sequence[GetProjects Project Versioning Strategy Donor Package] 
- template str
- The template to use for version numbers.
- donorPackage StringStep Id 
- 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 octopusdeployTerraform Provider.
octopusdeploy 0.43.1 published on Wednesday, Apr 30, 2025 by octopusdeploylabs