Remove-OfficeConfluencePage

Namespace PSWriteOffice

Outputs

OfficeIMO.Confluence.ConfluencePageWritePlan

Source

Sources/PSWriteOffice/Cmdlets/Confluence/RemoveOfficeConfluencePageCommand.cs:22 Edit on GitHub

Plans or deletes a Confluence Cloud page.

Remarks

Plans or deletes a Confluence Cloud page.

Examples

Authored help example

Example 1: Inspect a permanent-delete request without contacting Confluence.

PS>


Remove-OfficeConfluencePage -PageId 12345 -Purge -PlanOnly

Returns the exact DELETE request plan without using a session.

Example 2: Move a current page to the trash.

PS>


Remove-OfficeConfluencePage -Session $session -PageId 12345

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

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.

Syntax

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

Parameter set: All Parameter Sets

Parameters

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

Outputs

OfficeIMO.Confluence.ConfluencePageWritePlan