Get-BMPipeline

NAME Get-BMPipeline



SYNOPSIS

Gets pipelines.





SYNTAX

Get-BMPipeline -Session <Object> [-Name <String>] [-ApplicationID <Int32>] [<CommonParameters>]



Get-BMPipeline -Session <Object> -ID <Int32> [<CommonParameters>]





DESCRIPTION

The `Get-BMPipeline` function gets pipelines. By default, it returns all pipelines. To get a specific pipeline,

pass its name to the `Name` parameter or its ID to the `ID` parameter. The `Name` parameter supports wildcards. To

get a specific application's pipelines, pass the application's ID to the `ApplicationID` parameter.



This function uses the `Pipelines_GetPipelines` and `Pipelines_GetPipeline` native API methods.





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? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Name <String>

The name of the pipeline to get. Supports wildcards.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ApplicationID <Int32>

The ID of the application whose pipelines to get. The default is to return all pipelines.



Required? false

Position? named

Default value 0

Accept pipeline input? false

Accept wildcard characters? false



-ID <Int32>

The ID of the pipeline to get.



Required? true

Position? named

Default value 0

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-BMPipeline -Session $session



Demonstrates how to get all the pipelines.









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



PS C:\\>Get-BMPipeline -Session $session -Name 'BuildMaster Automation'



Demonstrates how to get pipelines by name. If there are multiple pipelines with the same name, they will all be

returned.









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



PS C:\\>Get-BMPipeline -Session $session -Name '*Automation'



Demonstrates that you can use wildcards in the `Name` parameter's value to search for pipelines.









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



PS C:\\>Get-BMPipeline -Session $session -ID 34



Demonstrates how to get a specific pipeline by its ID.









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



PS C:\\>Get-BMPipeline -Session $session -ApplicationID 39



Demonstrates how to get a specific application's pipelines.









-------------------------- EXAMPLE 6 --------------------------



PS C:\\>Get-BMPipeline -Session $session -ApplicationID 39 -Name 'Pipeline 2'



Demonstrates how to get an application's pipeline by its name.











RELATED LINKS