Stop-BMRelease

NAME Stop-BMRelease



SYNOPSIS

Cancels a release.





SYNTAX

Stop-BMRelease [-Session] <Object> [-ApplicationID] <Int32> [-Number] <String> [[-Reason] <String>]

[<CommonParameters>]





DESCRIPTION

The `Stop-BMRelease` function cancels a BuildMaster release. It calls the `Releases_CancelRelease` native API

endpoint.





PARAMETERS

-Session <Object>

The session to use when connecting to BuildMaster. Use `New-BMSession` to create session objects.



Required? true

Position? 1

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ApplicationID <Int32>

The ID of the application whose release should be cancelled.



Required? true

Position? 2

Default value 0

Accept pipeline input? false

Accept wildcard characters? false



-Number <String>

The release number, e.g. 1, 2, 3, 1.0, 2.0, etc.



Required? true

Position? 3

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Reason <String>

The reason for cancelling the release.



Required? false

Position? 4

Default value

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



OUTPUTS



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



PS C:\\>Stop-BMRelease -Session $session -Application 11 -Number 1.1



Demonstrates how to cancel a release. In this case, the `1.1` release of the application whose ID is `11` is

cancelled.









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



PS C:\\>Stop-BMRelease -Session $session -Application 'BuildMaster Automation' -Number 1.1



Demonstrates how to cancel a release. In this case, the `1.1` release of the `BuildMaster Automation` application

is cancelled.











RELATED LINKS