Get-ConfluenceSpace¶
SYNOPSIS¶
Get a Confluence space (read:space).
SYNTAX¶
ByKey (Default)¶
Get-ConfluenceSpace [-Key <string>] [-Context <Object>]
ById¶
Get-ConfluenceSpace -Id <string> [-Context <Object>]
ALIASES¶
This cmdlet has the following aliases, {{Insert list of aliases}}
DESCRIPTION¶
Returns a space by key or by ID. When neither is supplied the default space key from the connected context is used.
EXAMPLES¶
EXAMPLE 1¶
Get-ConfluenceSpace -Key 'DOCS'
Gets the space with key 'DOCS'.
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: Named
IsRequired: false
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-Id¶
The space ID.
Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: ById
Position: Named
IsRequired: true
ValueFromPipeline: false
ValueFromPipelineByPropertyName: false
ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''
-Key¶
The space key, e.g. 'DOCS'.
Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: ByKey
Position: Named
IsRequired: false
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.