Skip to content

Commit f02fe12

Browse files
Merge pull request #827 from ShreyasSar26/patch-1
Archived containers modification.
2 parents 79237c9 + 253fc87 commit f02fe12

File tree

2 files changed

+276
-43
lines changed

2 files changed

+276
-43
lines changed

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

Lines changed: 47 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -21,48 +21,32 @@ 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 <SPOContainerPipeBind> [<CommonParameters>]
2525
```
2626

2727
### ParamSet2
2828

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

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

3838
### ParamSet4
3939
```powershell
40-
Get-SPOContainer -OwningApplicationId <OwningApplicationId> [-Paged] [-PagingToken <TokenString>] [<CommonParameters>]
41-
```
42-
43-
### ParamSet5
44-
45-
```powershell
46-
Get-SPOContainer -OwningApplicationId <OwningApplicationId> [-SortByStorage <Ascending | Descending>] [<CommonParameters>]
47-
```
48-
49-
### ParamSet6
50-
51-
```powershell
52-
Get-SPOContainer -OwningApplicationId <OwningApplicationId> [-SortByStorage <Ascending | Descending>] [-Paged] [<CommonParameters>]
53-
```
54-
### ParamSet7
55-
56-
```powershell
57-
Get-SPOContainer -OwningApplicationId <OwningApplicationId> [-SortByStorage <Ascending | Descending>] [-Paged] [-PagingToken <TokenString>] [<CommonParameters>]
40+
Get-SPOContainer [-OwningApplicationId] <Guid> [-Paged] [[-PagingToken] <String>] [[-SortByStorage] <SortOrder>] [-ArchiveStatus] <SPContainerArchiveStatusFilterProperties> [<CommonParameters>]
5841
```
5942

6043
## DESCRIPTION
6144

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.
45+
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.
6346

6447
You must be a SharePoint Embedded Administrator to run this cmdlet.
6548

49+
6650
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).
6751

6852

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

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

115+
### Example 8
116+
117+
```powershell
118+
Get-SPOContainer -OwningApplicationId 423poi45 -ArchiveStatus RecentlyArchived | ft
119+
```
120+
121+
Example 8 returns a tabular list of recently archived containers belonging to the SharePoint Embedded application with the OwningApplicationId of 423poi45.
122+
131123

132124
## PARAMETERS
133125

@@ -167,7 +159,7 @@ Accept wildcard characters: False
167159
168160
### -Paged
169161
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.
162+
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.
171163

172164
```yaml
173165
Type: String
@@ -185,7 +177,7 @@ Accept wildcard characters: False
185177

186178
### -PagingToken
187179

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 cmdlet 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.
180+
Use this parameter to provide the paging token to view the remaining containers as shown in Example 4. If there are no more containers to display, the cmdlet 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. For displaying the next set of archived containers, `-ArchiveStatus` paramter needs to be used along with this parameter.
189181

190182
```yaml
191183
Type: String
@@ -214,6 +206,37 @@ Default value: None
214206
Accept pipeline input: False
215207
Accept wildcard characters: False
216208
```
209+
210+
### -ArchiveStatus
211+
212+
The ArchiveStatus parameter is used to display containers in various stages of archiving. The following states are supported:
213+
214+
• Archived – Displays containers in all archived states.
215+
216+
• RecentlyArchived – Displays containers in the "Recently archived" state.
217+
218+
• FullyArchived – Displays containers in the "Fully archived" state.
219+
220+
• Reactivating – Displays containers in the "Reactivating" state.
221+
222+
• NotArchived – Displays active containers
223+
224+
225+
```yaml
226+
Type: String
227+
Applicable: SharePoint Online
228+
229+
Required: False
230+
Position: Named
231+
Default value: None
232+
Accept pipeline input: False
233+
Accept wildcard characters: False
234+
```
235+
236+
### CommonParameters
237+
This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-ProgressAction`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
238+
239+
217240
## RELATED LINKS
218241

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

0 commit comments

Comments
 (0)