Remove-ConfluenceLabel

NAME Remove-ConfluenceLabel



SYNOPSIS

Remove a label from existing Confluence content.





SYNTAX

Remove-Label [-PageID] <Int32[]> -ApiUri <Uri> [-Credential <PSCredential>] [-Certificate <X509Certificate>]

[-Label <String[]>] [-WhatIf] [-Confirm] [<CommonParameters>]





DESCRIPTION

Remove labels from Confluence content.



Does accept multiple pages piped via Get-ConfluencePage.



> Untested against non-page content.





PARAMETERS

-ApiUri <Uri>

The URi of the API interface. Value can be set persistently with Set-ConfluenceInfo.



Required? true

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Credential <PSCredential>

Confluence's credentials for authentication. Value can be set persistently with Set-ConfluenceInfo.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Certificate <X509Certificate>

Certificate for authentication.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-PageID <Int32[]>

The page ID to remove the label from.



Accepts multiple IDs via pipeline input.



Required? true

Position? 1

Default value None

Accept pipeline input? True (ByPropertyName, ByValue)

Accept wildcard characters? false



-Label <String[]>

A single content label to remove from one or more pages.



Required? false

Position? named

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



OUTPUTS

System.Boolean







NOTES









-------------------------- EXAMPLE 1 --------------------------



Remove-ConfluenceLabel -PageID 123456 -Label 'seven' -Verbose -Confirm



Remove label "seven" from the wiki page with ID 123456. Verbose and Confirm flags both active; you will be

prompted before deletion.

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



Get-ConfluencePage -SpaceKey 'ABC' -Label 'deleteMe' | Remove-ConfluenceLabel -Label 'deleteMe' -WhatIf



For all wiki pages in the ABC space, the label "deleteMe" would be removed. WhatIf parameter prevents any

modifications.

-------------------------- EXAMPLE 3 --------------------------



Get-ConfluenceChildPage -PageID 123456 | Remove-ConfluenceLabel



For all wiki pages immediately below page 123456, remove all labels from each page.



RELATED LINKS

Online Version: https://atlassianps.org/docs/Confluence ... ove-Label/

https://github.com/AtlassianPS/ConfluencePS https://github.com/AtlassianPS/ConfluencePS