Skip to content

Commit d102f7d

Browse files
committed
Added Examples and Parameters
1 parent d05a9dc commit d102f7d

File tree

1 file changed

+92
-14
lines changed

1 file changed

+92
-14
lines changed

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

Lines changed: 92 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -55,12 +55,47 @@ For permissions and the most current information about Windows PowerShell for Sh
5555

5656
## EXAMPLES
5757

58-
### Example 1: Set a new title for an existing site collection
58+
### -----------------------EXAMPLE 1-----------------------------
5959
```
60-
PS C:\> Set-SPOSite -Identity https://contoso.sharepoint.com/sites/demo -Title "New Title"
60+
Set-SPOSite -Identity https://contoso.sharepoint.com/sites/site1 -Owner [email protected] -NoWait
6161
```
6262

63-
This command sets a new title for an existing site collection
63+
Example 1 updates the owner of site collection https://contoso.sharepoint.com/sites/site1 to the person whose email address is [email protected]. This cmdlet is executed immediately without delay.
64+
65+
66+
### -----------------------EXAMPLE 2-----------------------------
67+
```
68+
Set-SPOSite -Identity https://contoso.sharepoint.com/sites/site1 -ResourceQuota 0 -StorageQuota 15000
69+
```
70+
71+
Example 2 updates the settings of site collection https://contoso.sharepoint.com/sites/site1. The storage quota is updated to 15000 megabytes and the resource quota is updated to 0 megabytes.
72+
73+
74+
### -----------------------EXAMPLE 3-----------------------------
75+
```
76+
Set-SPOSite -Identity https://contoso.sharepoint.com -StorageQuota 3000 -StorageQuotaWarningLevel 2000
77+
```
78+
79+
This example updates the settings of site collection https://contoso.sharepoint.com. The storage quota is updated to 3000 megabytes and the storage quota warning level is updated to 2000 megabytes.
80+
81+
82+
### -----------------------EXAMPLE 4-----------------------------
83+
```
84+
Set-SPOSite -Identity https://contoso.sharepoint.com -DisableSharingForNonOwners
85+
```
86+
87+
Example 4 prevents non-owners of a site from inviting new users to the site.
88+
89+
90+
### -----------------------EXAMPLE 5-----------------------------
91+
```
92+
Set-SPOSite -Identity https://contoso.sharepoint.com/sites/groupname -StorageQuota 3000 -StorageQuotaWarningLevel 2000
93+
```
94+
95+
This example sets the quota for the site.
96+
97+
Note:
98+
If Site Collection Storage Management is enabled for the tenant, you will not be able to set quota and will have a generic error returned. To workaround this issue, set the site collection storage management to "manual" temporarily, set your quotas and then set the site collection storage management setting back to its original setting.
6499

65100

66101
## PARAMETERS
@@ -69,6 +104,7 @@ This command sets a new title for an existing site collection
69104
Determines whether site can include Project Web App.
70105
For more information about Project Web App, see Plan SharePoint groups in Project Server.
71106

107+
72108
```yaml
73109
Type: Boolean
74110
Parameter Sets: ParamSet2
@@ -85,6 +121,7 @@ Accept wildcard characters: False
85121
### -Identity
86122
Specifies the URL of the site collection to update.
87123
124+
88125
```yaml
89126
Type: SpoSitePipeBind
90127
Parameter Sets: (All)
@@ -101,6 +138,7 @@ Accept wildcard characters: False
101138
### -AllowSelfServiceUpgrade
102139
Determines whether site collection administrators can upgrade their site collections.
103140
141+
104142
```yaml
105143
Type: Boolean
106144
Parameter Sets: ParamSet1
@@ -117,6 +155,7 @@ Accept wildcard characters: False
117155
### -Confirm
118156
PARAMVALUE: SwitchParameter
119157
158+
120159
```yaml
121160
Type: SwitchParameter
122161
Parameter Sets: (All)
@@ -134,6 +173,7 @@ Accept wildcard characters: False
134173
Determines whether the Add And Customize Pages right is denied on the site collection.
135174
For more information about permission levels, see User permissions and permission levels in SharePoint.
136175
176+
137177
```yaml
138178
Type: Boolean
139179
Parameter Sets: ParamSet1
@@ -152,6 +192,7 @@ This parameter prevents non-owners from invited new users to the site.
152192
153193
This parameter is available only in SharePoint Online Management Shell Version 16.0.4613.1211 or later.
154194
195+
155196
```yaml
156197
Type: SwitchParameter
157198
Parameter Sets: ParamSet3
@@ -169,6 +210,7 @@ Accept wildcard characters: False
169210
Specifies the language of this site collection.
170211
For more information, see Locale IDs Assigned by Microsoft (http://go.microsoft.com/fwlink/p/?LinkId=242911) (http://go.microsoft.com/fwlink/p/?LinkId=242911).
171212
213+
172214
```yaml
173215
Type: UInt32
174216
Parameter Sets: ParamSet1
@@ -189,6 +231,7 @@ When the lock state of a site is NoAccess, all traffic to the site will be block
189231
If parameter NoAccessRedirectUrl in the `Set-SPOTenant` cmdlet is set, traffic to sites that have a lock state NoAccess will be redirected to that URL.
190232
If parameter NoAccessRedirectUrl is not set, a 403 error will be returned.
191233

234+
192235
```yaml
193236
Type: String
194237
Parameter Sets: ParamSet1
@@ -205,6 +248,7 @@ Accept wildcard characters: False
205248
### -NoWait
206249
Specifies to continue executing script immediately.
207250

251+
208252
```yaml
209253
Type: SwitchParameter
210254
Parameter Sets: ParamSet1
@@ -221,6 +265,7 @@ Accept wildcard characters: False
221265
### -Owner
222266
Specifies the owner of the site collection.
223267

268+
224269
```yaml
225270
Type: String
226271
Parameter Sets: ParamSet1
@@ -239,6 +284,7 @@ Specifies the resource quota in megabytes of the site collection.
239284
The default value is 0.
240285
For more information, see Resource Usage Limits on Sandboxed Solutions in SharePoint (http://msdn.microsoft.com/en-us/library/gg615462.aspx) (http://msdn.microsoft.com/en-us/library/gg615462.aspx).
241286

287+
242288
```yaml
243289
Type: Double
244290
Parameter Sets: ParamSet1
@@ -255,6 +301,7 @@ Accept wildcard characters: False
255301
### -ResourceQuotaWarningLevel
256302
Specifies the warning level in megabytes of the site collection to warn the site collection administrator that the site is approaching the resource quota.
257303

304+
258305
```yaml
259306
Type: Double
260307
Parameter Sets: ParamSet1
@@ -271,6 +318,7 @@ Accept wildcard characters: False
271318
### -SandboxedCodeActivationCapability
272319
PARAMVALUE: Unknown | Check | Disabled | Enabled
273320

321+
274322
```yaml
275323
Type: SandboxedCodeActivationCapabilities
276324
Parameter Sets: ParamSet1
@@ -290,6 +338,7 @@ The possible values are: Disabled - external user sharing (share by email) and g
290338

291339
For more information about sharing, see Manage external sharing for your SharePoint online environment (http://office.microsoft.com/en-us/office365-sharepoint-online-enterprise-help/manage-external-sharing-for-your-sharepoint-online-environment-HA102849864.aspx).
292340

341+
293342
```yaml
294343
Type: SharingCapabilities
295344
Parameter Sets: ParamSet1
@@ -306,6 +355,7 @@ Accept wildcard characters: False
306355
### -StorageQuota
307356
Specifies the storage quota in megabytes of the site collection.
308357

358+
309359
```yaml
310360
Type: Int64
311361
Parameter Sets: ParamSet1
@@ -322,6 +372,7 @@ Accept wildcard characters: False
322372
### -StorageQuotaWarningLevel
323373
Specifies the warning level in megabytes of the site collection to warn the site collection administrator that the site is approaching the storage quota.
324374

375+
325376
```yaml
326377
Type: Int64
327378
Parameter Sets: ParamSet1
@@ -338,6 +389,7 @@ Accept wildcard characters: False
338389
### -Title
339390
Specifies the title of the site collection.
340391

392+
341393
```yaml
342394
Type: String
343395
Parameter Sets: ParamSet1
@@ -354,6 +406,7 @@ Accept wildcard characters: False
354406
### -WhatIf
355407
PARAMVALUE: SwitchParameter
356408

409+
357410
```yaml
358411
Type: SwitchParameter
359412
Parameter Sets: (All)
@@ -400,7 +453,8 @@ Accept wildcard characters: False
400453
```
401454

402455
### -CommentsOnSitePagesDisabled
403-
{{Fill CommentsOnSitePagesDisabled Description}}
456+
PARAMVALUE: $true | $false
457+
404458

405459
```yaml
406460
Type: Boolean
@@ -416,7 +470,8 @@ Accept wildcard characters: False
416470
```
417471

418472
### -DisableAppViews
419-
{{Fill DisableAppViews Description}}
473+
PARAMVALUE: Unknown | Disabled | NotDisabled
474+
420475

421476
```yaml
422477
Type: AppViewsPolicy
@@ -432,7 +487,8 @@ Accept wildcard characters: False
432487
```
433488

434489
### -DisableCompanyWideSharingLinks
435-
{{Fill DisableCompanyWideSharingLinks Description}}
490+
PARAMVALUE: Unknown | Disabled | NotDisabled
491+
436492

437493
```yaml
438494
Type: CompanyWideSharingLinksPolicy
@@ -448,7 +504,8 @@ Accept wildcard characters: False
448504
```
449505

450506
### -DisableFlows
451-
{{Fill DisableFlows Description}}
507+
PARAMVALUE: Unknown | Disabled | NotDisabled
508+
452509

453510
```yaml
454511
Type: FlowsPolicy
@@ -464,7 +521,8 @@ Accept wildcard characters: False
464521
```
465522

466523
### -NewUrl
467-
{{Fill NewUrl Description}}
524+
PARAMVALUE: String
525+
468526

469527
```yaml
470528
Type: String
@@ -480,7 +538,8 @@ Accept wildcard characters: False
480538
```
481539

482540
### -RestrictedToGeo
483-
{{Fill RestrictedToGeo Description}}
541+
PARAMVALUE: NoRestriction | BlockMoveOnly | BlockFull | Unknown
542+
484543

485544
```yaml
486545
Type: RestrictedToRegion
@@ -496,7 +555,10 @@ Accept wildcard characters: False
496555
```
497556

498557
### -SharingAllowedDomainList
499-
{{Fill SharingAllowedDomainList Description}}
558+
Specifies a list of email domains that is allowed for sharing with the external collaborators. Use the space character as the delimiter for entering multiple values. For example, “contoso.com fabrikam.com”.
559+
560+
For additional information about how to restrict a domain sharing, see Restricted Domains Sharing in Office 365 SharePoint Online and OneDrive for Business.
561+
500562

501563
```yaml
502564
Type: String
@@ -512,7 +574,10 @@ Accept wildcard characters: False
512574
```
513575

514576
### -SharingBlockedDomainList
515-
{{Fill SharingBlockedDomainList Description}}
577+
Specifies a list of email domains that is blocked or prohibited for sharing with the external collaborators. Use space character as the delimiter for entering multiple values. For example, “contoso.com fabrikam.com”.
578+
579+
For additional information about how to restrict a domain sharing, see Restricted Domains Sharing in Office 365 SharePoint Online and OneDrive for Business.
580+
516581

517582
```yaml
518583
Type: String
@@ -528,7 +593,18 @@ Accept wildcard characters: False
528593
```
529594

530595
### -SharingDomainRestrictionMode
531-
{{Fill SharingDomainRestrictionMode Description}}
596+
Specifies the external sharing mode for domains.
597+
598+
The following values are:
599+
600+
None
601+
602+
AllowList
603+
604+
BlockList
605+
606+
For additional information about how to restrict a domain sharing, see Restricted Domains Sharing in Office 365 SharePoint Online and OneDrive for Business.
607+
532608

533609
```yaml
534610
Type: SharingDomainRestrictionModes
@@ -544,7 +620,8 @@ Accept wildcard characters: False
544620
```
545621

546622
### -ShowPeoplePickerSuggestionsForGuestUsers
547-
{{Fill ShowPeoplePickerSuggestionsForGuestUsers Description}}
623+
PARAMVALUE: $true | $false
624+
548625

549626
```yaml
550627
Type: Boolean
@@ -560,7 +637,8 @@ Accept wildcard characters: False
560637
```
561638

562639
### -StorageQuotaReset
563-
{{Fill StorageQuotaReset Description}}
640+
Resets the OneDrive for Business storage quota to the tenant’s new default storage space.
641+
564642

565643
```yaml
566644
Type: SwitchParameter

0 commit comments

Comments
 (0)