Skip to content

Commit dab7ab2

Browse files
authored
Merge branch 'master' into patch-1
2 parents 89c810a + f635d6b commit dab7ab2

16 files changed

+778
-114
lines changed

sharepoint/sharepoint-ps/sharepoint-online/ConvertTo-SPOMigrationTargetedPackage.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,13 +35,13 @@ ConvertTo-SPOMigrationTargetedPackage [-SourceFilesPath] <String> [-SourcePackag
3535
```
3636

3737
## DESCRIPTION
38-
Use this Cmdlets to create a migration package from one Library to Another Library in form of a package. It converts the XML files and saves them as a new set of targeted migration package metadata files to the target directory.
38+
Use this cmdlet to create a migration package from one Library to Another Library in form of a package. It converts the XML files and saves them as a new set of targeted migration package metadata files to the target directory.
3939

4040

4141
## EXAMPLES
4242

4343
### Example 1
44-
This example shows how to convert a package to a targeted one by looking up data in the target site collection. It uses the ParallelImport parameter to boost file share migration performance.
44+
This example shows how to convert a package to a targeted one by looking up data in the target site collection. It uses the '-ParallelImport' parameter to boost file share migration performance.
4545
```Powershell
4646
$finalPackages = ConvertTo-SPOMigrationTargetedPackage -ParallelImport -SourceFilesPath $sourceFiles -SourcePackagePath $sourcePackage -OutputPackagePath $targetPackage -Credentials $cred -TargetWebUrl $targetWeb -TargetDocumentLibraryPath $targetDocLib
4747
```

sharepoint/sharepoint-ps/sharepoint-online/Enable-SPOTenantServicePrincipal.md

Lines changed: 54 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,17 +16,70 @@ Enables the current tenant's "SharePoint Online Client" service principal.
1616
## SYNTAX
1717

1818
```powershell
19-
Enable-SPOTenantServicePrincipal
19+
Enable-SPOTenantServicePrincipal [-WhatIf] [-Confirm] [<CommonParameters>]
2020
```
2121

2222
## DESCRIPTION
23+
2324
Enables the current tenant's "SharePoint Online Client" service principal.
2425

2526
## EXAMPLES
2627

2728
### ------------------EXAMPLE 1------------------
29+
2830
```powershell
2931
Enable-SPOTenantServicePrincipal
3032
```
3133

3234
Enables the current tenant's "SharePoint Online Client" service principal.
35+
36+
## PARAMETERS
37+
38+
### -Confirm
39+
40+
Prompts you for confirmation before running the cmdlet.
41+
42+
```yaml
43+
Type: SwitchParameter
44+
Parameter Sets: (All)
45+
Aliases: cf
46+
47+
Required: False
48+
Position: Named
49+
Default value: None
50+
Accept pipeline input: False
51+
Accept wildcard characters: False
52+
```
53+
54+
### -WhatIf
55+
56+
Shows what would happen if the cmdlet runs.
57+
The cmdlet is not run.
58+
59+
```yaml
60+
Type: SwitchParameter
61+
Parameter Sets: (All)
62+
Aliases: wi
63+
64+
Required: False
65+
Position: Named
66+
Default value: None
67+
Accept pipeline input: False
68+
Accept wildcard characters: False
69+
```
70+
71+
### CommonParameters
72+
73+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
74+
75+
## INPUTS
76+
77+
### None
78+
79+
## OUTPUTS
80+
81+
### System.Object
82+
83+
## NOTES
84+
85+
## RELATED LINKS

sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteScriptFromWeb.md

Lines changed: 23 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ ms.reviewer:
1212

1313
## SYNOPSIS
1414

15-
.
15+
Creates site script syntax from an existing SharePoint site.
1616

1717
## SYNTAX
1818

@@ -22,23 +22,34 @@ Get-SPOSiteScriptFromWeb [-WebUrl] <string> [-IncludedLists <string[]>] [-Includ
2222

2323
## DESCRIPTION
2424

25-
Use this cmdlet to .
25+
Uses an existing SharePoint site to output a JSON blob that can be used to create a site script for use in a site design.
2626

2727
## EXAMPLES
2828

2929
### Example 1
3030

31+
This example creates the site script output from an existing site - and writes it to a variable. This variable is then referenced to create a site script.
32+
3133
```powershell
32-
Get-SPOSiteScriptFromWeb -WebUrl
34+
C:\> $extracted = Get-SPOSiteScriptFromWeb `
35+
-WebUrl https://contoso.sharepoint.com/sites/template `
36+
-IncludeBranding `
37+
-IncludeTheme `
38+
-IncludeRegionalSettings `
39+
-IncludeSiteExternalSharingCapability `
40+
-IncludeLinksToExportedItems `
41+
-IncludedLists ("Shared Documents", "Lists/Project Activities")
42+
C:\> Add-SPOSiteScript `
43+
-Title "Contoso template site" `
44+
-Description "This is a copy of a site collection." `
45+
-Content $extracted
3346
```
3447

35-
This example .
36-
3748
## PARAMETERS
3849

3950
### -WebUrl
4051

41-
.
52+
The url that starts with HTTPS of the site to retrieve the site script.
4253

4354
```yaml
4455
Type: string
@@ -54,7 +65,7 @@ Accept wildcard characters: False
5465
5566
### -IncludedLists
5667
57-
.
68+
An array of one or more lists. Each is identified by the list url.
5869
5970
```yaml
6071
Type: string[]
@@ -70,7 +81,7 @@ Accept wildcard characters: False
7081
7182
### -IncludeBranding
7283
73-
.
84+
A switch that if provided, extracts the configuration of the site's branding.
7485
7586
```yaml
7687
Type: SwitchParameter
@@ -86,7 +97,7 @@ Accept wildcard characters: False
8697
8798
### -IncludeTheme
8899
89-
.
100+
A switch that if provided, extracts the site's custom theme by using the themeJson property.
90101
91102
```yaml
92103
Type: SwitchParameter
@@ -102,7 +113,7 @@ Accept wildcard characters: False
102113
103114
### -IncludeRegionalSettings
104115
105-
.
116+
A switch that if provided, extracts the site's regional settings.
106117
107118
```yaml
108119
Type: SwitchParameter
@@ -118,7 +129,7 @@ Accept wildcard characters: False
118129
119130
### -IncludeSiteExternalSharingCapability
120131
121-
.
132+
A switch that if provided, extracts the site's external sharing capability.
122133
123134
```yaml
124135
Type: SwitchParameter
@@ -134,7 +145,7 @@ Accept wildcard characters: False
134145
135146
### -IncludeLinksToExportedItems
136147
137-
.
148+
A switch that if provided, extracts navigation links. In order to export navigation links pointing to lists, the list needs to be included in the request as well.
138149
139150
```yaml
140151
Type: SwitchParameter
@@ -151,5 +162,3 @@ Accept wildcard characters: False
151162
### CommonParameters
152163
153164
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216).
154-
155-
## NOTES

sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOTheme.md

Lines changed: 70 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,21 +14,89 @@ ms.reviewer:
1414

1515
Removes a theme from the theme gallery.
1616

17+
## SYNTAX
18+
19+
```powershell
20+
Remove-SPOTheme [-Identity] <SpoThemePipeBind> [-WhatIf] [-Confirm] [<CommonParameters>]
21+
```
22+
1723
## DESCRIPTION
1824

19-
The **Remove-SPOTheme** cmdlet removes a theme from your tenant store.
25+
The **Remove-SPOTheme** cmdlet removes a theme from your tenant store.
2026

2127
## EXAMPLES
2228

2329
### Example 1
2430

2531
This example removes the `"Custom Cyan"` theme that was used in the previous examples for the **Add-SPOTheme** and **Get-SPOTheme** cmdlets.
2632

27-
```
33+
```powershell
2834
Remove-SPOTheme -Name "Custom Cyan"
2935
```
3036

37+
## PARAMETERS
38+
39+
### -Confirm
40+
41+
Prompts you for confirmation before running the cmdlet.
42+
43+
```yaml
44+
Type: SwitchParameter
45+
Parameter Sets: (All)
46+
Aliases: cf
47+
48+
Required: False
49+
Position: Named
50+
Default value: None
51+
Accept pipeline input: False
52+
Accept wildcard characters: False
53+
```
54+
55+
### -Identity
56+
57+
{{ Fill Identity Description }}
58+
59+
```yaml
60+
Type: SpoThemePipeBind
61+
Parameter Sets: (All)
62+
Aliases: Name
63+
64+
Required: True
65+
Position: 0
66+
Default value: None
67+
Accept pipeline input: True (ByValue)
68+
Accept wildcard characters: False
69+
```
70+
71+
### -WhatIf
72+
73+
Shows what would happen if the cmdlet runs.
74+
The cmdlet is not run.
75+
76+
```yaml
77+
Type: SwitchParameter
78+
Parameter Sets: (All)
79+
Aliases: wi
80+
81+
Required: False
82+
Position: Named
83+
Default value: None
84+
Accept pipeline input: False
85+
Accept wildcard characters: False
86+
```
87+
88+
### CommonParameters
89+
90+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
91+
3192
## INPUTS
3293
94+
### Microsoft.Online.SharePoint.PowerShell.SpoThemePipeBind
95+
3396
## OUTPUTS
3497
98+
### System.Object
99+
100+
## NOTES
101+
102+
## RELATED LINKS

sharepoint/sharepoint-ps/sharepoint-online/Set-SPOBrowserIdleSignOut.md

Lines changed: 58 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,51 +3,99 @@ external help file: sharepointonline.xml
33
applicable: SharePoint Online
44
title: Set-SPOBrowserIdleSignOut
55
schema: 2.0.0
6-
author:
7-
ms.author:
6+
author: trent-green
7+
ms.author: trgreen
88
ms.reviewer:
99
---
1010

1111
# Set-SPOBrowserIdleSignOut
1212

1313
## SYNOPSIS
14+
1415
.
1516

1617
## SYNTAX
1718

18-
```
19-
Set-SPOBrowserIdleSignOut
19+
```powershell
20+
Set-SPOBrowserIdleSignOut [-Enabled] <Boolean> [[-WarnAfter] <TimeSpan>] [[-SignOutAfter] <TimeSpan>] [<CommonParameters>]
2021
```
2122

2223
## DESCRIPTION
24+
2325
Use this cmdlet to .
2426

2527
## EXAMPLES
2628

2729
### Example 1
2830

29-
```
31+
```powershell
3032
3133
```
3234

3335
This example .
3436

3537
## PARAMETERS
3638

37-
### -
39+
### -Enabled
3840

39-
.
41+
{{ Fill Enabled Description }}
4042

4143
```yaml
42-
Type: SpoSitePipeBind
44+
Type: Boolean
4345
Parameter Sets: (All)
44-
Aliases:
45-
Applicable: SharePoint Online
46+
Aliases:
47+
4648
Required: True
4749
Position: Named
4850
Default value: None
4951
Accept pipeline input: False
5052
Accept wildcard characters: False
5153
```
5254
55+
### -SignOutAfter
56+
57+
{{ Fill SignOutAfter Description }}
58+
59+
```yaml
60+
Type: TimeSpan
61+
Parameter Sets: (All)
62+
Aliases:
63+
64+
Required: False
65+
Position: Named
66+
Default value: None
67+
Accept pipeline input: False
68+
Accept wildcard characters: False
69+
```
70+
71+
### -WarnAfter
72+
73+
{{ Fill WarnAfter Description }}
74+
75+
```yaml
76+
Type: TimeSpan
77+
Parameter Sets: (All)
78+
Aliases:
79+
80+
Required: False
81+
Position: Named
82+
Default value: None
83+
Accept pipeline input: False
84+
Accept wildcard characters: False
85+
```
86+
87+
### CommonParameters
88+
89+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
90+
91+
## INPUTS
92+
93+
### None
94+
95+
## OUTPUTS
96+
97+
### System.Object
98+
5399
## NOTES
100+
101+
## RELATED LINKS

0 commit comments

Comments
 (0)