Skip to content

Commit d11043a

Browse files
authored
Get-SPOContainer.md
1 parent bb81ed2 commit d11043a

File tree

1 file changed

+64
-31
lines changed

1 file changed

+64
-31
lines changed

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

Lines changed: 64 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -14,43 +14,57 @@ ms.reviewer:
1414

1515
## SYNOPSIS
1616

17-
Returns one or more Containers in a SharePoint Embedded application.
17+
Returns one or more containers in a SharePoint Embedded application.
1818

1919
## SYNTAX
2020

2121
### ParamSet1
2222

2323
```powershell
24-
Get-SPOContainer [-OwningApplicationId <OwningApplicationId>] [<CommonParameters>]
24+
Get-SPOContainer -Identity <ContainerId>
2525
```
2626

2727
### ParamSet2
28+
2829
```powershell
29-
Get-SPOContainer [-OwningApplicationId <OwningApplicationId>] [-Paged]
30+
Get-SPOContainer -OwningApplicationId <OwningApplicationId>
3031
```
3132

3233
### ParamSet3
3334
```powershell
34-
Get-SPOContainer [-OwningApplicationId <OwningApplicationId>] [-Paged] [-PagingToken <Token String>]
35+
Get-SPOContainer -OwningApplicationId <OwningApplicationId> -Paged
3536
```
3637

3738
### ParamSet4
38-
3939
```powershell
40-
Get-SPOContainer [[-Identity] <ContainerId>]
40+
Get-SPOContainer -OwningApplicationId <OwningApplicationId> -Paged -PagingToken <Token String>
4141
```
4242

4343
### ParamSet5
4444

4545
```powershell
46-
Get-SPOContainer [[-Identity] <ContainerSiteURL>]
46+
Get-SPOContainer -OwningApplicationId <OwningApplicationId> -SortByStorage <Ascending | Descending>
47+
```
48+
49+
### ParamSet6
50+
51+
```powershell
52+
Get-SPOContainer -OwningApplicationId <OwningApplicationId> -SortByStorage <Ascending | Descending>-Paged
53+
```
54+
### ParamSet7
55+
56+
```powershell
57+
Get-SPOContainer -OwningApplicationId <OwningApplicationId> -SortByStorage <Ascending | Descending>-Paged -PagingToken <Token String>
4758
```
4859

4960
## DESCRIPTION
5061

51-
The `Get-SPOContainer` cmdlet retrieves and returns a list of Containers and details of an individual Container created under a SharePoint Embedded application. This command is available only in SharePoint Online Management Shell version 16.0.24211.12000 or higher to run this cmdlet.
62+
The `Get-SPOContainer` cmdlet retrieves and returns the details of an individual container when paired `Identity` parameter, where the container ID needs to be mentioned. The cmdlet returns the list of containers belonging to a SharePoint Embedded application when paired with the `OwningApplicationId` parameter.
63+
64+
You must be a SharePoint Embedded Administrator to run the cmdlet.
65+
66+
For permissions and the most current information about Windows PowerShell for SharePoint Embedded Containers, see the documentation at [Intro to SharePoint Embedded Containers Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell).
5267

53-
You must be a SharePoint Online Administrator to run this cmdlet.
5468

5569
> [!NOTE]
5670
> Containers in the Recycle Bin will not be retrieved by using the `Get-SPOContainer` cmdlet.
@@ -62,47 +76,58 @@ You must be a SharePoint Online Administrator to run this cmdlet.
6276
### Example 1
6377

6478
```powershell
65-
Get-SPOContainer -OwningApplicationId 423poi45-jikl-9bnm-b302-1234ghy56789 | FT
79+
Get-SPOContainer -Identity b66f5b2e-4cbd-4754-9ad3-8291c2c81ade
6680
```
6781

68-
Example 1 returns a tabular list of Containers created under the SharePoint Embedded application with the `OwningApplicationId` of `423poi45-jikl-9bnm-b302-1234ghy56789`.
69-
70-
To retrieve Containers for the Microsoft Loop app, use OwningApplicationId: `a187e399-0c36-4b98-8f04-1edc167a0996`.
71-
72-
To retrieve Containers for the Microsoft Designer app, use OwningApplicationId: `5e2795e3-ce8c-4cfb-b302-35fe5cd01597`.
82+
Example 1 returns the detailed properties of the Container with associated Container ID b66f5b2e-4cbd-4754-9ad3-8291c2c81ade
7383

7484
### Example 2
7585

7686
```powershell
77-
Get-SPOContainer -OwningApplicationId 423poi45-jikl-9bnm-b302-1234ghy56789 -Identity b66f5b2e-4cbd-4754-9ad3-8291c2c81ade
87+
Get-SPOContainer -OwningApplicationId 423poi45-jikl-9bnm-b302-1234ghy56789 | FT
7888
```
79-
80-
Example 2 returns the detailed properties of the Container with associated `ContainerId`.
89+
Example 2 returns a tabular list of Containers created under the SharePoint Embedded application with the `OwningApplicationId` of `423poi45-jikl-9bnm-b302-1234ghy56789`.
8190

8291

8392
### Example 3
8493

8594
```powershell
86-
Get-SPOContainer -OwningApplicationId 423poi45-jikl-9bnm-b302-1234ghy56789 -Identity https://contoso.sharepoint.com/storagecontainers/CSP_b66f5b2e-4cbd-4754-9ad3-8291c2c81ade
95+
Get-SPOContainer -OwningApplicationId 423poi45-jikl-9bnm-b302-1234ghy56789 -Paged | FT
8796
```
88-
89-
Example 3 gives the detailed properties of a Container using the site URL of a Container.
97+
Example 3 uses the `-Paged` command to retrieve a paging token.
9098

9199
### Example 4
92100

93101
```powershell
94-
Get-SPOContainer -OwningApplicationId <OwningApplicationId> -Identity <ContainerId> -Paged | FT
102+
Get-SPOContainer -OwningApplicationId 423poi45-jikl-9bnm-b302-1234ghy56789 -Paged -PagingToken <Token String> | FT
95103
```
96104

97-
Example 4 uses the `-Paged` command to retrieve a paging token.
105+
Example 4 uses the `PagingToken` to view more containers.
98106

99107
### Example 5
100108

101109
```powershell
102-
Get-SPOContainer -OwningApplicationId <OwningApplicationId> -Identity <ContainerId> -Paged -PagingToken <Token String> | FT
110+
Get-SPOContainer -OwningApplicationId 423poi45-jikl-9bnm-b302-1234ghy56789 -SortByStorage <Ascending>
111+
```
112+
113+
Example 5 displays the containers belonging to the application, sorted in ascending order of storage
114+
115+
### Example 6
116+
117+
```powershell
118+
Get-SPOContainer -OwningApplicationId 423poi45-jikl-9bnm-b302-1234ghy56789 -SortByStorage <Ascending>-Paged
119+
```
120+
121+
Example 6 displays the containers belonging to the application, sorted in ascending order of storage
122+
123+
### Example 7
124+
125+
```powershell
126+
Get-SPOContainer -OwningApplicationId 423poi45-jikl-9bnm-b302-1234ghy56789 -SortByStorage <Ascending>-Paged-PagingToken <Token String>
103127
```
104128

105-
Example 5 uses the `PagingToken` to view more Containers.
129+
Example 7 displays the containers belonging to the application, sorted in ascending order of storage
130+
106131

107132
## PARAMETERS
108133

@@ -125,7 +150,7 @@ Accept wildcard characters: False
125150
126151
### -Identity
127152
128-
Use this parameter to specify the Container in the given OwningApplicationId.
153+
Use this parameter to specify the Container ID of a container.
129154
130155
```yaml
131156
Type: String
@@ -142,7 +167,7 @@ Accept wildcard characters: False
142167
143168
### -Paged
144169
145-
This parameter can be used when there are more than 200 Containers in a given SharePoint repository services application. Using `-Paged` will provide a `<Paging Token>` that will display the next 200 Containers.
170+
This parameter can be used when there are more than 200 Containers in a given SharePoint Embedded application. Using `-Paged` will provide a `<Paging Token>` that will display the next 200 Containers.
146171

147172
```yaml
148173
Type: String
@@ -160,7 +185,7 @@ Accept wildcard characters: False
160185

161186
### -PagingToken
162187

163-
Use this parameter to provide the `<Paging Token>` provided to view the remaining Containers as shown in Example 5. If there are no more Containers to display, the commandlet output will return the message `End of Containers view.` Otherwise, use the given `<Paging Token>` to retrieve the next batch of up to 200 Containers.
188+
Use this parameter to provide the `<Paging Token>` provided to view the remaining Containers as shown in Example 4. If there are no more Containers to display, the commandlet output will return the message `End of Containers view.` Otherwise, use the given `<Paging Token>` to retrieve the next batch of up to 200 Containers.
164189

165190
```yaml
166191
Type: String
@@ -174,12 +199,20 @@ Default value: None
174199
Accept pipeline input: False
175200
Accept wildcard characters: False
176201
```
202+
### -SortByStorage
177203

178-
### CommonParameters
204+
This parameter can be used when you need to see the list of containers, sorted by storage.
179205

180-
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
206+
```yaml
207+
Type: String
208+
Position: Named
209+
Default value: None
210+
Required: False
211+
Accept pipeline input: False
212+
Accept wildcard characters: False
213+
Applies to: SharePoint Online
214+
```
181215

182-
## NOTES
183216

184217
## RELATED LINKS
185218

0 commit comments

Comments
 (0)