Get-BMApplication

NAME Get-BMApplication



SYNOPSIS

Gets BuildMaster applications.





SYNTAX

Get-BMApplication -Session <Object> [-Force] [<CommonParameters>]



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





DESCRIPTION

The `Get-BMApplication` function gets all active applications from an instance of BuildMaster. Use the `Force`

switch to include inactive applications. To get a specific application, pass the name to the `Name` parameter.

Active and inactive applications are returned. If an application with the name doesn't exist, you'll get nothing

back.



Uses the BuildMaster native API, which can change without notice between releases. By default, this function

returns *all* applications.





PARAMETERS

-Session <Object>

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



Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Name <String>

The name of the application to get. By default, all applications are returned.



Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Force [<SwitchParameter>]

Force `Get-BMApplication` to return inactive/disabled applications.



Required? false

Position? named

Default value False

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



Demonstrates how to get all active BuildMaster applications









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



PS C:\\>Get-BMApplication -Session $session -Force



Demonstrates how to get all active *and* inactive/disabled BuildMaster applications.









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



PS C:\\>Get-BMApplication -Session $session -Name 'MyApplication'



Demonstrates how to get a specific application.











RELATED LINKS