Skip to content

Commit 6aa9c78

Browse files
committed
Updated Synopsis, Description, Examples and Parameters.
1 parent 02067db commit 6aa9c78

File tree

1 file changed

+93
-13
lines changed

1 file changed

+93
-13
lines changed

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

Lines changed: 93 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@ schema: 2.0.0
88
# Get-SPOSite
99

1010
## SYNOPSIS
11-
{{Fill in the Synopsis}}
11+
Returns one or more site collections.
12+
1213

1314
## SYNTAX
1415

@@ -29,21 +30,87 @@ Get-SPOSite [-Identity] <SpoSitePipeBind> [-DisableSharingForNonOwnersStatus] [<
2930
```
3031

3132
## DESCRIPTION
32-
{{Fill in the Description}}
33+
This cmdlet contains more than one parameter set. You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. For more information about how to use parameter sets, see Cmdlet Parameter Sets.
34+
35+
The `Get-SPOSite` cmdlet retrieves and returns properties of all site collections that match the given criteria.
36+
37+
With version 5361 of the SharePoint Online Management Shell, you may experience the following:
38+
39+
Additional site collections are now displayed. For example, all group and video sites along with team sites will be displayed.
40+
41+
The Detailed parameter has been deprecated. It will continue to work with earlier versions
42+
43+
You may see an impact on performance when the Filter parameter is used.
44+
45+
Note:
46+
Site collections in the Recycle Bin will not be retrieved by using the `Get-SPOSite` cmdlet.
47+
48+
You need to be a SharePoint Online global administrator and a site collection administrator to run the cmdlet.
49+
50+
For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at http://go.microsoft.com/fwlink/p/?LinkId=251832.
51+
52+
Note:
53+
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.
54+
3355

3456
## EXAMPLES
3557

36-
### Example 1
58+
### -----------------------EXAMPLE 1-----------------------------
59+
```
60+
Get-SPOSite
61+
```
62+
Example 1 returns all site collections.
63+
64+
### -----------------------EXAMPLE 2-----------------------------
65+
```
66+
Get-SPOSite -Identity https://contoso.sharepoint.com
67+
```
68+
Example 2 lists the site collection with detailed properties.
69+
70+
### -----------------------EXAMPLE 3-----------------------------
71+
```
72+
Get-SPOSite -Identity https://contoso.sharepoint.com -DisableSharingForNonOwnersStatus
73+
```
74+
Example 3 disables the ability for non owners of a site collection to share.
75+
76+
### -----------------------EXAMPLE 4-----------------------------
77+
```
78+
Get-SPOSite -Template GROUP#0 -IncludePersonalSite:$false
79+
```
80+
This example enumerates Group Site Collections in a tenant.
81+
82+
### -----------------------EXAMPLE 5-----------------------------
3783
```
38-
PS C:\> {{ Add example code here }}
84+
Get-SPOSite -Identity https://contoso.sharepoint.com/sites/groupname -detailed |fl
3985
```
86+
This example gets quota details for a Group Site.
4087

41-
{{ Add example description here }}
4288

4389
## PARAMETERS
4490

4591
### -Detailed
46-
{{Fill Detailed Description}}
92+
Use this parameter to get additional property information on a site collection. You will notice a slower response time when the Detailed parameter is used.
93+
94+
The following properties are returned:
95+
96+
--ResourceUsageCurrent
97+
98+
--ResourceUsageAverage
99+
100+
--StorageUsageCurrent
101+
102+
--LockIssue
103+
104+
--WebsCount
105+
106+
--CompatibilityLevel
107+
108+
--AllowSelfServiceUpgrade
109+
110+
--SiteDefinedSharingCapability-returns the stored value of the site policy.
111+
112+
--SharingCapability --returns the effective access level (the site policy and the tenant policy combined.
113+
47114

48115
```yaml
49116
Type: SwitchParameter
@@ -59,7 +126,11 @@ Accept wildcard characters: False
59126
```
60127
61128
### -DisableSharingForNonOwnersStatus
62-
{{Fill DisableSharingForNonOwnersStatus Description}}
129+
This parameter prevents non-owners from sharing.
130+
131+
Note:
132+
This parameter is available only in SharePoint Online Management Shell Version 16.0.4613.1211 or later.
133+
63134
64135
```yaml
65136
Type: SwitchParameter
@@ -75,7 +146,11 @@ Accept wildcard characters: False
75146
```
76147
77148
### -Filter
78-
{{Fill Filter Description}}
149+
Specifies the script block of the server-side filter to apply. The type must be a valid filter name and value must be in the form {$_PropertyName <operator> "filterValue"}. Valid operators are as follows: eq, ne, like, notlike.
150+
151+
Note:
152+
The operator values are case-sensitive.
153+
79154
80155
```yaml
81156
Type: String
@@ -91,7 +166,8 @@ Accept wildcard characters: False
91166
```
92167
93168
### -Identity
94-
{{Fill Identity Description}}
169+
Specifies the URL of the site collection.
170+
95171
96172
```yaml
97173
Type: SpoSitePipeBind
@@ -120,7 +196,10 @@ Accept wildcard characters: False
120196
```
121197
122198
### -IncludePersonalSite
123-
{{Fill IncludePersonalSite Description}}
199+
Displays personal sites when value is set to $true.
200+
201+
The values are $true and $false. By default, the value is $false which means no personal sites will be returned.
202+
124203
125204
```yaml
126205
Type: Boolean
@@ -136,7 +215,8 @@ Accept wildcard characters: False
136215
```
137216
138217
### -Limit
139-
{{Fill Limit Description}}
218+
Specifies the maximum number of site collections to return. It can be any number. To retrieve all site collections, use ALL. The default value is 200.
219+
140220
141221
```yaml
142222
Type: String
@@ -152,7 +232,8 @@ Accept wildcard characters: False
152232
```
153233
154234
### -Template
155-
{{Fill Template Description}}
235+
Displays sites of a specific template. For example, STS, STS#0 or STS#1.
236+
156237
157238
```yaml
158239
Type: String
@@ -181,4 +262,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
181262
## NOTES
182263
183264
## RELATED LINKS
184-

0 commit comments

Comments
 (0)