Skip to content

Get-ConfluenceContentProperty

SYNOPSIS

Get content properties of a page (read:page).

SYNTAX

__AllParameterSets

Get-ConfluenceContentProperty [-PageId] <string> [[-Key] <string>] [[-Context] <Object>]

ALIASES

This cmdlet has the following aliases, {{Insert list of aliases}}

DESCRIPTION

Returns all content properties on a page, or the single property with the given key. In v2, a page's content properties are governed by the page's own scope (read:page); the read:content.property scope applies to the v1 property API.

EXAMPLES

EXAMPLE 1

Get-ConfluenceContentProperty -PageId '12345' -Key 'my-prop'

Gets the 'my-prop' content property from page 12345.

PARAMETERS

-Context

The context to use: an object, a context name, or $null for the default.

Type: System.Object
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 2
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Key

The property key to return. If omitted, all properties are returned.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 1
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-PageId

The page ID.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 0
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES