Set-OctopusReleaseStatus

NAME Set-OctopusReleaseStatus



SYNOPSIS

Blocks or unblocks releases.





SYNTAX

Set-OctopusReleaseStatus [-ReleaseVersion] <List`1> [-ProjectName] <string> [-Status] <string> [[-Description]

<string>] [<CommonParameters>]



Set-OctopusReleaseStatus [-Resource] <List`1> [-Status] <string> [[-Description] <string>] [<CommonParameters>]





DESCRIPTION





PARAMETERS

-ProjectName <string>

Project name



Required? true

Position? 1

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-ReleaseVersion <List`1>

Releases to Block/Unblock



Required? true

Position? 0

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-Description <string>

Reason to block the deployment



Required? false

Position? 3

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Reason <string>

Reason to block the deployment



This is an alias of the Description parameter.



Required? false

Position? 3

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Status <string>

Status that the release will be put into



Required? true

Position? 2

Default value

Accept pipeline input? false

Accept wildcard characters? false



-State <string>

Status that the release will be put into



This is an alias of the Status parameter.



Required? true

Position? 2

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Resource <List`1>

List of [Octopus.Model.ReleaseResource] objects that will get blocked/unblocked. By using this parameter you

do not need to pass values to "ProjectName" or "ReleaseVersion", as that info will already be available in the

Release object



Required? true

Position? 1

Default value

Accept pipeline input? true (ByValue)

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.Collections.Generic.List`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral,

PublicKeyToken=b77a5c561934e089]]

Releases to Block/Unblock



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

Culture=neutral, PublicKeyToken=null]]

List of [Octopus.Model.ReleaseResource] objects that will get blocked/unblocked. By using this parameter you

do not need to pass values to "ProjectName" or "ReleaseVersion", as that info will already be available in the

Release object





OUTPUTS



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



PS C:\\> Set-OctopusReleaseStatus -ProjectName MyProject -ReleaseVersion 1.0.0 -state Blocked -Description "Because

of reasons"



Blocks the release [1.0.0] from the project [MyProject] from being deployed with the reason ["Because of reasons"]

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



PS C:\\> Set-OctopusReleaseStatus -ProjectName MyProject -ReleaseVersion 1.0.0, 2.0.0 -Description "Because of

reasons"



Blocks the releases [1.0.0],[2.0.0] from the project [MyProject] from being deployed with the reson ["Because of

reasons"]

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



PS C:\\> Set-OctopusReleaseStatus-ProjectName MyProject -ReleaseVersion 1.0.0 -state Unblocked



Unblocks release [1.0.0] from 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