< Back
Set-JiraIssueLabel
Post
NAME Set-JiraIssueLabel
SYNOPSIS
Modifies labels on an existing JIRA issue
SYNTAX
Set-JiraIssueLabel [-Issue] <Object[]> -Set <String[]> [-Credential <PSCredential>] [-PassThru] [-WhatIf]
[-Confirm] [<CommonParameters>]
Set-JiraIssueLabel [-Issue] <Object[]> [-Add <String[]>] [-Remove <String[]>] [-Credential <PSCredential>]
[-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]
Set-JiraIssueLabel [-Issue] <Object[]> -Clear [-Credential <PSCredential>] [-PassThru] [-WhatIf] [-Confirm]
[<CommonParameters>]
DESCRIPTION
This function modifies labels on an existing JIRA issue. There are four supported operations on labels:
- Add : appends additional labels to the labels that an issue already has - Remove : Removes labels from an
issue's current labels - Set : erases the existing labels on the issue and replaces them with the provided values
- Clear : removes all labels from the issue
PARAMETERS
-Issue <Object[]>
Issue of which the labels should be manipulated.
Can be a `JiraPS.Issue` object, issue key, or internal issue ID.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-Set <String[]>
List of labels that will be set to the issue.
Any label that was already assigned to the issue will be removed.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Add <String[]>
Labels to be added in addition to the existing ones.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Remove <String[]>
Labels of the issue to be removed.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Clear [<SwitchParameter>]
Remove all labels of the issue.
Required? true
Position? named
Default value False
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
-PassThru [<SwitchParameter>]
Whether output should be provided after invoking this function.
Required? false
Position? named
Default value False
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.Issue]
OUTPUTS
[JiraPS.Issue]
If the `-PassThru` parameter is provided, this function will provide a reference to the JIRA issue modified.
Otherwise, this function does not provide output.
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 --------------------------
Set-JiraIssueLabel -Issue TEST-01 -Set 'fixed'
This example replaces all existing labels on issue TEST-01 with one label, "fixed".
-------------------------- EXAMPLE 2 --------------------------
Get-JiraIssue -Query 'created >= -7d AND reporter in (joeSmith)' | Set-JiraIssueLabel -Add 'enhancement'
This example adds the "enhancement" label to all issues matching the JQL - in this case, all issues created by
user joeSmith in the last 7 days.
-------------------------- EXAMPLE 3 --------------------------
Get-JiraIssue TEST-01 | Set-JiraIssueLabel -Clear
This example removes all labels from the issue TEST-01.
RELATED LINKS
Online Version: https://atlassianps.org/docs/JiraPS/com ... ssueLabel/
Get-JiraIssue
SYNOPSIS
Modifies labels on an existing JIRA issue
SYNTAX
Set-JiraIssueLabel [-Issue] <Object[]> -Set <String[]> [-Credential <PSCredential>] [-PassThru] [-WhatIf]
[-Confirm] [<CommonParameters>]
Set-JiraIssueLabel [-Issue] <Object[]> [-Add <String[]>] [-Remove <String[]>] [-Credential <PSCredential>]
[-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]
Set-JiraIssueLabel [-Issue] <Object[]> -Clear [-Credential <PSCredential>] [-PassThru] [-WhatIf] [-Confirm]
[<CommonParameters>]
DESCRIPTION
This function modifies labels on an existing JIRA issue. There are four supported operations on labels:
- Add : appends additional labels to the labels that an issue already has - Remove : Removes labels from an
issue's current labels - Set : erases the existing labels on the issue and replaces them with the provided values
- Clear : removes all labels from the issue
PARAMETERS
-Issue <Object[]>
Issue of which the labels should be manipulated.
Can be a `JiraPS.Issue` object, issue key, or internal issue ID.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-Set <String[]>
List of labels that will be set to the issue.
Any label that was already assigned to the issue will be removed.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Add <String[]>
Labels to be added in addition to the existing ones.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Remove <String[]>
Labels of the issue to be removed.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Clear [<SwitchParameter>]
Remove all labels of the issue.
Required? true
Position? named
Default value False
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
-PassThru [<SwitchParameter>]
Whether output should be provided after invoking this function.
Required? false
Position? named
Default value False
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.Issue]
OUTPUTS
[JiraPS.Issue]
If the `-PassThru` parameter is provided, this function will provide a reference to the JIRA issue modified.
Otherwise, this function does not provide output.
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 --------------------------
Set-JiraIssueLabel -Issue TEST-01 -Set 'fixed'
This example replaces all existing labels on issue TEST-01 with one label, "fixed".
-------------------------- EXAMPLE 2 --------------------------
Get-JiraIssue -Query 'created >= -7d AND reporter in (joeSmith)' | Set-JiraIssueLabel -Add 'enhancement'
This example adds the "enhancement" label to all issues matching the JQL - in this case, all issues created by
user joeSmith in the last 7 days.
-------------------------- EXAMPLE 3 --------------------------
Get-JiraIssue TEST-01 | Set-JiraIssueLabel -Clear
This example removes all labels from the issue TEST-01.
RELATED LINKS
Online Version: https://atlassianps.org/docs/JiraPS/com ... ssueLabel/
Get-JiraIssue