On this page

Get-JiraVersion

SYNOPSIS

This function returns information about a JIRA Project’s Version

SYNTAX

byId (Default)

Get-JiraVersion -Id <Int32[]> [-PageSize <Int32>] [-IncludeTotalCount] [-Skip <UInt64>]
 [-First <UInt64>] [-Credential <PSCredential>] [<CommonParameters>]

byInputVersion

Get-JiraVersion [-InputVersion] <Object> [-PageSize <Int32>] [-IncludeTotalCount]
 [-Skip <UInt64>] [-First <UInt64>] [-Credential <PSCredential>] [<CommonParameters>]

byProject

Get-JiraVersion [-Project] <String[]> [-Name <String[]>] [[-Sort] <String>]
 [-PageSize <Int32>] [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>]
 [-Credential <PSCredential>] [<CommonParameters>]

byInputProject

Get-JiraVersion [-InputProject] <Object> [-Name <String[]>] [[-Sort] <String>]
 [-PageSize <Int32>] [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>]
 [-Credential <PSCredential>] [<CommonParameters>]

DESCRIPTION

This function provides information about JIRA Version

EXAMPLES

EXAMPLE 1

Get-JiraVersion -Project $ProjectKey

This example returns information about all JIRA Version visible to the current user for the project.

EXAMPLE 2

Get-JiraVersion -Project $ProjectKey -Name '1.0.0.0'

This example returns the information of a specific Version.

EXAMPLE 3

Get-JiraProject "FOO", "BAR" | Get-JiraVersion -Name "v1.0", "v2.0"

Get the Version with name “v1.0” and “v2.0” from both projects “FOO” and “BAR”

EXAMPLE 4

Get-JiraVersion -ID '66596'

This example returns information about all JIRA Version visible to the current user (or using anonymous access if a JiraPS session has not been defined) for the project.

PARAMETERS

-Id

The Version ID

Type: Int32[]
Parameter Sets: byId
Aliases:

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

-InputVersion

A Version object to search for

Type: JiraPS.Version
Parameter Sets: byInputVersion
Aliases:

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

-Project

Project key of a project to search

Type: String[]
Parameter Sets: byProject
Aliases: Key

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

-InputProject

A Project Object to search

Type: JiraPS.Project
Parameter Sets: byInputProject
Aliases:

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

-Name

Jira Version Name

Type: String[]
Parameter Sets: byProject, byInputProject
Aliases: Versions

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

Sort

Define the order in which the versions should be sorted before returning.

Possible values are:

  • sequence
  • name
  • startDate
  • releaseDate
Type: String
Parameter Sets: byProject, byInputProject
Aliases: Versions

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

-PageSize

Maximum number of results to fetch per call.

This setting can be tuned to get better performance according to the load on the server.

Warning: too high of a PageSize can cause a timeout on the request.

Type: UInt32
Parameter Sets: (All)
Aliases:

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

-IncludeTotalCount

Causes an extra output of the total count at the beginning.

Note this is actually a uInt64, but with a custom string representation.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Skip

Controls how many things will be skipped before starting output.

Defaults to 0.

Type: UInt64
Parameter Sets: (All)
Aliases:

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

-First

Indicates how many items to return.

Type: UInt64
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: 18446744073709551615
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

[JiraPS.Version]

[JiraPS.Project]

OUTPUTS

[JiraPS.Version]

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.

Get-JiraProject

New-JiraVersion

Remove-JiraVersion

Set-JiraVersion