Set-Sprint

SYNOPSIS

Updates Jira Agile sprints.

SYNTAX

Set-Sprint [-Sprint] <Sprint[]> [-Name <String>] [-State <SprintState>] [-StartDate <DateTime>] [-EndDate <DateTime>] [-Goal <String>] [-Credential <PSCredential>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Set-Sprint updates one or more Jira Agile sprints using the Jira Agile partial-update endpoint.

Only the values you provide are submitted to Jira. Fields omitted from the command are left unchanged by Jira.

When imported normally, run this command as Set-JiraAgileSprint.

EXAMPLES

EXAMPLE 1

$sprint = [AtlassianPS.JiraAgilePS.Sprint]::new(42)
JiraAgilePS\Set-Sprint -Sprint $sprint -Name "Sprint 42 - revised" -Goal "Complete the release candidate" -Credential $cred

Updates the sprint name and goal.

EXAMPLE 2

$sprint = [AtlassianPS.JiraAgilePS.Sprint]::new(42)
JiraAgilePS\Set-Sprint -Sprint $sprint -State Active -StartDate (Get-Date) -EndDate (Get-Date).AddDays(14) -Credential $cred

Starts a future sprint by setting state and dates.

PARAMETERS

-Sprint

Sprint object(s) to update.

Type: Sprint[]
Parameter Sets: (All)
Aliases:

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

-Name

Updated sprint name.

Type: String
Parameter Sets: (All)
Aliases:

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

-State

Updated sprint state.

Type: SprintState
Parameter Sets: (All)
Aliases:

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

-StartDate

Updated sprint start date.

Type: DateTime
Parameter Sets: (All)
Aliases:

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

-EndDate

Updated sprint end date.

Type: DateTime
Parameter Sets: (All)
Aliases:

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

-Goal

Updated sprint goal.

Type: String
Parameter Sets: (All)
Aliases:

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

-Credential

Credentials used for Jira authentication.

Type: PSCredential
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: [System.Management.Automation.PSCredential]::Empty
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

AtlassianPS.JiraAgilePS.Sprint[]

OUTPUTS

AtlassianPS.JiraAgilePS.Sprint

NOTES

Use Set-JiraAgileSprint in normal module usage. Set-Sprint is the source function name.

Get-Sprint

New-Sprint