< Back
New-BMPipeline
Post
NAME New-BMPipeline
SYNOPSIS
Creates a new pipeline in BuildMaster.
SYNTAX
New-BMPipeline [-Session] <Object> [-Name] <String> [[-Application] <Object>] [[-Color] <String>] [[-Stage]
<String[]>] [<CommonParameters>]
DESCRIPTION
The `New-BMPipeline` function creates a new pipeline in BuildMaster and retuns an object representing the new
pipeline. In order to deploy an application, you must create a release for that application. Each release gets
assigned a pipeline, which are the set of steps to do when releasing and deploying. Pipelines can belong to a
specific application or shared between applications.
The pipeline is created with no stages. The following settings are enabled:
* Enforce pipeline stage order for deployments
The following settings are disabled:
* Cancel earlier (lower-sequenced) releases that are still active and have not yet been deployed.
* Create a new release by incrementing the final part after a release has been deployed.
* Mark the release and package as deployed once it reaches the final stage.
This function uses [BuildMaster's native
API](http://inedo.com/support/documentation/ ... api/native).
PARAMETERS
-Session <Object>
An object that represents the instance of BuildMaster to connect to. Use the `New-BMSession` function to
creates a session object.
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Name <String>
The name of the pipeline.
Required? true
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Application <Object>
The application to assign the pipeline to. Can be:
* An application object with `Application_Id`, `id`, `Application_Name`, or `name` properties.
* An application ID (must be an integer)
* An applicatoin name (must be a string)
Required? false
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Color <String>
The background color BuildMaster should use when displaying the pipeline's name in the UI. Should be a CSS
hexadecimal color, e.g. `#ffffff`
Required? false
Position? 4
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Stage <String[]>
Stage configuration for the pipeline. Should be an array of `<Inedo.BuildMaster.Pipelines.PipelineStage>` XML
elements.
Required? false
Position? 5
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:\\>New-BMPipeline -Session $session -Name 'Powershell Module'
Demonstrates how to create a new pipeline that is not used by any applications. In this example a pipeline named
`PowerShell Module` will be created.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>New-BMPipeline -Session $session -Name 'PowerShell Module' -Application $app
Demonstrates how to create a new pipeline and assign it to a specific application. In this example, the pipeline
will be called `PowerShell Module` and it will be assigned to the `$app` application.
RELATED LINKS
SYNOPSIS
Creates a new pipeline in BuildMaster.
SYNTAX
New-BMPipeline [-Session] <Object> [-Name] <String> [[-Application] <Object>] [[-Color] <String>] [[-Stage]
<String[]>] [<CommonParameters>]
DESCRIPTION
The `New-BMPipeline` function creates a new pipeline in BuildMaster and retuns an object representing the new
pipeline. In order to deploy an application, you must create a release for that application. Each release gets
assigned a pipeline, which are the set of steps to do when releasing and deploying. Pipelines can belong to a
specific application or shared between applications.
The pipeline is created with no stages. The following settings are enabled:
* Enforce pipeline stage order for deployments
The following settings are disabled:
* Cancel earlier (lower-sequenced) releases that are still active and have not yet been deployed.
* Create a new release by incrementing the final part after a release has been deployed.
* Mark the release and package as deployed once it reaches the final stage.
This function uses [BuildMaster's native
API](http://inedo.com/support/documentation/ ... api/native).
PARAMETERS
-Session <Object>
An object that represents the instance of BuildMaster to connect to. Use the `New-BMSession` function to
creates a session object.
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Name <String>
The name of the pipeline.
Required? true
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Application <Object>
The application to assign the pipeline to. Can be:
* An application object with `Application_Id`, `id`, `Application_Name`, or `name` properties.
* An application ID (must be an integer)
* An applicatoin name (must be a string)
Required? false
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Color <String>
The background color BuildMaster should use when displaying the pipeline's name in the UI. Should be a CSS
hexadecimal color, e.g. `#ffffff`
Required? false
Position? 4
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Stage <String[]>
Stage configuration for the pipeline. Should be an array of `<Inedo.BuildMaster.Pipelines.PipelineStage>` XML
elements.
Required? false
Position? 5
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:\\>New-BMPipeline -Session $session -Name 'Powershell Module'
Demonstrates how to create a new pipeline that is not used by any applications. In this example a pipeline named
`PowerShell Module` will be created.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>New-BMPipeline -Session $session -Name 'PowerShell Module' -Application $app
Demonstrates how to create a new pipeline and assign it to a specific application. In this example, the pipeline
will be called `PowerShell Module` and it will be assigned to the `$app` application.
RELATED LINKS