Set OctopusReleaseStatus

Summary

Parameters

Name	DataType	Description
ProjectName	System.String	Project name
ReleaseVersion	System.Collections.Generic.List`1System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089	Releases to Block/Unblock
Description	System.String	Reason to block the deployment
Reason	System.String	Reason to block the deployment This is an alias of the Description parameter.
Status	System.String	Status that the release will be put into
State	System.String	Status that the release will be put into This is an alias of the Status parameter.
Resource	System.Collections.Generic.List`1Octopus.Client.Model.ReleaseResource, Octopus.Client, Version=4.5.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

Syntax

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

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

Examples

EXAMPLE 1

Blocks the release [1.0.0] from the project [MyProject] from being deployed with the reson ["Because of reasons"]. Using the "ProjectName" parameter allows you to only block releases in one project at a time. For multiple releases check usage of parameter "Resource"

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

EXAMPLE 2

Blocks the releasse [1.0.0],[2.0.0] from the project [MyProject] from being deployed with the reson ["Because of reasons"]. Using the "ProjectName" parameter allows you to only block releases in one project at a time. For multiple releases check usage of parameter "Resource"

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

EXAMPLE 3

Blocks all the releases

PS C:\>PS C:\> Set-OctopusReleaseStatus -Resource $ReleaseResource -Description