Skip to content

Commit 549dd5a

Browse files
authored
Update Get-SPOContainer.md
1 parent d38e5b9 commit 549dd5a

File tree

1 file changed

+77
-8
lines changed

1 file changed

+77
-8
lines changed

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

Lines changed: 77 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,48 +21,81 @@ Returns one or more containers in a SharePoint Embedded application.
2121
### ParamSet1
2222

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

2727
### ParamSet2
2828

2929
```powershell
30-
Get-SPOContainer -OwningApplicationId <OwningApplicationId> [<CommonParameters>]
30+
Get-SPOContainer [-OwningApplicationId] <Guid> [<CommonParameters>]
3131
```
3232

3333
### ParamSet3
3434
```powershell
35-
Get-SPOContainer -OwningApplicationId <OwningApplicationId> [-Paged] [<CommonParameters>]
35+
Get-SPOContainer [-OwningApplicationId] <Guid> [-Paged] [<CommonParameters>]
3636
```
3737

3838
### ParamSet4
3939
```powershell
40-
Get-SPOContainer -OwningApplicationId <OwningApplicationId> [-Paged] [-PagingToken <TokenString>] [<CommonParameters>]
40+
Get-SPOContainer [-OwningApplicationId] <Guid> [-Paged] [-PagingToken <TokenString>] [<CommonParameters>]
4141
```
4242

4343
### ParamSet5
4444

4545
```powershell
46-
Get-SPOContainer -OwningApplicationId <OwningApplicationId> [-SortByStorage <Ascending | Descending>] [<CommonParameters>]
46+
Get-SPOContainer [-OwningApplicationId] <Guid> [-SortByStorage <Ascending | Descending>] [<CommonParameters>]
4747
```
4848

4949
### ParamSet6
5050

5151
```powershell
52-
Get-SPOContainer -OwningApplicationId <OwningApplicationId> [-SortByStorage <Ascending | Descending>] [-Paged] [<CommonParameters>]
52+
Get-SPOContainer [-OwningApplicationId] <Guid> [-SortByStorage <Ascending | Descending>] [-Paged] [<CommonParameters>]
5353
```
5454
### ParamSet7
5555

5656
```powershell
57-
Get-SPOContainer -OwningApplicationId <OwningApplicationId> [-SortByStorage <Ascending | Descending>] [-Paged] [-PagingToken <TokenString>] [<CommonParameters>]
57+
Get-SPOContainer [-OwningApplicationId] <Guid> [-SortByStorage <Ascending | Descending>] [-Paged] [[-PagingToken] <TokenString>] [<CommonParameters>]
58+
```
59+
### ParamSet8
60+
61+
```powershell
62+
Get-SPOContainer [-OwningApplicationId] <Guid> [[-ArchiveStatus] <String>][<CommonParameters>]
63+
```
64+
65+
### ParamSet9
66+
```powershell
67+
Get-SPOContainer [-OwningApplicationId] <Guid> [[-ArchiveStatus] <String>][-Paged] [<CommonParameters>]
68+
```
69+
70+
### ParamSet10
71+
```powershell
72+
Get-SPOContainer [-OwningApplicationId] <Guid> [[-ArchiveStatus]<String>][-Paged] [-PagingToken <TokenString>] [<CommonParameters>]
73+
```
74+
75+
### ParamSet11
76+
77+
```powershell
78+
Get-SPOContainer [-OwningApplicationId] <Guid> [[-ArchiveStatus] <String>][-SortByStorage <Ascending | Descending>] [<CommonParameters>]
79+
```
80+
81+
### ParamSet12
82+
83+
```powershell
84+
Get-SPOContainer [-OwningApplicationId] <Guid> [[-ArchiveStatus] <String>][-SortByStorage <Ascending | Descending>] [-Paged] [<CommonParameters>]
85+
```
86+
### ParamSet13
87+
88+
```powershell
89+
Get-SPOContainer [-OwningApplicationId] <Guid> [-ArchiveStatus<String>][-SortByStorage <Ascending | Descending>] [-Paged] [[-PagingToken] <TokenString>] [<CommonParameters>]
5890
```
5991

6092
## DESCRIPTION
6193

62-
The `Get-SPOContainer` cmdlet retrieves and returns the details of an individual container when paired with `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.
94+
The `Get-SPOContainer` cmdlet retrieves details of an individual container, either in the active or archived state, when paired with the `Identity` parameter, which requires specifying the container ID. When used with the `OwningApplicationId` parameter, the cmdlet returns a list of active containers associated with a SharePoint Embedded application. Additionally, when also used with the `ArchiveStatus` parameter, it returns a list of containers in the archived state as specified.
6395

6496
You must be a SharePoint Embedded Administrator to run this cmdlet.
6597

98+
6699
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).
67100

68101

@@ -128,6 +161,14 @@ Get-SPOContainer -OwningApplicationId 423poi45-as -SortByStorage Ascending -Page
128161

129162
Example 7 displays the next list of paged view of containers belonging to the application, sorted in ascending order of storage.
130163

164+
### Example 8
165+
166+
```powershell
167+
Get-SPOContainer -OwningApplicationId 423poi45 -ArchiveStatus RecentlyArchived | ft
168+
```
169+
170+
Example 8 returns a tabular list of recently archived containers belonging to the SharePoint Embedded application with the OwningApplicationId of 423poi45.
171+
131172

132173
## PARAMETERS
133174

@@ -214,6 +255,34 @@ Default value: None
214255
Accept pipeline input: False
215256
Accept wildcard characters: False
216257
```
258+
259+
### -ArchiveStatus
260+
261+
The ArchiveStatus parameter is used to display containers in various stages of archiving. The following states are supported:
262+
263+
• Archived – Displays containers in all archived states.
264+
265+
• RecentlyArchived – Displays containers in the "Recently archived" state.
266+
267+
• FullyArchived – Displays containers in the "Fully archived" state.
268+
269+
• Reactivating – Displays containers in the "Reactivating" state.
270+
271+
• NotArchived – Displays active containers
272+
273+
274+
```yaml
275+
Type: String
276+
Applicable: SharePoint Online
277+
278+
Required: False
279+
Position: Named
280+
Default value: None
281+
Accept pipeline input: False
282+
Accept wildcard characters: False
283+
```
284+
285+
217286
## RELATED LINKS
218287

219288
[Intro to SharePoint Embedded Containers Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell)

0 commit comments

Comments
 (0)