On this page

    Remove-JiraFilter

    SYNOPSIS

    Removes an existing filter.

    SYNTAX

    byInputObject (Default)

    Remove-JiraFilter [-InputObject] <JiraPS.Filter> [-WhatIf] [-Confirm]
 [<CommonParameters>]

    byId (Default)

    Remove-JiraFilter [-Id] <UInt32[]> [-WhatIf] [-Confirm] [<CommonParameters>]

    DESCRIPTION

    This function will remove a filter from Jira. Deleting a filter removed is permanently from Jira.

    EXAMPLES

    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)

    PARAMETERS

    -InputObject

    Filter object to be deleted.

    Object can be retrieved with Get-JiraFilter

    Type: JiraPS.Filter
Parameter Sets: ByInputObject
Aliases:

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

    -Id

    Id of the filter to be deleted.

    Accepts integers over the pipeline.

    Type: UInt32[]
Parameter Sets: ById
Aliases:

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

    -Credential

    Credentials to use to connect to JIRA.
    If not specified, this function will use anonymous access.

    Type: PSCredential
Parameter Sets: (All)
Aliases:

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

    -WhatIf

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

    Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

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

    -Confirm

    Prompts you for confirmation before running the cmdlet.

    Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

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

    CommonParameters

    This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://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.

    Get-JiraFilter

    New-JiraFilter

    Set-JiraFilter