Skip to content

Set-ConfluenceSpace

SYNOPSIS

Create or declaratively configure a Confluence space (read:space and write:space).

SYNTAX

__AllParameterSets

Set-ConfluenceSpace [-Key] <string> [-Name] <string> [[-Description] <string>] [[-Context] <Object>]
 [-WhatIf] [-Confirm]

ALIASES

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

DESCRIPTION

Ensures a space matches the supplied configuration (a declarative upsert). If no space with the key exists it is created; if it exists it is updated. Unlike Update-ConfluenceSpace, this is a full-state set: properties that are not supplied are reset to their defaults (omitting -Description clears it). To change individual fields while preserving the rest, use Update-ConfluenceSpace. Space create/update are v1-only operations reached over the API gateway; creating a space also needs the global "Create Spaces" permission.

EXAMPLES

EXAMPLE 1

Set-ConfluenceSpace -Key 'DOCS' -Name 'Documentation' -Description 'Team docs'

Creates the 'DOCS' space if it is missing, otherwise updates it, so its name and description match exactly what was supplied.

EXAMPLE 2

Set-ConfluenceSpace -Key 'DOCS' -Name 'Documentation'

Declaratively sets 'DOCS' with no description, clearing any existing description.

PARAMETERS

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
Aliases:
- cf
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-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: 3
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Description

The desired plain-text description. Omit to clear the description.

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

-Key

The key of the space to create or configure.

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

-Name

The desired display name. A space always requires a name.

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

-WhatIf

Runs the command in a mode that only reports what would happen without performing the actions.

Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
Aliases:
- wi
ParameterSets:
- Name: (All)
  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.

INPUTS

OUTPUTS

NOTES