< Back
Remove-ConfluencePage
Post
NAME Remove-ConfluencePage
SYNOPSIS
Trash an existing Confluence page.
SYNTAX
Remove-Page [-PageID] <Int32[]> -ApiUri <Uri> [-Credential <PSCredential>] [-Certificate <X509Certificate>]
[-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Delete existing Confluence content by page ID.
This trashes most content, but will permanently delete "un-trashable" content.
> 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 delete. Accepts multiple IDs via pipeline input.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
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-ConfluencePage -PageID 123456 -Verbose -Confirm
Trash the wiki page with ID 123456. Verbose and Confirm flags both active; you will be prompted before removal.
-------------------------- EXAMPLE 2 --------------------------
Get-ConfluencePage -SpaceKey ABC -Title '*test*' | Remove-ConfluencePage -WhatIf
For all wiki pages in space ABC with "test" somewhere in the name, simulate the each page being trashed. -WhatIf
prevents any removals.
-------------------------- EXAMPLE 3 --------------------------
Get-ConfluencePage -Label 'deleteMe' | Remove-ConfluencePage
For all wiki pages with the label "deleteMe" applied, trash each page.
RELATED LINKS
Online Version: https://atlassianps.org/docs/Confluence ... move-Page/
https://github.com/AtlassianPS/ConfluencePS https://github.com/AtlassianPS/ConfluencePS
SYNOPSIS
Trash an existing Confluence page.
SYNTAX
Remove-Page [-PageID] <Int32[]> -ApiUri <Uri> [-Credential <PSCredential>] [-Certificate <X509Certificate>]
[-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Delete existing Confluence content by page ID.
This trashes most content, but will permanently delete "un-trashable" content.
> 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 delete. Accepts multiple IDs via pipeline input.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
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-ConfluencePage -PageID 123456 -Verbose -Confirm
Trash the wiki page with ID 123456. Verbose and Confirm flags both active; you will be prompted before removal.
-------------------------- EXAMPLE 2 --------------------------
Get-ConfluencePage -SpaceKey ABC -Title '*test*' | Remove-ConfluencePage -WhatIf
For all wiki pages in space ABC with "test" somewhere in the name, simulate the each page being trashed. -WhatIf
prevents any removals.
-------------------------- EXAMPLE 3 --------------------------
Get-ConfluencePage -Label 'deleteMe' | Remove-ConfluencePage
For all wiki pages with the label "deleteMe" applied, trash each page.
RELATED LINKS
Online Version: https://atlassianps.org/docs/Confluence ... move-Page/
https://github.com/AtlassianPS/ConfluencePS https://github.com/AtlassianPS/ConfluencePS