Get-OctopusRelease

NAME Get-OctopusRelease



SYNOPSIS

Gets information about Octopus Releases





SYNTAX

Get-OctopusRelease [-ProjectName] <string> [[-ReleaseVersion] <string[]>] [-ResourceOnly <SwitchParameter>]

[<CommonParameters>]



Get-OctopusRelease [-ProjectName] <string> [-Latest <int>] [-ResourceOnly <SwitchParameter>] [<CommonParameters>]





DESCRIPTION

Gets information about Octopus Releases





PARAMETERS

-ReleaseVersion <string[]>

Release version number



Required? false

Position? 2

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Version <string[]>

Release version number



This is an alias of the ReleaseVersion parameter.



Required? false

Position? 2

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Release <string[]>

Release version number



This is an alias of the ReleaseVersion parameter.



Required? false

Position? 2

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ProjectName <string>

Name of project to filter releases. Only one Project can be passed to this parameter at a time



Required? true

Position? 1

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-Project <string>

Name of project to filter releases. Only one Project can be passed to this parameter at a time



This is an alias of the ProjectName parameter.



Required? true

Position? 1

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-Latest <int>

Get latest X releases



Required? false

Position? named

Default value 0

Accept pipeline input? false

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

Name of project to filter releases. Only one Project can be passed to this parameter at a time





OUTPUTS

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

Culture=neutral, PublicKeyToken=null]]



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

Culture=neutral, PublicKeyToken=null]]





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



PS C:\\> Get-OctopusRelease -ProjectName "MyProject"



Get all the realeases of the project "MyProject"

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



PS C:\\> Get-OctopusRelease -ProjectName "MyProject" -version 1.0.1,1.0.2



Get the release realeases 1.0.1 & 1.0.2 of the project "MyProject"

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



PS C:\\> Get-OctopusRelease -ProjectName "MyProject" -Latest 10



Get the latest 10 releases of the project "MyProject"



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