Get-JiraComponent

NAME Get-JiraComponent



SYNOPSIS

Returns a Component from Jira





SYNTAX

Get-JiraComponent [-Project] <Object[]> [-Credential <PSCredential>] [<CommonParameters>]



Get-JiraComponent [-ComponentId] <Int32[]> [-Credential <PSCredential>] [<CommonParameters>]





DESCRIPTION

This function returns information regarding a specified component from Jira.



Components are specific to a Project. Therefore, it is not possible to query for Components without a project.





PARAMETERS

-Project <Object[]>

The ID or Key of the Project to search.



Required? true

Position? 1

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? false



-ComponentId <Int32[]>

The ID of the component.



Required? true

Position? 1

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Credential <PSCredential>

Credentials to use to connect to JIRA.

If not specified, this function will use anonymous access.



Required? false

Position? named

Default value None

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

[String[]] / [JiraPS.Component[]]

Retrieve all Components in a specific project.



[Int[]]

Retrieve specific Components by theirs id.





OUTPUTS

[JiraPS.Component]







NOTES





This function requires either the `-Credential` parameter to be passed or a persistent JIRA session. See

`New-JiraSession` for more details. If neither are supplied, this function will run with anonymous access to

JIRA.



Remaining operations for `component` have not yet been implemented in the module.



-------------------------- EXAMPLE 1 --------------------------



Get-JiraComponent -Id 10000



Returns information about the component with ID 10000

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



Get-JiraComponent 20000 -Credential $cred



Returns information about the component with ID 20000

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



Get-JiraProject "Project1" | Get-JiraComponent



Returns information about all components within project 'Project1'

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



Get-JiraComponent ABC,DEF



Return information about all components within projects 'ABC' and 'DEF'



RELATED LINKS

Online Version: https://atlassianps.org/docs/JiraPS/com ... Component/