Cmdlet

Publish-OfficeConfluencePage

Module: PSWriteOffice
Inputs: System.String
Outputs: OfficeIMO.Confluence.ConfluencePageWritePlan OfficeIMO.Confluence.ConfluencePage
Source: PublishOfficeConfluencePageCommand.cs:25 Edit on GitHub

Plans, creates, or updates a Confluence Cloud page.

Syntax

Publish-OfficeConfluencePage
[-BodyFormat <Storage|AtlasDocFormat>]
-Content <String>
[-ContentFormat <Markdown|Html|AtlasDocFormat|Storage>]
[-FailOnLoss]
[-ParentId <String>]
[-PlanOnly]
[-Session <ConfluenceSession>]
-SpaceId <String>
-Title <String>
[<CommonParameters>]

Parameter set: Create

Publish-OfficeConfluencePage
[-BodyFormat <Storage|AtlasDocFormat>]
-Content <String>
[-ContentFormat <Markdown|Html|AtlasDocFormat|Storage>]
[-FailOnLoss]
-PageId <String>
[-PlanOnly]
[-Session <ConfluenceSession>]
-Title <String>
[-VersionMessage <String>]
-VersionNumber <Int32>
[<CommonParameters>]

Parameter set: Update

Examples

Inspect the exact create request without contacting Confluence.

Publish-OfficeConfluencePage -SpaceId 42 -Title 'Daily status' -Content $markdown -PlanOnly

Returns a serializable request plan and performs no network operation.

Update a page using optimistic versioning.

Publish-OfficeConfluencePage -Session $session -PageId 123 -Title 'Daily status' -VersionNumber 8 -Content $markdown -VersionMessage 'automation refresh'

The version number must be the next Confluence page version.

Parameters

-BodyFormat ConfluenceBodyFormat optional: Confluence representation to publish.; Possible values: Storage, AtlasDocFormat
-Content String requiredpipeline: True (ByValue): Page content in the representation selected by ContentFormat.
-ContentFormat OfficeConfluenceContentFormat optional: Representation of Content.; Possible values: Markdown, Html, AtlasDocFormat, Storage
-FailOnLoss SwitchParameter optional: Throw when conversion reports reduced fidelity.
-ParentId String optionalsets: Create: Optional parent page identifier for a new page.
-PlanOnly SwitchParameter optional: Return the exact write plan without contacting Confluence.
-Session ConfluenceSession optional: Configured session required for live create or update operations.
-SpaceId String requiredsets: Create: Space identifier for a new page.
-Title String required: Page title.
-PageId String requiredsets: Update: Page identifier for an update.
-VersionMessage String optionalsets: Update: Optional version message for an update.
-VersionNumber Int32 requiredsets: Update: Next positive page version number for an update.

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.