Cmdlet

Remove-OfficeConfluencePage

Module: PSWriteOffice
Inputs: None
Outputs: OfficeIMO.Confluence.ConfluencePageWritePlan
Source: RemoveOfficeConfluencePageCommand.cs:22 Edit on GitHub

Plans or deletes a Confluence Cloud page.

Syntax

Remove-OfficeConfluencePage
[-Draft]
[-PageId] <String>
[-PassThru]
[-PlanOnly]
[-Purge]
[-Session <ConfluenceSession>]
[<CommonParameters>]

Parameter set: All Parameter Sets

Examples

Inspect a permanent-delete request without contacting Confluence.

Remove-OfficeConfluencePage -PageId 12345 -Purge -PlanOnly

Returns the exact DELETE request plan without using a session.

Move a current page to the trash.

Remove-OfficeConfluencePage -Session $session -PageId 12345

Uses PowerShell ShouldProcess before sending the non-retried delete request.

Parameters

-Draft SwitchParameter optional: Delete a draft page.
-PageId String requiredposition: 0: Page identifier.
-PassThru SwitchParameter optional: Return the completed delete plan after a live operation.
-PlanOnly SwitchParameter optional: Return the exact delete plan without contacting Confluence.
-Purge SwitchParameter optional: Permanently delete a page that is already in the trash.
-Session ConfluenceSession optional: Configured session required for a live delete operation.

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.