On this page

Get-JiraComponent

SYNOPSIS

Returns a Component from Jira

SYNTAX

ByID (Default)

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

ByProject

Get-JiraComponent [-Project] <Object[]> [-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.

EXAMPLES

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’

PARAMETERS

-Project

The ID or Key of the Project to search.

Type: Object[]
Parameter Sets: ByProject
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-ComponentId

The ID of the component.

Type: Int32[]
Parameter Sets: ByID
Aliases: Id

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Credential

Credentials to use to connect to JIRA.
If not specified, this function will use anonymous access.

Type: PSCredential
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://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.