Skip to content

Commit 2efe0f1

Browse files
committed
Merge branch 'ExMigration' of https://github.com/MicrosoftDocs/office-docs-powershell into ExMigration
2 parents 3e050a0 + 20c1e83 commit 2efe0f1

File tree

135 files changed

+1286
-758
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

135 files changed

+1286
-758
lines changed

exchange/docfx.json

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,10 @@
5959
"ms.date" : "09/25/2017",
6060
"ms.topic" : "reference",
6161
"ms.service" : "exchange-powershell",
62-
"ms.devlang" : "powershell"
62+
"ms.devlang" : "powershell",
63+
"feedback_system": "GitHub",
64+
"feedback_github_repo": "MicrosoftDocs/office-docs-powershell",
65+
"feedback_product_url": "https://github.com/MicrosoftDocs/office-docs-powershell/issues"
6366
},
6467
"fileMetadata": {},
6568
"template": [],

officewebapps/docfx.json

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,10 @@
5959
"ms.date" : "11/28/2017",
6060
"ms.topic" : "reference",
6161
"ms.prod" : "office-online-server-powershell",
62-
"ms.devlang" : "powershell"
62+
"ms.devlang" : "powershell",
63+
"feedback_system": "GitHub",
64+
"feedback_github_repo": "MicrosoftDocs/office-docs-powershell",
65+
"feedback_product_url": "https://github.com/MicrosoftDocs/office-docs-powershell/issues"
6366
},
6467
"fileMetadata": {},
6568
"template": [],

sharepoint/docfx.json

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,10 @@
5858
"manager" : "pamgreen",
5959
"ms.date" : "11/28/2017",
6060
"ms.topic" : "reference",
61-
"ms.devlang" : "powershell"
61+
"ms.devlang" : "powershell",
62+
"feedback_system": "GitHub",
63+
"feedback_github_repo": "MicrosoftDocs/office-docs-powershell",
64+
"feedback_product_url": "https://github.com/MicrosoftDocs/office-docs-powershell/issues"
6265
},
6366
"fileMetadata": {
6467
"ms.service":{
Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
---
2+
external help file:
3+
applicable: SharePoint Online
4+
title: Add-SPOTheme
5+
schema: 2.0.0
6+
---
7+
8+
# Add-SPOTheme
9+
10+
## SYNOPSIS
11+
12+
Creates a new custom theme, or overwrites an existing theme to modify its settings.
13+
14+
## DESCRIPTION
15+
16+
The **Add-SPOTheme** cmdlet creates a new theme or updates an existing theme. The color palette settings can be passed as either a hash table or a dictionary.
17+
18+
Adding a theme does not apply the theme to any sites. It adds the theme to your tenant store, and then the theme is available in the list of themes under the **Change the look** option for modern pages.
19+
20+
## EXAMPLES
21+
22+
### Example 1
23+
24+
In this example, a new theme named `"Custom Cyan"` is created, with color palette settings that are various shades of cyan. Note that the settings are passed as a hash table.
25+
26+
```powershell
27+
$themepallette = @{
28+
"themePrimary" = "#00ffff";
29+
"themeLighterAlt" = "#f3fcfc";
30+
"themeLighter" = "#daffff";
31+
"themeLight" = "#affefe";
32+
"themeTertiary" = "#76ffff";
33+
"themeSecondary" = "#39ffff";
34+
"themeDarkAlt" = "#00c4c4";
35+
"themeDark" = "#009090";
36+
"themeDarker" = "#005252";
37+
"neutralLighterAlt" = "#f8f8f8";
38+
"neutralLighter" = "#f4f4f4";
39+
"neutralLight" = "#eaeaea";
40+
"neutralQuaternaryAlt" = "#dadada";
41+
"neutralQuaternary" = "#d0d0d0";
42+
"neutralTertiaryAlt" = "#c8c8c8";
43+
"neutralTertiary" = "#a6a6a6";
44+
"neutralSecondaryAlt" = "#767676";
45+
"neutralSecondary" = "#666666";
46+
"neutralPrimary" = "#333";
47+
"neutralPrimaryAlt" = "#3c3c3c";
48+
"neutralDark" = "#212121";
49+
"black" = "#000000";
50+
"white" = "#fff";
51+
"primaryBackground" = "#fff";
52+
"primaryText" = "#333"
53+
}
54+
55+
Add-SPOTheme -Name "Custom Cyan" -Palette $themepallette -IsInverted $false
56+
```
57+
58+
> [!NOTE]
59+
> Prior to the December 2017 release of the SPO Management Shell, the **Add-SPOTheme** cmdlet required that color palette settings be passed as a dictionary. We recommend that you use the latest version of the SPO Management Shell, or use the `HashToDictionary` function to convert a hash table to a dictionary if needed.
60+
61+
### Example 2
62+
63+
If you want to update an existing theme (to modify some of its color settings, for example), use the same syntax as shown previously, but add the `-Overwrite` flag to the **Add-SPOTheme** cmdlet.
64+
65+
```powershell
66+
Add-SPOTheme -Name "Custom Cyan" -Palette $themepallette -IsInverted $false -Overwrite
67+
```
68+
69+
## INPUTS
70+
71+
## OUTPUTS
72+
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
external help file:
3+
applicable: SharePoint Online
4+
title: Get-SPOHideDefaultThemes
5+
schema: 2.0.0
6+
---
7+
8+
# Get-SPOHideDefaultThemes
9+
10+
## SYNOPSIS
11+
12+
Queries the current SPOHideDefaultThemes setting.
13+
14+
## DESCRIPTION
15+
16+
The **Get-SPOHideDefaultThemes** cmdlet retrieves the current **Set-SPOHideDefaultThemes** setting. You might want to use this cmdlet in a PowerShell script to read the setting and then take different actions based on whether the default themes are hidden. This cmdlet does not have any parameters.
17+
18+
Note that this cmdlet was named **Get-HideDefaultThemes** until the December 2017 release of the SPO Management Shell. We recommend that you use the latest version of the PowerShell cmdlets.
19+
20+
## EXAMPLES
21+
22+
### Example 1
23+
24+
```
25+
Get-SPOHideDefaultThemes $false
26+
```
27+
28+
29+
## INPUTS
30+
31+
## OUTPUTS
32+
Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
---
2+
external help file:
3+
applicable: SharePoint Online
4+
title: Get-SPOTheme
5+
schema: 2.0.0
6+
---
7+
8+
# Get-SPOTheme
9+
10+
## SYNOPSIS
11+
12+
Retrieves settings for an existing theme.
13+
14+
## DESCRIPTION
15+
16+
The **Get-SPOTheme** cmdlet returns the settings for a named existing theme, or for all uploaded themes if no name is provided.
17+
18+
## EXAMPLES
19+
20+
### Example 1
21+
22+
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.
23+
24+
```
25+
Get-SPOTheme -Name "Custom Cyan" | ConvertTo-Json
26+
```
27+
28+
29+
```
30+
{
31+
"Name": "Custom Cyan",
32+
"Palette": {
33+
"themeLight": "#affefe",
34+
"themeTertiary": "#76ffff",
35+
"black": "#000000",
36+
"neutralSecondary": "#666666",
37+
"neutralTertiaryAlt": "#c8c8c8",
38+
"themeSecondary": "#39ffff",
39+
"themeDarker": "#005252",
40+
"primaryBackground": "#fff",
41+
"neutralQuaternary": "#d0d0d0",
42+
"neutralPrimaryAlt": "#3c3c3c",
43+
"neutralPrimary": "#333",
44+
"themeDark": "#009090",
45+
"themeLighter": "#daffff",
46+
"neutralTertiary": "#a6a6a6",
47+
"neutralQuaternaryAlt": "#dadada",
48+
"themeLighterAlt": "#f3fcfc",
49+
"white": "#fff",
50+
"neutralSecondaryAlt": "#767676",
51+
"neutralLighter": "#f4f4f4",
52+
"neutralLight": "#eaeaea",
53+
"neutralDark": "#212121",
54+
"themeDarkAlt": "#00c4c4",
55+
"neutralLighterAlt": "#f8f8f8",
56+
"primaryText": "#333",
57+
"themePrimary": "#00ffff"
58+
},
59+
"IsInverted": false
60+
}
61+
```
62+
63+
### Example 2
64+
65+
To return all uploaded themes, use the **Get-SPOTheme** command with no arguments.
66+
67+
```
68+
Get-SPOTheme
69+
```
70+
71+
<!--(Commenting out this image because I don't see a way to have images in this location)
72+
73+
This is an example of the output from this command.
74+
75+
![Get-SPOTheme example](../../images/Get-SPOTheme-example.png)-->
76+
77+
## INPUTS
78+
79+
## OUTPUTS
80+
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
external help file:
3+
applicable: SharePoint Online
4+
title: Remove-SPOTheme
5+
schema: 2.0.0
6+
---
7+
8+
# Remove-SPOTheme
9+
10+
## SYNOPSIS
11+
12+
Removes a theme from the theme gallery.
13+
14+
## DESCRIPTION
15+
16+
The **Remove-SPOTheme** cmdlet removes a theme from your tenant store.
17+
18+
## EXAMPLES
19+
20+
### Example 1
21+
22+
This example removes the `"Custom Cyan"` theme that was used in the previous examples for the **Add-SPOTheme** and **Get-SPOTheme** cmdlets.
23+
24+
```
25+
Remove-SPOTheme -Name "Custom Cyan"
26+
```
27+
28+
## INPUTS
29+
30+
## OUTPUTS
31+
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
external help file:
3+
applicable: SharePoint Online
4+
title: Set-SPOHideDefaultThemes
5+
schema: 2.0.0
6+
---
7+
8+
# Set-SPOHideDefaultThemes
9+
10+
## SYNOPSIS
11+
12+
Specifies whether the default themes should be available.
13+
14+
## DESCRIPTION
15+
16+
The **Set-SPOHideDefaultThemes** cmdlet is used to specify whether the default themes that come with SharePoint should be included in the theme picker list. For example, you might want to create custom themes for your sites and then remove the default themes to ensure that all pages use your custom themes.
17+
18+
After creating the `"Custom Cyan"` theme, hiding the default themes leaves only the one custom theme in the themes list under **Change the look**.
19+
20+
Specify the setting as either `$true` to hide the default themes, or `$false` (the default setting) to allow use of the default themes.
21+
22+
Note that this cmdlet was named **Set-HideDefaultThemes** until the December 2017 release of the SPO Management Shell. We recommend that you use the latest version of the PowerShell cmdlets.
23+
24+
## EXAMPLES
25+
26+
### Example 1
27+
28+
In this example, the cmdlet hides the default themes.
29+
30+
```
31+
Set-SPOHideDefaultThemes $true
32+
```
33+
34+
### Example 2
35+
36+
In this example, the cmdlet restores the default themes to the theme picker list.
37+
38+
```
39+
Set-SPOHideDefaultThemes $false
40+
```
41+
42+
43+
## INPUTS
44+
45+
## OUTPUTS
46+

0 commit comments

Comments
 (0)