Skip to content

Commit d3ca383

Browse files
VesaJuvonenVesaJuvonen
committed
Adding documentation for Set-SPOSiteOffice365Group cmdlet
1 parent 37104b2 commit d3ca383

File tree

2 files changed

+173
-3
lines changed

2 files changed

+173
-3
lines changed

‎sharepoint/sharepoint-ps/sharepoint-online/Set-SPOHubSite.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,6 @@ Set-SPOHubSite [-Identity] <SpoHubSitePipeBind>
2323
## DESCRIPTION
2424
Use this cmdlet to set properties such as name, logo, and description. These properties appear for the hub in the SharePoint user interface.
2525

26-
> [!IMPORTANT]
27-
> This cmdlet is currently in preview and is subject to change. It is not currently supported for use in production environments.
28-
2926
If the hub site doesn’t exist, this cmdlet returns a “File not found” error.
3027

3128
## EXAMPLES

‎sharepoint/sharepoint-ps/sharepoint-online/Set-SPOSiteOffice365Group.md

Lines changed: 173 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,173 @@
1+
---
2+
external help file:
3+
applicable: SharePoint Online
4+
title: Set-SPOSiteOffice365Group
5+
schema: 2.0.0
6+
---
7+
8+
# Set-SPOSiteOffice365Group
9+
10+
## SYNOPSIS
11+
Connects a top-level SPO site collection to a new Office 365 Group.
12+
13+
## SYNTAX
14+
15+
```
16+
Set-SPOSiteOffice365Group
17+
-Site <string>
18+
-DisplayName <string>
19+
-Alias <string>
20+
[-IsPublic]
21+
[-Description <string>]
22+
[-Classification <string>]
23+
[-KeepOldHomepage]
24+
[<CommonParameters>]
25+
```
26+
27+
## DESCRIPTION
28+
Connects a top-level SPO site collection to a new Office 365 Group. You must be a SharePoint Online global administrator to run the cmdlet.
29+
30+
> [!IMPORTANT]
31+
> This cmdlet is currently in preview and is subject to change. It is not currently supported for use in production environments.
32+
33+
If the hub site doesn’t exist, this cmdlet returns a “File not found” error.
34+
35+
## EXAMPLES
36+
37+
### Example 1
38+
39+
This example creates a new Office 365 Group named "site1group" and connects site collection https://contoso.sharepoint.com/sites/site1 to it. The group will privacy set to "Private" and Classification set to "Highly Confidential".
40+
41+
```
42+
Set-SPOSiteOffice365Group `
43+
-Site https://contoso.sharepoint.com/sites/site1 `
44+
-DisplayName "site1group" `
45+
-Alias "site1group" `
46+
-Classification "Highly Confidential" `
47+
```
48+
49+
50+
## PARAMETERS
51+
52+
### -Site
53+
54+
The site collection being connected to new Office 365 Group.
55+
56+
```yaml
57+
Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind
58+
Parameter Sets: (All)
59+
Aliases:
60+
Applicable: SharePoint Online
61+
62+
Required: True
63+
Position: Named
64+
Default value: None
65+
Accept pipeline input: False
66+
Accept wildcard characters: False
67+
```
68+
69+
### -DisplayName
70+
71+
Specifies the name of the new Office 365 Group that will be created.
72+
73+
```yaml
74+
Type: String
75+
Parameter Sets: (All)
76+
Aliases:
77+
Applicable: SharePoint Online
78+
79+
Required: True
80+
Position: Named
81+
Default value: None
82+
Accept pipeline input: False
83+
Accept wildcard characters: False
84+
```
85+
86+
### -Alias
87+
88+
Specifies the email alias for the new Office 365 Group that will be created.
89+
90+
```yaml
91+
Type: String
92+
Parameter Sets: (All)
93+
Aliases:
94+
Applicable: SharePoint Online
95+
96+
Required: True
97+
Position: Named
98+
Default value: None
99+
Accept pipeline input: False
100+
Accept wildcard characters: False
101+
```
102+
103+
### -Description
104+
105+
Specifies the group’s description.
106+
107+
```yaml
108+
Type: String
109+
Parameter Sets: (All)
110+
Aliases:
111+
Applicable: SharePoint Online
112+
113+
Required: True
114+
Position: Named
115+
Default value: None
116+
Accept pipeline input: False
117+
Accept wildcard characters: False
118+
```
119+
120+
### -IsPublic
121+
122+
Determines the Office 365 Group’s privacy setting. If switch is included, the group will be public, otherwise it will be private.
123+
124+
```yaml
125+
Type: SwitchParameter
126+
Parameter Sets: (All)
127+
Aliases:
128+
Applicable: SharePoint Online
129+
130+
Required: False
131+
Position: Named
132+
Default value: None
133+
Accept pipeline input: False
134+
Accept wildcard characters: False
135+
```
136+
137+
### -Classification
138+
139+
Specifies the classification value, if classifications are set for the organization. If no value is provided, the default classification will be set, if one is configured.
140+
141+
See [Azure Active Directory cmdlets for configuring group settings](https://go.microsoft.com/fwlink/?LinkID=827484) and follow the steps in the Create settings at the directory level to define the classification for Office 365 groups.
142+
143+
See [Manage Office 365 Groups with PowerShell](https://support.office.com/en-us/article/Manage-Office-365-Groups-with-PowerShell-aeb669aa-1770-4537-9de2-a82ac11b0540) for more information.
144+
145+
```yaml
146+
Type: String
147+
Parameter Sets: (All)
148+
Aliases:
149+
Applicable: SharePoint Online
150+
151+
Required: False
152+
Position: Named
153+
Default value: None
154+
Accept pipeline input: False
155+
Accept wildcard characters: False
156+
```
157+
158+
### -KeepOldHomepage
159+
160+
For sites that already have a modern page set as homepage, you can specify whether you want to keep it as the homepage.
161+
162+
```yaml
163+
Type: SwitchParameter
164+
Parameter Sets: (All)
165+
Aliases:
166+
Applicable: SharePoint Online
167+
168+
Required: False
169+
Position: Named
170+
Default value: None
171+
Accept pipeline input: False
172+
Accept wildcard characters: False
173+
```

0 commit comments

Comments
 (0)