Skip to content

Commit be37337

Browse files
added 6 commandlets
1 parent 93b6713 commit be37337

File tree

2,080 files changed

+264837
-2
lines changed

Some content is hidden

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

2,080 files changed

+264837
-2
lines changed

sharepoint/.sourcemap-maml-0.json

Lines changed: 1 addition & 0 deletions
Large diffs are not rendered by default.

sharepoint/docs-conceptual/toc.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,5 +17,5 @@ items:
1717
href: https://pnp.github.io/powershell/
1818
- name: SharePoint Server
1919
href: sharepoint-server/sharepoint-server-cmdlets.md
20-
21-
20+
metadata:
21+
universal_ref_toc: /powershell/module/sharepoint-ps/toc.json
Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
### YamlMime:PowershellCmdlet
2+
summary: |-
3+
Adds a source to the **Content Security Policy** configuration.
4+
module: Microsoft.Online.SharePoint.PowerShell
5+
links:
6+
- text: Get-SPOContentSecurityPolicy
7+
href: Get-SPOContentSecurityPolicy.yml
8+
- text: Remove-SPOContentSecurityPolicy
9+
href: Remove-SPOContentSecurityPolicy.yml
10+
- text: Content Security Policy source values
11+
href: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/Sources#sources
12+
syntaxes:
13+
- Add-SPOContentSecurityPolicy [-Source] <String>
14+
parameters:
15+
- type: <xref href="String" data-throw-if-not-resolved="False" />
16+
name: Source
17+
isRequired: true
18+
description: |+
19+
Source to be added to the **Content Security Policy** configuration.
20+
21+
defaultValue: None
22+
position: "0"
23+
aliases: ""
24+
applicable:
25+
- SharePoint Online
26+
parameterValueGroup: ""
27+
applicable:
28+
- SharePoint Online
29+
uid: Microsoft.Online.SharePoint.PowerShell.Add-SPOContentSecurityPolicy
30+
name: Add-SPOContentSecurityPolicy
31+
description: |-
32+
Adds a source to the **Content Security Policy** configuration.
33+
The source will be added to the `script-src` directive during construction of the `Content-Security-Policy` header.
34+
In multi-geo environments, **Content Security Policy** configuration is unique to each geo.
35+
metadata:
36+
external help file: ""
37+
Module Name: Microsoft.Online.SharePoint.PowerShell
38+
online version: https://learn.microsoft.com/powershell/module/sharepoint-online/add-spocontentsecuritypolicy
39+
applicable: SharePoint Online
40+
title: Add-SPOContentSecurityPolicy
41+
PlatyPS schema version: 2.0.0
42+
author: jaobrie
43+
ms.author: jaobrie
44+
manager: ryannak
45+
ms.reviewer: ""
Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
### YamlMime:PowershellCmdlet
2+
summary: |-
3+
Adds a new SharePoint user or security group as GeoAdministrator to a multi-geo tenant.
4+
module: Microsoft.Online.SharePoint.PowerShell
5+
notes: ""
6+
links:
7+
- text: Getting started with SharePoint Online Management Shell
8+
href: https://learn.microsoft.com/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps
9+
- text: Get-SPOAppErrors
10+
href: Get-SPOAppErrors.yml
11+
- text: Get-SPOGeoAdministrator
12+
href: Get-SPOGeoAdministrator.yml
13+
- text: Remove-SPOGeoAdministrator
14+
href: Remove-SPOGeoAdministrator.yml
15+
syntaxes:
16+
- Add-SPOGeoAdministrator [-UserPrincipalName] <String> [<CommonParameters>]
17+
- Add-SPOGeoAdministrator [-GroupAlias] <String> [<CommonParameters>]
18+
- Add-SPOGeoAdministrator [-ObjectId] <Guid> [<CommonParameters>]
19+
examples:
20+
- title: EXAMPLE 1
21+
code: |-
22+
Add-SPOGeoAdministrator -UserPrincipalName [email protected]
23+
description: |-
24+
Adds the user **admin\@contoso.onmicrosoft.com** as administrator to the SharePoint Online multi-geo tenant.
25+
summary: ""
26+
parameters:
27+
- type: <xref href="String" data-throw-if-not-resolved="False" />
28+
name: GroupAlias
29+
isRequired: true
30+
description: |+
31+
Use this parameter to add a security group or a mail-enabled security group as a geo admin. (Distribution groups and Microsoft 365 Groups are not supported).
32+
33+
defaultValue: None
34+
position: "0"
35+
aliases: ""
36+
applicable:
37+
- SharePoint Online
38+
parameterValueGroup: ""
39+
- type: <xref href="Guid" data-throw-if-not-resolved="False" />
40+
name: ObjectId
41+
isRequired: true
42+
description: |+
43+
Not all security groups have a group alias. If you want to add a security group that does not have an alias, run Get-MsolGroup to retrieve a list of groups, find your security group's ObjectID, and then use this parameter. For more information, see [Add or remove a geo administrator in Microsoft 365 Multi-Geo](https://learn.microsoft.com/office365/enterprise/add-a-sharepoint-geo-admin).
44+
45+
defaultValue: None
46+
position: "0"
47+
aliases: ""
48+
applicable:
49+
- SharePoint Online
50+
parameterValueGroup: ""
51+
- type: <xref href="String" data-throw-if-not-resolved="False" />
52+
name: UserPrincipalName
53+
isRequired: true
54+
description: |+
55+
UserPrincipalName or UPN defined for the specific user on the SharePoint Online tenant.
56+
57+
defaultValue: None
58+
position: "0"
59+
aliases: ""
60+
applicable:
61+
- SharePoint Online
62+
parameterValueGroup: ""
63+
applicable:
64+
- SharePoint Online
65+
uid: Microsoft.Online.SharePoint.PowerShell.Add-SPOGeoAdministrator
66+
name: Add-SPOGeoAdministrator
67+
description: |-
68+
This cmdlet requires a connection to a multi-geo tenant to run correctly.
69+
You must be a SharePoint Online administrator to run this cmdlet.
70+
metadata:
71+
external help file: sharepointonline.xml
72+
Module Name: Microsoft.Online.SharePoint.PowerShell
73+
online version: https://learn.microsoft.com/powershell/module/sharepoint-online/add-spogeoadministrator
74+
applicable: SharePoint Online
75+
title: Add-SPOGeoAdministrator
76+
PlatyPS schema version: 2.0.0
77+
author: trent-green
78+
ms.author: trgreen
79+
ms.reviewer: ""
80+
ms.custom: has-azure-ad-ps-ref
Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
### YamlMime:PowershellCmdlet
2+
summary: |-
3+
Associates a site with a hub site.
4+
module: Microsoft.Online.SharePoint.PowerShell
5+
notes: |-
6+
If the site or hub site doesn't exist, this cmdlet returns a "File not found" error.
7+
8+
If the site is already a hub site, this cmdlet returns a "This site is already a HubSite" error.
9+
10+
In multi-geo situations, when assigning a hub that is across geo locations, you must pass the site ID of the hub site to the HubSite parameter as a URL will fail.
11+
syntaxes:
12+
- Add-SPOHubSiteAssociation [-Site] <SpoSitePipeBind> -HubSite <SpoHubSitePipeBind> [<CommonParameters>]
13+
examples:
14+
- title: Example 1
15+
code: |-
16+
Add-SPOHubSiteAssociation https://contoso.sharepoint.com/sites/Research -HubSite https://contoso.sharepoint.com/sites/Marketing
17+
description: |-
18+
This example associates the research site with the marketing hub site.
19+
summary: ""
20+
parameters:
21+
- type: <xref href="SpoSitePipeBind" data-throw-if-not-resolved="False" />
22+
name: HubSite
23+
isRequired: true
24+
description: |+
25+
URL or Site ID of the hub site.
26+
27+
defaultValue: None
28+
position: Named
29+
aliases: ""
30+
applicable:
31+
- SharePoint Online
32+
parameterValueGroup: ""
33+
- type: <xref href="SpoSitePipeBind" data-throw-if-not-resolved="False" />
34+
name: Site
35+
isRequired: true
36+
description: |+
37+
URL of the site to join to the hub site.
38+
39+
defaultValue: None
40+
pipelineInput: true
41+
position: "0"
42+
aliases: ""
43+
applicable:
44+
- SharePoint Online
45+
parameterValueGroup: ""
46+
applicable:
47+
- SharePoint Online
48+
uid: Microsoft.Online.SharePoint.PowerShell.Add-SPOHubSiteAssociation
49+
name: Add-SPOHubSiteAssociation
50+
description: |-
51+
Use this cmdlet to associate a site with a hub site.
52+
metadata:
53+
external help file: sharepointonline.xml
54+
Module Name: Microsoft.Online.SharePoint.PowerShell
55+
online version: https://learn.microsoft.com/powershell/module/sharepoint-online/add-spohubsiteassociation
56+
applicable: SharePoint Online
57+
title: Add-SPOHubSiteAssociation
58+
PlatyPS schema version: 2.0.0
59+
author: trent-green
60+
ms.author: trgreen
61+
ms.reviewer: ""
Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
### YamlMime:PowershellCmdlet
2+
summary: |-
3+
Associates a hub site to a hub site.
4+
Note: This feature is currently in preview and may not be available in your tenant.
5+
module: Microsoft.Online.SharePoint.PowerShell
6+
notes: |-
7+
SPOHubToHubAssociation is just a placeholder and not yet ready for production.
8+
syntaxes:
9+
- Add-SPOHubToHubAssociation [-Source] <SpoHubSitePipeBind> -Target <SpoHubSitePipeBind> [<CommonParameters>]
10+
examples:
11+
- title: Example 1
12+
code: |-
13+
Add-SPOHubToHubAssociation -Source 7b6fd3a3-b029-4eb0-8e00-ba4a3949807d -Target 43a36572-37ec-45c3-9058-061a2db4cd26
14+
description: |-
15+
This example associates the source hub site with the HubSiteId 7b6fd3a3-b029-4eb0-8e00-ba4a3949807d with the target hub site with the HubSiteId 43a36572-37ec-45c3-9058-061a2db4cd26.
16+
summary: ""
17+
parameters:
18+
- type: <xref href="SpoHubSitePipeBind" data-throw-if-not-resolved="False" />
19+
name: Source
20+
isRequired: true
21+
description: |+
22+
HubSiteId of the Source Hub site to be associated with the Target Hub Site.
23+
24+
defaultValue: None
25+
pipelineInput: true
26+
position: "0"
27+
aliases: ""
28+
applicable:
29+
- SharePoint Online
30+
parameterValueGroup: ""
31+
- type: <xref href="SpoHubSitePipeBind" data-throw-if-not-resolved="False" />
32+
name: Target
33+
isRequired: true
34+
description: |+
35+
HubSiteId of the Target Hub to associate the source Hub to.
36+
37+
defaultValue: None
38+
position: Named
39+
aliases: ""
40+
applicable:
41+
- SharePoint Online
42+
parameterValueGroup: ""
43+
applicable:
44+
- SharePoint Online
45+
uid: Microsoft.Online.SharePoint.PowerShell.Add-SPOHubToHubAssociation
46+
name: Add-SPOHubToHubAssociation
47+
description: |-
48+
Use this cmdlet to associate a hub site to a hub site.
49+
metadata:
50+
external help file: sharepointonline.xml
51+
Module Name: Microsoft.Online.SharePoint.PowerShell
52+
online version: https://learn.microsoft.com/powershell/module/sharepoint-online/add-spohubtohubassociation
53+
applicable: SharePoint Online
54+
title: Add-SPOHubToHubAssociation
55+
PlatyPS schema version: 2.0.0
56+
author: techwriter40
57+
ms.author: pamgreen
58+
ms.reviewer: ""
Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
### YamlMime:PowershellCmdlet
2+
summary: |-
3+
Creates a new list or document library design available to users when they create a new list or document library from site contents, certain site home pages, the SharePoint home page, the Microsoft Lists app, Microsoft Teams, or Office.com.
4+
module: Microsoft.Online.SharePoint.PowerShell
5+
notes: ""
6+
inputs:
7+
- name: <xref href="None" data-throw-if-not-resolved="False" />
8+
description: ""
9+
outputs:
10+
- name: <xref href="System.Object" data-throw-if-not-resolved="False" />
11+
description: ""
12+
syntaxes:
13+
- >-
14+
Add-SPOListDesign -Title <String> -SiteScripts <SPOSiteScriptPipeBind[]> [-Description <String>]
15+
[-ThumbnailUrl <String>] [-TemplateFeatures <String[]>] [-ListColor <SPOListDesignColor>]
16+
[-ListIcon <SPOListDesignIcon>] [<CommonParameters>]
17+
examples:
18+
- title: Example 1
19+
code: |-
20+
PS > Add-SPOListDesign
21+
-Title "Contoso customer tracking"
22+
-Description "Tracks key customer data in a list"
23+
-SiteScripts "<ID>"
24+
-ListColor Orange
25+
-ListIcon BullseyeTarget
26+
-Thumbnail "https://contoso.sharepoint.com/SiteAssets/site-thumbnail.png"
27+
description: |-
28+
This example creates a new list or document library design.
29+
summary: ""
30+
parameters:
31+
- type: <xref href="String" data-throw-if-not-resolved="False" />
32+
name: Description
33+
description: |+
34+
The display description of the list or document library design.
35+
36+
defaultValue: None
37+
position: Named
38+
aliases: ""
39+
parameterValueGroup: ""
40+
- type: <xref href="SPOListDesignColor" data-throw-if-not-resolved="False" />
41+
name: ListColor
42+
description: |+
43+
Default color associated with the list when creating the list.
44+
45+
defaultValue: None
46+
position: Named
47+
aliases: ""
48+
parameterValueGroup: DarkRed, Red, Orange, Green, DarkGreen, Teal, Blue, NavyBlue, BluePurple, DarkBlue, Lavendar, Pink
49+
- type: <xref href="SPOListDesignIcon" data-throw-if-not-resolved="False" />
50+
name: ListIcon
51+
description: |+
52+
Default icon associated with the list when creating the list.
53+
54+
defaultValue: None
55+
position: Named
56+
aliases: ""
57+
parameterValueGroup: Bug, Calendar, BullseyeTarget, ClipboardList, Airplane, Rocket, Color, Insights, CubeShape, TestBeakerSolid, Robot, Savings
58+
- type: <xref href="SPOSiteScriptPipeBind" data-throw-if-not-resolved="False" /><span>[</span><span>]</span>
59+
name: SiteScripts
60+
isRequired: true
61+
description: |+
62+
An array of one or more site scripts. Each is identified by an ID. The scripts run in the order listed.
63+
64+
defaultValue: None
65+
position: Named
66+
aliases: ""
67+
parameterValueGroup: ""
68+
- type: <xref href="String" data-throw-if-not-resolved="False" /><span>[</span><span>]</span>
69+
name: TemplateFeatures
70+
description: |+
71+
Set of features that the template comes with. It is displayed as a bulleted list when the user is looking at the template preview in the list or document library creation dialog.
72+
73+
defaultValue: None
74+
position: Named
75+
aliases: ""
76+
parameterValueGroup: ""
77+
- type: <xref href="String" data-throw-if-not-resolved="False" />
78+
name: ThumbnailUrl
79+
description: |+
80+
The URL of a thumbnail image. If none is specified, SharePoint uses a generic image. Recommended size is 400 x 300 pixels.
81+
82+
defaultValue: None
83+
position: Named
84+
aliases: ""
85+
parameterValueGroup: ""
86+
- type: <xref href="String" data-throw-if-not-resolved="False" />
87+
name: Title
88+
isRequired: true
89+
description: |+
90+
The display name of the list or document library design.
91+
92+
defaultValue: None
93+
position: Named
94+
aliases: ""
95+
parameterValueGroup: ""
96+
uid: Microsoft.Online.SharePoint.PowerShell.Add-SPOListDesign
97+
name: Add-SPOListDesign
98+
description: |-
99+
Creates a new list or document library design available to users when they create a new list or document library from the SharePoint home page, the Microsoft Lists app, Microsoft Teams, or Office.com.
100+
101+
List designs will be available in UI where lists are created, and document library designs will be available in UI where document libraries are created. The difference is based on the "templateType" of the site design used. "templateType" 100 is for Lists, "templateType" 101 is for document libraries.
102+
metadata:
103+
external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml
104+
Module Name: Microsoft.Online.SharePoint.PowerShell
105+
online version: https://learn.microsoft.com/powershell/module/sharepoint-online/add-spolistdesign
106+
PlatyPS schema version: 2.0.0
107+
author: reedpamsft
108+
ms.author: reedpa
109+
ms.reviewer: ""
110+
title: Add-SPOListDesign

0 commit comments

Comments
 (0)