AtlassianPS
A PowerShell community for Atlassian products
A PowerShell community for Atlassian products
Create a new blank space on your Confluence instance.
New-ConfluenceSpace -ApiUri <Uri> -Credential <PSCredential> -InputObject <Space> [-WhatIf] [-Confirm]
New-ConfluenceSpace -ApiUri <Uri> -Credential <PSCredential> -SpaceKey <String> -Name <String>
[-Description <String>] [-WhatIf] [-Confirm]
Create a new blank space.
A value for Key and Name is mandatory. Not so for Description, although recommended.
New-ConfluenceSpace -Key 'HOTH' -Name 'Planet Hoth' -Description "It's really cold" -Verbose
Create a new blank space with an optional description and verbose output.
$spaceObject = [ConfluencePS.Space]@{
Key = "HOTH"
Name = "Planet Hoth"
Description = "It's really cold"
}
# example 1
New-ConfluenceSpace -InputObject $spaceObject
# example 2
$spaceObject | New-ConfluenceSpace
Two different methods of creating a new space from an object ConfluencePS.Space.
Both examples should return identical results.
The URi of the API interface. Value can be set persistently with Set-ConfluenceInfo.
Type: Uri
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Confluence’s credentials for authentication. Value can be set persistently with Set-ConfluenceInfo.
Type: PSCredential
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Certificate for authentication.
Type: X509Certificate
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Space Object from which to create the new space.
Type: Space
Parameter Sets: byObject
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
Specify the short key to be used in the space URI.
Type: String
Parameter Sets: byProperties
Aliases: Key
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specify the space’s name.
Type: String
Parameter Sets: byProperties
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
A short description of the new space.
Type: String
Parameter Sets: byProperties
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False