Publish-OfficeConfluencePage

Namespace PSWriteOffice

Inputs

System.String

Outputs

OfficeIMO.Confluence.ConfluencePage OfficeIMO.Confluence.ConfluencePageWritePlan

Source

Sources/PSWriteOffice/Cmdlets/Confluence/PublishOfficeConfluencePageCommand.cs:25 Edit on GitHub

Plans, creates, or updates a Confluence Cloud page.

Remarks

Plans, creates, or updates a Confluence Cloud page.

Examples

Authored help example

Example 1: Inspect the exact create request without contacting Confluence.

PS>


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

Returns a serializable request plan and performs no network operation.

Example 2: Update a page using optimistic versioning.

PS>


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.

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

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

Parameters

BodyFormat ConfluenceBodyFormat optionalposition: namedpipeline: Falsevalues: 2: Confluence representation to publish. Possible values: Storage, AtlasDocFormat; Possible values: Storage, AtlasDocFormat
Content String requiredposition: namedpipeline: True (ByValue): Page content in the representation selected by ContentFormat.
ContentFormat OfficeConfluenceContentFormat optionalposition: namedpipeline: Falsevalues: 4: Representation of Content. Possible values: Markdown, Html, AtlasDocFormat, Storage; Possible values: Markdown, Html, AtlasDocFormat, Storage
FailOnLoss SwitchParameter optionalposition: namedpipeline: False: Throw when conversion reports reduced fidelity.
ParentId String optionalposition: namedpipeline: False: Optional parent page identifier for a new page.
PlanOnly SwitchParameter optionalposition: namedpipeline: False: Return the exact write plan without contacting Confluence.
Session ConfluenceSession optionalposition: namedpipeline: False: Configured session required for live create or update operations.
SpaceId String requiredposition: namedpipeline: False: Space identifier for a new page.
Title String requiredposition: namedpipeline: False: Page title.

Outputs

OfficeIMO.Confluence.ConfluencePage, OfficeIMO.Confluence.ConfluencePageWritePlan

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

Parameters

BodyFormat ConfluenceBodyFormat optionalposition: namedpipeline: Falsevalues: 2: Confluence representation to publish. Possible values: Storage, AtlasDocFormat; Possible values: Storage, AtlasDocFormat
Content String requiredposition: namedpipeline: True (ByValue): Page content in the representation selected by ContentFormat.
ContentFormat OfficeConfluenceContentFormat optionalposition: namedpipeline: Falsevalues: 4: Representation of Content. Possible values: Markdown, Html, AtlasDocFormat, Storage; Possible values: Markdown, Html, AtlasDocFormat, Storage
FailOnLoss SwitchParameter optionalposition: namedpipeline: False: Throw when conversion reports reduced fidelity.
PageId String requiredposition: namedpipeline: False: Page identifier for an update.
PlanOnly SwitchParameter optionalposition: namedpipeline: False: Return the exact write plan without contacting Confluence.
Session ConfluenceSession optionalposition: namedpipeline: False: Configured session required for live create or update operations.
Title String requiredposition: namedpipeline: False: Page title.
VersionMessage String optionalposition: namedpipeline: False: Optional version message for an update.
VersionNumber Int32 requiredposition: namedpipeline: False: Next positive page version number for an update.

Outputs

OfficeIMO.Confluence.ConfluencePage, OfficeIMO.Confluence.ConfluencePageWritePlan