< Back
Remove-JiraFilter
Post
NAME Remove-JiraFilter
SYNOPSIS
Removes an existing filter.
SYNTAX
Remove-JiraFilter [<CommonParameters>]
Remove-JiraFilter [<CommonParameters>]
Remove-JiraFilter [-InputObject] <JiraPS.Filter> [[-Credential] <PSCredential>] [-WhatIf] [-Confirm]
[<CommonParameters>]
Remove-JiraFilter [-Id] <UInt32[]> [[-Credential] <PSCredential>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
This function will remove a filter from Jira. Deleting a filter removed is permanently from Jira.
PARAMETERS
-InputObject <JiraPS.Filter>
Filter object to be deleted.
Object can be retrieved with `Get-JiraFilter`
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-Id <UInt32[]>
Id of the filter to be deleted.
Accepts integers over the pipeline.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByValue)
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? 2
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.Filter]
OUTPUTS
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 --------------------------
Remove-JiraFilter -InputObject (Get-JiraFilter "12345")
Removes the filter `12345` from Jira.
-------------------------- Example 2 --------------------------
$filter = Get-JiraFilter "12345", "98765"
Remove-JiraFilter -InputObject $filter
Removes two filters (`12345` and `98765`) from Jira.
-------------------------- Example 3 --------------------------
Get-JiraFilter "12345", "98765" | Remove-JiraFilter
Removes two filters (`12345` and `98765`) from Jira.
-------------------------- Example 4 --------------------------
Get-JiraFilter -Favorite | Remove-JiraFilter -Confirm
Asks for each favorite filter confirmation to delete it.
-------------------------- Example 5 --------------------------
$listOfFilters = 1,2,3,4
$listOfFilters | Remove-JiraFilter
Remove filters with id "1", "2", "3" and "4".
This input allows for the ID of the filters to be stored in an array and passed to the command. (eg: `Get-Content`
from a file with the ids)
RELATED LINKS
Online Version: https://atlassianps.org/docs/JiraPS/com ... iraFilter/
Get-JiraFilter
New-JiraFilter
Set-JiraFilter
SYNOPSIS
Removes an existing filter.
SYNTAX
Remove-JiraFilter [<CommonParameters>]
Remove-JiraFilter [<CommonParameters>]
Remove-JiraFilter [-InputObject] <JiraPS.Filter> [[-Credential] <PSCredential>] [-WhatIf] [-Confirm]
[<CommonParameters>]
Remove-JiraFilter [-Id] <UInt32[]> [[-Credential] <PSCredential>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
This function will remove a filter from Jira. Deleting a filter removed is permanently from Jira.
PARAMETERS
-InputObject <JiraPS.Filter>
Filter object to be deleted.
Object can be retrieved with `Get-JiraFilter`
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-Id <UInt32[]>
Id of the filter to be deleted.
Accepts integers over the pipeline.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByValue)
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? 2
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.Filter]
OUTPUTS
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 --------------------------
Remove-JiraFilter -InputObject (Get-JiraFilter "12345")
Removes the filter `12345` from Jira.
-------------------------- Example 2 --------------------------
$filter = Get-JiraFilter "12345", "98765"
Remove-JiraFilter -InputObject $filter
Removes two filters (`12345` and `98765`) from Jira.
-------------------------- Example 3 --------------------------
Get-JiraFilter "12345", "98765" | Remove-JiraFilter
Removes two filters (`12345` and `98765`) from Jira.
-------------------------- Example 4 --------------------------
Get-JiraFilter -Favorite | Remove-JiraFilter -Confirm
Asks for each favorite filter confirmation to delete it.
-------------------------- Example 5 --------------------------
$listOfFilters = 1,2,3,4
$listOfFilters | Remove-JiraFilter
Remove filters with id "1", "2", "3" and "4".
This input allows for the ID of the filters to be stored in an array and passed to the command. (eg: `Get-Content`
from a file with the ids)
RELATED LINKS
Online Version: https://atlassianps.org/docs/JiraPS/com ... iraFilter/
Get-JiraFilter
New-JiraFilter
Set-JiraFilter