< Back
Set-BMRelease
Post
NAME Set-BMRelease
SYNOPSIS
Updates a release's pipeline or name.
SYNTAX
Set-BMRelease -Session <Object> -Release <Object> [-PipelineID <Int32>] [-Name <String>] [<CommonParameters>]
DESCRIPTION
The `Set-BMRelease` function updates a release's pipeline or name. To change a release's pipeline, pass the
pipeline's ID to the `PipelineID` parameter. To change the pipeline's name, pass the new name to the `Name`
parameter.
This function uses the BuildMaster native API endpoint "Releases_CreateOrUpdateRelease".
Pass the release you want to update to the `Release` parameter. You may pass the release's ID (as an integer), the
release's number, or a release object as returned by the `Get-BMRelease` function.
PARAMETERS
-Session <Object>
An object that represents what BuildMaster instance to connect to and what API key to use. Use `New-BMSession`
to create a session object.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Release <Object>
The release to update. Can be:
* The release's number.
* The release's ID.
* An release object with either a `Release_Id` or `Release_Name` property that represent the application's ID
and name, respectively.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-PipelineID <Int32>
The ID of the release's new pipeline.
Required? false
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-Name <String>
The new name of the release.
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:\\>Set-BMRelease -Session $session -Release $release -PipelineID 45 -Name 'My New Name'
Demonstrates how to update the pipeline and name of a release.
RELATED LINKS
SYNOPSIS
Updates a release's pipeline or name.
SYNTAX
Set-BMRelease -Session <Object> -Release <Object> [-PipelineID <Int32>] [-Name <String>] [<CommonParameters>]
DESCRIPTION
The `Set-BMRelease` function updates a release's pipeline or name. To change a release's pipeline, pass the
pipeline's ID to the `PipelineID` parameter. To change the pipeline's name, pass the new name to the `Name`
parameter.
This function uses the BuildMaster native API endpoint "Releases_CreateOrUpdateRelease".
Pass the release you want to update to the `Release` parameter. You may pass the release's ID (as an integer), the
release's number, or a release object as returned by the `Get-BMRelease` function.
PARAMETERS
-Session <Object>
An object that represents what BuildMaster instance to connect to and what API key to use. Use `New-BMSession`
to create a session object.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Release <Object>
The release to update. Can be:
* The release's number.
* The release's ID.
* An release object with either a `Release_Id` or `Release_Name` property that represent the application's ID
and name, respectively.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-PipelineID <Int32>
The ID of the release's new pipeline.
Required? false
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-Name <String>
The new name of the release.
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:\\>Set-BMRelease -Session $session -Release $release -PipelineID 45 -Name 'My New Name'
Demonstrates how to update the pipeline and name of a release.
RELATED LINKS