Skip to content

Commit 11b8daf

Browse files
authored
Standardize formatting for the document
1 parent 2a5d5af commit 11b8daf

File tree

1 file changed

+74
-52
lines changed

1 file changed

+74
-52
lines changed

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

Lines changed: 74 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -60,11 +60,11 @@ PS C:\> {{ Add example code here }}
6060
## PARAMETERS
6161

6262
### -BccExternalSharingInvitations
63-
Enables the BCC for External Sharing feature.
64-
When the feature is enabled, all external sharing invitations will blind copy the e-mail messages listed in the BccExternalSharingsInvitationList.
63+
When the feature is enabled, all external sharing invitations that are sent will blind copy the e-mail messages listed in the BccExternalSharingsInvitationList.
6564

66-
Accepts a value of true (enabled) or false (disabled).
67-
By default this feature is set to false.
65+
The valid values are:
66+
False (default) - BCC for external sharing is disabled.
67+
True - All external sharing invitations that are sent will blind copy the e-mail messages listed in the BccExternalSharingsInvitationList.
6868

6969
```yaml
7070
Type: Boolean
@@ -74,7 +74,7 @@ Applicable: SharePoint Online
7474

7575
Required: False
7676
Position: Named
77-
Default value: None
77+
Default value: False
7878
Accept pipeline input: False
7979
Accept wildcard characters: False
8080
```
@@ -83,7 +83,9 @@ Accept wildcard characters: False
8383
Specifies a list of e-mail addresses to be BCC'd when the BCC for External Sharing feature is enabled.
8484
Multiple addresses can be specified by creating a comma separated list with no spaces.
8585
86-
86+
The valid values are:
87+
"" (default) - Blank by default, this will also clear any value that has been set.
88+
Single or Multiple e-mail addresses - [email protected] or [email protected],[email protected]
8789
8890
```yaml
8991
Type: String
@@ -101,6 +103,10 @@ Accept wildcard characters: False
101103
### -DisplayStartASiteOption
102104
Determines whether tenant users see the Start a Site menu option.
103105
106+
The valid values are:
107+
True (default) - Tenant users will see the Start a Site menu option.
108+
False - Start a Site is hidden from the menu.
109+
104110
```yaml
105111
Type: Boolean
106112
Parameter Sets: (All)
@@ -109,7 +115,7 @@ Applicable: SharePoint Online
109115

110116
Required: False
111117
Position: Named
112-
Default value: None
118+
Default value: True
113119
Accept pipeline input: False
114120
Accept wildcard characters: False
115121
```
@@ -118,6 +124,10 @@ Accept wildcard characters: False
118124
Enables external services for a tenant.
119125
External services are defined as services that are not in the Office 365 datacenters.
120126
127+
The valid values are:
128+
True (default) - External services are enabled for the tenant.
129+
False - External services that are outside of the Office 365 datacenters cannot interact with SharePoint.
130+
121131
```yaml
122132
Type: Boolean
123133
Parameter Sets: (All)
@@ -126,7 +136,7 @@ Applicable: SharePoint Online
126136

127137
Required: False
128138
Position: Named
129-
Default value: None
139+
Default value: True
130140
Accept pipeline input: False
131141
Accept wildcard characters: False
132142
```
@@ -166,6 +176,10 @@ Accept wildcard characters: False
166176
### -NoAccessRedirectUrl
167177
Specifies the URL of the redirected site for those site collections which have the locked state "NoAccess."
168178
179+
The valid values are:
180+
"" (default) - Blank by default, this will also remove or clear any value that has been set.
181+
Full URL - Example: https://contoso.sharepoint.com/Pages/Locked.aspx
182+
169183
```yaml
170184
Type: String
171185
Parameter Sets: (All)
@@ -180,7 +194,11 @@ Accept wildcard characters: False
180194
```
181195
182196
### -OfficeClientADALDisabled
183-
PARAMVALUE: $true | $false
197+
When set to true this will disable the ability to use Modern Authentication that leverages ADAL across the tenant.
198+
199+
The valid values are:
200+
False (default) - Modern Authentication is enabled/allowed.
201+
True - Modern Authentication via ADAL is disabled.
184202
185203
```yaml
186204
Type: Boolean
@@ -190,19 +208,19 @@ Applicable: SharePoint Online
190208

191209
Required: False
192210
Position: Named
193-
Default value: None
211+
Default value: False
194212
Accept pipeline input: False
195213
Accept wildcard characters: False
196214
```
197215
198216
### -ProvisionSharedWithEveryoneFolder
199217
Creates a Shared with Everyone folder in every user's new OneDrive for Business document library.
200218
201-
The default value is True which mean the folder is created.
202-
203-
A value of False means no folder is created when the site and OneDrive for Business document library is created.
219+
The valid values are:
220+
True (default) - The Shared with Everyone folder is created.
221+
False - No folder is created when the site and OneDrive for Business document library is created.
204222
205-
The default behavior of the Shared with Everyone folder is changing in August 2015.
223+
The default behavior of the Shared with Everyone folder changed in August 2015.
206224
For additional information about the change, see Provision the Shared with Everyone folder in OneDrive for Business (https://support.office.com/en-us/article/Provision-the-Shared-with-Everyone-folder-in-OneDrive-for-Business-6bb02c91-fd0b-42ba-9457-3921cb6dc5b2?ui=en-US&rs=en-US&ad=US)
207225
208226
```yaml
@@ -213,25 +231,21 @@ Applicable: SharePoint Online
213231

214232
Required: False
215233
Position: Named
216-
Default value: None
234+
Default value: True
217235
Accept pipeline input: False
218236
Accept wildcard characters: False
219237
```
220238
221239
### -RequireAcceptingAccountMatchInvitedAccount
222240
Ensures that an external user can only accept an external sharing invitation with an account matching the invited email address.
223241
224-
The parameter accepts two values: True or False.
225-
226-
True-User must accept this invitation with [email protected].
227-
228-
False- When a document is shared with an external user, [email protected], it can be accepted by any user with access to the invitation link in the original e-mail.
229-
230242
Administrators who desire increased control over external collaborators should consider enabling this feature.
231243
232-
This only applies to new external users accepting new sharing invitations.
244+
Note, this only applies to new external users accepting new sharing invitations. Also, the resource owner must share with an organizational or Microsoft account or the external user will be unable to access the resource.
233245
234-
The resource owner must share with an organizational or Microsoft account or the external user will be unable to access the resource.
246+
The valid values are:
247+
False (default) - When a document is shared with an external user, [email protected], it can be accepted by any user with access to the invitation link in the original e-mail.
248+
True - User must accept this invitation with [email protected].
235249
236250
```yaml
237251
Type: Boolean
@@ -241,7 +255,7 @@ Applicable: SharePoint Online
241255

242256
Required: False
243257
Position: Named
244-
Default value: None
258+
Default value: False
245259
Accept pipeline input: False
246260
Accept wildcard characters: False
247261
```
@@ -263,14 +277,18 @@ Applicable: SharePoint Online
263277

264278
Required: False
265279
Position: Named
266-
Default value: None
280+
Default value: False
267281
Accept pipeline input: False
268282
Accept wildcard characters: False
269283
```
270284
271285
### -SharingCapability
272286
Determines what level of sharing is available for the site.
273-
The possible values are: Disabled - external user sharing (share by email) and guest link sharing are both disabled, ExternalUserSharingOnly - external user sharing (share by email) is enabled, but guest link sharing is disabled, or ExternalUserAndGuestSharing - external user sharing (share by email) and guest link sharing are both enabled.
287+
288+
The valid values are:
289+
ExternalUserAndGuestSharing (default) - External user sharing (share by email) and guest link sharing are both enabled.
290+
Disabled - External user sharing (share by email) and guest link sharing are both disabled.
291+
ExternalUserSharingOnly - External user sharing (share by email) is enabled, but guest link sharing is disabled.
274292
275293
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).
276294
@@ -282,25 +300,22 @@ Applicable: SharePoint Online
282300

283301
Required: False
284302
Position: Named
285-
Default value: None
303+
Default value: ExternalUserAndGuestSharing
286304
Accept pipeline input: False
287305
Accept wildcard characters: False
288306
```
289307
290308
### -ShowAllUsersClaim
291309
Enables the administrator to hide the All Users claim groups in People Picker.
292-
When users share an item with "All Users (x)", it is accessible to all organization members in the tenant's Azure Active Directory who have authenticated with variable.
293-
For example, "All Users (x)" shares with users who have used NTLM to authentication with SharePoint.
294-
295-
The valid values are:
296-
297-
True- The All Users claim groups are displayed in People Picker.
298310
299-
False- The All Users claim groups are hidden in People Picker.
311+
When users share an item with "All Users (x)", it is accessible to all organization members in the tenant's Azure Active Directory who have authenticated with via this method. When users share an item with "All Users (x)" it is accessible to all organtization members in the tenant that used NTLM to authentication with SharePoint.
300312
301-
The default value is True.
313+
Note, the All Users (authenticated) group is equivalent to the Everyone claim, and shows as Everyone.
314+
To change this, see -ShowEveryoneClaim.
302315
303-
All Users (authenticated) is equivalent to the Everyone claim.
316+
The valid values are:
317+
True (default) - The All Users claim groups are displayed in People Picker.
318+
False - The All Users claim groups are hidden in People Picker.
304319
305320
```yaml
306321
Type: Boolean
@@ -310,7 +325,7 @@ Applicable: SharePoint Online
310325

311326
Required: False
312327
Position: Named
313-
Default value: None
328+
Default value: True
314329
Accept pipeline input: False
315330
Accept wildcard characters: False
316331
```
@@ -319,13 +334,11 @@ Accept wildcard characters: False
319334
Enables the administrator to hide the Everyone claim in the People Picker.
320335
When users share an item with Everyone, it is accessible to all authenticated users in the tenant's Azure Active Directory, including any active external users who have previously accepted invitations.
321336
322-
The valid values are:
323-
324-
True- The Everyone claim group is displayed in People Picker.
337+
Note, that some SharePoint system resources such as templates and pages are required to be shared to Everyone and this type of sharing does not expose any user data or metadata.
325338
326-
Some SharePoint system resources such as templates and pages are required by be shared to Everyone and this type of sharing does not expose any user data or metadata.
327-
328-
The default value is True.
339+
The valid values are:
340+
True (default) - The Everyone claim group is displayed in People Picker.
341+
False - The Everyone claim group is hidden from the People Picker.
329342
330343
```yaml
331344
Type: Boolean
@@ -335,7 +348,7 @@ Applicable: SharePoint Online
335348

336349
Required: False
337350
Position: Named
338-
Default value: None
351+
Default value: True
339352
Accept pipeline input: False
340353
Accept wildcard characters: False
341354
```
@@ -345,28 +358,25 @@ Enables the administrator to hide the "Everyone except external users" claim in
345358
When users share an item with "Everyone except external users", it is accessible to all organization members in the tenant's Azure Active Directory, but not to any users who have previously accepted invitations.
346359
347360
The valid values are:
348-
349-
True - The Everyone except external users is displayed in People Picker.
350-
361+
True (default) - The Everyone except external users is displayed in People Picker.
351362
False - The Everyone except external users claim is not visible in People Picker .
352363
353-
The default value is True.
354-
355364
```yaml
356365
Type: Boolean
366+
357367
Parameter Sets: (All)
358368
Aliases:
359369
Applicable: SharePoint Online
360370

361371
Required: False
362372
Position: Named
363-
Default value: None
373+
Default value: True
364374
Accept pipeline input: False
365375
Accept wildcard characters: False
366376
```
367377
368378
### -SignInAccelerationDomain
369-
Specifies home realm discovery value to be sent to Azure Active Directory (AAD) during the user sign-in process.
379+
Specifies the home realm discovery value to be sent to Azure Active Directory (AAD) during the user sign-in process.
370380
371381
When the organization uses a third-party identity provider, this prevents the user from seeing the Azure Active Directory Home Realm Discovery web page and ensures the user only sees their company's Identity Provider's portal.
372382
This value can also be used with Azure Active Directory Premium to customize the Azure Active Directory login page.
@@ -377,6 +387,10 @@ This value should be configured with the login domain that is used by your compa
377387
378388
If your company has multiple third-party identity providers, configuring the sign-in acceleration value will break sign-in for your organization.
379389
390+
The valid values are:
391+
"" (default) - Blank by default, this will also remove or clear any value that has been set.
392+
Login Domain - For example: "contoso.com"
393+
380394
```yaml
381395
Type: String
382396
Parameter Sets: (All)
@@ -393,6 +407,10 @@ Accept wildcard characters: False
393407
### -StartASiteFormUrl
394408
Specifies URL of the form to load in the Start a Site dialog.
395409
410+
The valid values are:
411+
"" (default) - Blank by default, this will also remove or clear any value that has been set.
412+
Full URL - Example: "https://contoso.sharepoint.com/path/to/form"
413+
396414
```yaml
397415
Type: String
398416
Parameter Sets: (All)
@@ -415,6 +433,10 @@ When the user does not select "Keep Me Signed in" at the time of sign-in, "Open
415433
This special cookie expires after 30 minutes and cannot be cleared by closing the browser or signing out of SharePoint Online.
416434
To clear this cookie, the user must log out of their Windows session.
417435
436+
The valid values are:
437+
False (default) - No special cookie is generated and the normal Office 365 sign-in length/timing applies.
438+
True - Generates a special cookie that will allow "Open with Explorer" to function if the "Keep Me Signed In" box is not checked at sign-in.
439+
418440
```yaml
419441
Type: Boolean
420442
Parameter Sets: (All)
@@ -423,7 +445,7 @@ Applicable: SharePoint Online
423445

424446
Required: False
425447
Position: Named
426-
Default value: None
448+
Default value: False
427449
Accept pipeline input: False
428450
Accept wildcard characters: False
429451
```

0 commit comments

Comments
 (0)