New-ConfluenceSpace

NAME New-ConfluenceSpace



SYNOPSIS

Create a new blank space on your Confluence instance.





SYNTAX

New-Space -ApiUri <Uri> [-Credential <PSCredential>] [-Certificate <X509Certificate>] -InputObject <Space>

[-WhatIf] [-Confirm] [<CommonParameters>]



New-Space -ApiUri <Uri> [-Credential <PSCredential>] [-Certificate <X509Certificate>] -SpaceKey <String> -Name

<String> [-Description <String>] [-WhatIf] [-Confirm] [<CommonParameters>]





DESCRIPTION

Create a new blank space.



A value for `Key` and `Name` is mandatory. Not so for `Description`, although recommended.





PARAMETERS

-ApiUri <Uri>

The URi of the API interface. Value can be set persistently with Set-ConfluenceInfo.



Required? true

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Credential <PSCredential>

Confluence's credentials for authentication. Value can be set persistently with Set-ConfluenceInfo.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Certificate <X509Certificate>

Certificate for authentication.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-InputObject <Space>

Space Object from which to create the new space.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? false



-SpaceKey <String>

Specify the short key to be used in the space URI.



Required? true

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Name <String>

Specify the space's name.



Required? true

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Description <String>

A short description of the new space.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

Shows what would happen if the cmdlet runs. The cmdlet is not run.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-Confirm [<SwitchParameter>]

Prompts you for confirmation before running the cmdlet.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS

ConfluencePS.Space







NOTES









-------------------------- EXAMPLE 1 --------------------------



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.

-------------------------- EXAMPLE 2 --------------------------



$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.



RELATED LINKS

Online Version: https://atlassianps.org/docs/Confluence ... New-Space/

https://github.com/AtlassianPS/ConfluencePS https://github.com/AtlassianPS/ConfluencePS