Get-OctopusProject

NAME Get-OctopusProject



SYNOPSIS

This cmdlet returns info about Octopus Projects





SYNTAX

Get-OctopusProject [[-ProjectName] <string[]>] [-ResourceOnly <SwitchParameter>] [<CommonParameters>]



Get-OctopusProject [[-ProjectGroupName] <string[]>] [-ResourceOnly <SwitchParameter>] [<CommonParameters>]





DESCRIPTION

This cmdlet returns info about Octopus Projects





PARAMETERS

-ProjectName <string[]>

Project name



Required? false

Position? 1

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-Name <string[]>

Project name



This is an alias of the ProjectName parameter.



Required? false

Position? 1

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-ProjectGroupName <string[]>

Gets all projects inside a set of Project Groups



Required? false

Position? 1

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-ProjectGroup <string[]>

Gets all projects inside a set of Project Groups



This is an alias of the ProjectGroupName parameter.



Required? false

Position? 1

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-ResourceOnly <SwitchParameter>

If set to TRUE the cmdlet will return the basic Octopus resource. If not set or set to FALSE, the cmdlet will

return a human friendly Octoposh output object



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

System.String[]

Project name



System.String[]

Gets all projects inside a set of Project Groups





OUTPUTS

System.Collections.Generic.List`1[[Octoposh.Model.OutputOctopusProject, Octoposh, Version=1.0.0.0,

Culture=neutral, PublicKeyToken=null]]



System.Collections.Generic.List`1[[Octopus.Client.Model.ProjectResource, Octopus.Client, Version=4.22.0.0,

Culture=neutral, PublicKeyToken=null]]





---------- EXAMPLE 1 ----------



PS C:\\> Get-OctopusProject



Gets all the projects of the current Instance

---------- EXAMPLE 2 ----------



PS C:\\> Get-OctopusProject -name MyProject



Get the project named "MyProject"

---------- EXAMPLE 3 ----------



PS C:\\> Get-OctopusProject -name MyApp*



Get all the projects whose name starts with the string "MyApp"

---------- EXAMPLE 4 ----------



PS C:\\> Get-OctopusProject -ProjectGroupName "MyProduct"



Gets all the projects inside of the Project Group "MyProduct"



RELATED LINKS

WebSite: http://Octoposh.net

Github Project: https://github.com/Dalmirog/OctoPosh/

Wiki: http://octoposh.readthedocs.io

QA and Feature requests: https://gitter.im/Dalmirog/OctoPosh#initial