< Back

Get-OctopusProjectGroup

Sat Jan 18, 2020 5:29 pm

NAME Get-OctopusProjectGroup



SYNOPSIS

Gets information about Octopus Project Groups





SYNTAX

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





DESCRIPTION

Gets information about Octopus Project Groups





PARAMETERS

-ProjectGroupName <string[]>

Project Group name



Required? false

Position? 1

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-Name <string[]>

Project Group name



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 Group name





OUTPUTS

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

Culture=neutral, PublicKeyToken=null]]



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

Culture=neutral, PublicKeyToken=null]]





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



PS C:\\> Get-OctopusProjectGroup



Gets all the Project Groups on the Octopus instance

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



PS C:\\> Get-OctopusProjectGroup -name "MyProjects"



Gets a Project Group named "MyProjects"

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



PS C:\\> Get-OctopusProjectGroup -name "*web*"



Get all the projects whose name matches the pattern "*web*"



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