Get-BMRelease

NAME Get-BMRelease



SYNOPSIS

Gets the release for an application in BuildMaster.





SYNTAX

Get-BMRelease -Session <Object> [-Name <String>] [<CommonParameters>]



Get-BMRelease -Session <Object> -Release <Object> [-Name <String>] [<CommonParameters>]



Get-BMRelease -Session <Object> -Application <Object> [-Name <String>] [<CommonParameters>]





DESCRIPTION

The `Get-BMRelease` function gets releases in BuildMaster. It uses the [Release and Package Deployment

API](http://inedo.com/support/documentation/ ... nd-package).



To get a specific release, pass a release object, release ID, or release name to the `Release` parameter.



To get all the releases for a specific application, pass an application object, application ID, or application

name to the `Application` parameter. You can get a specific application's release by passing the release's name to

the `Name` parameter.





PARAMETERS

-Session <Object>

A session object that contains the settings to use to connect to BuildMaster. Use `New-BMSession` to create

session objects.



Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Release <Object>

The release to get. You can pass:



* A release object. It must have either an `id` or `name` property.

* The release ID as an integer.

* The release name as a string.



Required? true

Position? named

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-Application <Object>

The application whose releases to get. You can pass:



* An application object. It must have `Application_Id`, `id`, `Application_Name`, or `name` properties.

* The application ID as an integer.

* The application name as a string.



Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Name <String>

The name of the release to get.



Required? false

Position? named

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:\\>Get-BMRelease -Session $session -Release $release



Demonstrates how to get a specific release by passing a release object to the `Release` parameter. The

`Get-BMRelease` function looks for an `id` or `name` property on the object.









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



PS C:\\>Get-BMRelease -Session $session -Application $app



Demonstrates how to get all the releases for an application by passing an application object to the `Application`

parameter. The application object must have a`Application_Id`, `id`, `Application_Name`, or `name` properties.









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



PS C:\\>Get-BMRelease -Session $session -Application 34



Demonstrates how to get all the releases for an application by passing its ID to the `Application` parameter.









-------------------------- EXAMPLE 4 --------------------------



PS C:\\>Get-BMRelease -Session $session -Application 'BuildMasterAutomation'



Demonstrates how to get all the releases for an application by passing its name to the `Application` parameter.









-------------------------- EXAMPLE 5 --------------------------



PS C:\\>Get-BMRelease -Session $session -Application 'BuildMasterAutomation' -Name '4.1'



Demonstrates how to get a specific release for an application by passing the release's name to the `Name`

parameter. In this example, the '4.1' release will be returned, if it exists.











RELATED LINKS