< Back

Set-JiraVersion

Thu Jan 16, 2020 8:23 am

NAME Set-JiraVersion



SYNOPSIS

Modifies an existing Version in JIRA





SYNTAX

Set-JiraVersion [-Version] <Object[]> [[-Name] <String>] [[-Description] <String>] [[-Archived] <Boolean>]

[[-Released] <Boolean>] [[-ReleaseDate] <DateTime>] [[-StartDate] <DateTime>] [[-Project] <Object>] [[-Credential]

<PSCredential>] [-WhatIf] [-Confirm] [<CommonParameters>]





DESCRIPTION

This function modifies the Version for an existing Project in JIRA.





PARAMETERS

-Version <Object[]>

Version to be changed



Required? true

Position? 1

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? false



-Name <String>

New Name of the Version.



Required? false

Position? 2

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Description <String>

New Description of the Version.



Required? false

Position? 3

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Archived <Boolean>

New value for Archived.



Required? false

Position? 4

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-Released <Boolean>

New value for Released.



Required? false

Position? 5

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-ReleaseDate <DateTime>

New Date of the release.



Required? false

Position? 6

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-StartDate <DateTime>

New Date of the user release.



Required? false

Position? 7

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Project <Object>

The new Project where this version should be in.



This can be the ID of the Project, or the Project Object



Required? false

Position? 8

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? 9

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

Shows what would happen if the cmdlet runs. The cmdlet is not run.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-Confirm [<SwitchParameter>]

Prompts you for confirmation before running the cmdlet.



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

[JiraPS.Version]







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 $Project -Name "Old-Name" | Set-JiraVersion -Name 'New-Name'



This example assigns the modifies the existing version with a new name 'New-Name'.

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



Get-JiraVersion -ID 162401 | Set-JiraVersion -Description 'Descriptive String'



This example assigns the modifies the existing version with a new name 'New-Name'.



RELATED LINKS

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

Get-JiraVersion

New-JiraVersion

Set-JiraVersion

Move-JiraVersion