Skip to content

Get-SPOTheme.md

Latest commit

 

History

History
157 lines (120 loc) · 4.43 KB

Get-SPOTheme.md

File metadata and controls

157 lines (120 loc) · 4.43 KB
external help file Microsoft.Online.SharePoint.PowerShell.dll-Help.xml
Module Name Microsoft.Online.SharePoint.PowerShell
online version https://learn.microsoft.com/powershell/module/microsoft.online.sharepoint.powershell/get-spotheme
applicable SharePoint Online
title Get-SPOTheme
schema 2.0.0
author samkabue
ms.author speedta
ms.reviewer

Get-SPOTheme

SYNOPSIS

SYNTAX

Get-SPOTheme [[-Name] <String>] [<CommonParameters>]

DESCRIPTION

This cmdlet returns the settings for a named existing theme, or for all uploaded themes if no name is provided.

Note

To support consistent branding and simplify governance, theme management is transitioning to a centralized model.

  • The primary geo will act as the central location for organization-wide theme creation and management. Themes created here will be visible and applicable across satellite geos.
  • The satellite Geo Administrators will be able to view and apply themes from the primary geo to their own sites by using Get-SPOTheme and Set-SPOWebTheme cmdlet. Themes previously created within satellite geos will remain available for use. However, creating new themes in satellite geos will no longer be supported going forward.

EXAMPLES

Example 1

This example shows how to use the Get-SPOTheme cmdlet to return the settings for the "Custom Cyan" theme created in the example for the Add-SPOTheme cmdlet. Note that this example uses the PowerShell ConvertTo-Json filter to display the theme in JSON format.

Get-SPOTheme -Name "Custom Cyan" -IncludeGlobalTheme | ConvertTo-Json -Depth 4
{
    "Name":  "Custom Cyan",
    "Palette": null,
    "ColorPairs": {
        "light": [
            {"accentColor": "#0078D4", "backgroundColor": "#FFFFFF"},
            {"accentColor": "#FFFFFF", "backgroundColor": "#0078D4"}
        ]
    },
    "IsInverted":  false,
    "Editable": true
}

If the theme is in legacy format, the output will be:

{
    "Name":  "Custom Cyan",
    "Palette":  {
        "themeLight":  "#affefe",
        "themeTertiary":  "#76ffff",
        "black":  "#000000",
        "neutralSecondary":  "#666666",
        "neutralTertiaryAlt":  "#c8c8c8",
        "themeSecondary":  "#39ffff",
        "themeDarker":  "#005252",
        "primaryBackground":  "#fff",
        "neutralQuaternary":  "#d0d0d0",
        "neutralPrimaryAlt":  "#3c3c3c",
        "neutralPrimary":  "#333",
        "themeDark":  "#009090",
        "themeLighter":  "#daffff",
        "neutralTertiary":  "#a6a6a6",
        "neutralQuaternaryAlt":  "#dadada",
        "themeLighterAlt":  "#f3fcfc",
        "white":  "#fff",
        "neutralSecondaryAlt":  "#767676",
        "neutralLighter":  "#f4f4f4",
        "neutralLight":  "#eaeaea",
        "neutralDark":  "#212121",
        "themeDarkAlt":  "#00c4c4",
        "neutralLighterAlt":  "#f8f8f8",
        "primaryText":  "#333",
        "themePrimary":  "#00ffff"
    },
    "IsInverted":  false,
    "Editable": true
}

Example 2

To return all uploaded themes, use the Get-SPOTheme command with no arguments.

Get-SPOTheme -IncludeGlobalTheme

PARAMETERS

-Name

Applicable: SharePoint Online

The name of the theme.

Type: System.String
Parameter Sets: (All)
Aliases:

Required: False
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-IncludeGlobalTheme

Applicable: SharePoint Online

When specified, Get-SPOTheme returns all global themes that are available to the tenant. This includes themes created by using PowerShell as well as themes created in the Brand Center.

For satellite geos, IncludeGlobalTheme also returns the global themes that are defined in the primary geo.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

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

INPUTS

System.String

OUTPUTS

System.Object

NOTES

RELATED LINKS

Site theme