Get-JiraVersion

NAME Get-JiraVersion



SYNOPSIS

This function returns information about a JIRA Project's Version





SYNTAX

Get-JiraVersion -Id <Int32[]> [-PageSize <UInt32>] [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>]

[-Credential <PSCredential>] [<CommonParameters>]



Get-JiraVersion [-InputVersion] <JiraPS.Version> [-PageSize <UInt32>] [-IncludeTotalCount] [-Skip <UInt64>]

[-First <UInt64>] [-Credential <PSCredential>] [<CommonParameters>]



Get-JiraVersion [-Project] <String[]> [-Name <String[]>] [-Sort <String>] [-PageSize <UInt32>]

[-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>] [-Credential <PSCredential>] [<CommonParameters>]



Get-JiraVersion [-InputProject] <JiraPS.Project> [-Name <String[]>] [-Sort <String>] [-PageSize <UInt32>]

[-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>] [-Credential <PSCredential>] [<CommonParameters>]





DESCRIPTION

This function provides information about JIRA Version





PARAMETERS

-Id <Int32[]>

The Version ID



Required? true

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-InputVersion <JiraPS.Version>

A Version object to search for



Required? true

Position? 1

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? false



-Project <String[]>

Project key of a project to search



Required? true

Position? 1

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-InputProject <JiraPS.Project>

A Project Object to search



Required? true

Position? 1

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? false



-Name <String[]>

Jira Version Name



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Sort <String>

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



Possible values are:



* sequence



* name



* startDate



* releaseDate



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-PageSize <UInt32>

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.



Required? false

Position? named

Default value 25

Accept pipeline input? False

Accept wildcard characters? false



-IncludeTotalCount [<SwitchParameter>]

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



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



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-Skip <UInt64>

Controls how many things will be skipped before starting output.



Defaults to 0.



Required? false

Position? named

Default value 0

Accept pipeline input? False

Accept wildcard characters? false



-First <UInt64>

Indicates how many items to return.



Required? false

Position? named

Default value 18446744073709551615

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

[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.



-------------------------- 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.



RELATED LINKS

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

Get-JiraProject

New-JiraVersion

Remove-JiraVersion

Set-JiraVersion

Move-JiraVersion