Skip to content

Commit f9b66c4

Browse files
Merge pull request #980 from ShreyasSar26/patch-1
Update Get-SPOContainer.md
2 parents 8ee9760 + 292091c commit f9b66c4

File tree

1 file changed

+55
-24
lines changed

1 file changed

+55
-24
lines changed

sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOContainer.md

Lines changed: 55 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -18,27 +18,36 @@ Returns one or more containers in a SharePoint Embedded application.
1818

1919
## SYNTAX
2020

21+
### All (Default)
22+
```
23+
Get-SPOContainer [-Identity <SPOContainerPipeBind>] [-Paged] [[-PagingToken] <String>]
24+
[[-SortByStorage] <SortOrder>] [[-ArchiveStatus] <SPContainerArchiveStatusFilterProperties>]
25+
[-ProgressAction <ActionPreference>] [<CommonParameters>]
26+
```
27+
2128
### OwningApplicationId
2229
```
23-
Get-SPOContainer [-OwningApplicationId] <Guid> [-Paged] [[-PagingToken] <String>] [<CommonParameters>]
30+
Get-SPOContainer [-OwningApplicationId] <Guid> [-Paged] [[-PagingToken] <String>]
31+
[-ProgressAction <ActionPreference>] [<CommonParameters>]
2432
```
2533

34+
2635
### Sort
2736
```
2837
Get-SPOContainer [-OwningApplicationId] <Guid> [-Paged] [[-PagingToken] <String>] [-SortByStorage] <SortOrder>
29-
[<CommonParameters>]
38+
[-ProgressAction <ActionPreference>] [<CommonParameters>]
3039
```
3140

3241
### Archive
3342
```
3443
Get-SPOContainer [-OwningApplicationId] <Guid> [-Paged] [[-PagingToken] <String>]
3544
[[-SortByStorage] <SortOrder>] [-ArchiveStatus] <SPContainerArchiveStatusFilterProperties>
36-
[<CommonParameters>]
45+
[-ProgressAction <ActionPreference>] [<CommonParameters>]
3746
```
3847

3948
### Identity
4049
```
41-
Get-SPOContainer -Identity <SPOContainerPipeBind> [<CommonParameters>]
50+
Get-SPOContainer -Identity <SPOContainerPipeBind> [-ProgressAction <ActionPreference>] [<CommonParameters>]
4251
```
4352

4453
## DESCRIPTION
@@ -50,73 +59,90 @@ You must be a SharePoint Embedded Administrator to run this cmdlet.
5059
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).
5160

5261
> [!NOTE]
53-
> Containers in the Recycle Bin will not be retrieved by using the `Get-SPOContainer` cmdlet.
54-
> The OwningApplicationId for Microsoft Loop is `a187e399-0c36-4b98-8f04-1edc167a0996`.
55-
> The OwningApplicationId for Microsoft Designer is `5e2795e3-ce8c-4cfb-b302-35fe5cd01597`.
62+
> You can't retrieve containers in the Recycle Bin using this cmdlet.
63+
>
64+
> Use the following `OwningApplicationId` values to identify specific Microsoft applications:
65+
66+
67+
| Application | OwningApplicationId |
68+
|----------|----------|
69+
| **Microsoft Declarative Agent** | `3fbee041-e7d6-4f14-8826-6bf27f0a2849` |
70+
| **Microsoft Designer** | `5e2795e3-ce8c-4cfb-b302-35fe5cd01597` |
71+
| **Microsoft Loop** | `a187e399-0c36-4b98-8f04-1edc167a0996` |
72+
| **Microsoft Outlook Newsletters** | `a6804318-a92d-4f36-b499-441033991274`|
73+
| **Microsoft Teams Events Video on Demand** | `f574b137-eb91-46a0-8811-1a04d80c7ffa`|
74+
5675

5776
## EXAMPLES
5877

5978
### Example 1
6079

80+
```powershell
81+
Get-SPOContainer
82+
```
83+
Example 1 returns the details of all the containers in the tenant.
84+
85+
### Example 2
86+
6187
```powershell
6288
Get-SPOContainer -Identity b66f5b2e
6389
```
6490

65-
Example 1 returns the detailed properties of the Container with associated Container ID b66f5b2e.
91+
Example 2 returns the detailed properties of the Container with associated Container ID b66f5b2e.
6692

67-
### Example 2
93+
### Example 3
6894

6995
```powershell
7096
Get-SPOContainer -OwningApplicationId 423poi45 | ft
7197
```
72-
Example 2 returns a tabular list of Containers created under the SharePoint Embedded application with the `OwningApplicationId` of `423poi45`.
98+
Example 3 returns a tabular list of Containers created under the SharePoint Embedded application with the `OwningApplicationId` of `423poi45`.
7399

74-
### Example 3
100+
### Example 4
75101

76102
```powershell
77103
Get-SPOContainer -OwningApplicationId 423poi45 -Paged | ft
78104
```
79-
Example 3 uses the `-Paged` command to retrieve a paging token.
105+
Example 4 uses the `-Paged` command to retrieve a paging token.
80106

81-
### Example 4
107+
### Example 5
82108

83109
```powershell
84110
Get-SPOContainer -OwningApplicationId 423poi45 -Paged -PagingToken <zacad> | ft
85111
```
86112

87-
Example 4 uses the `-PagingToken` parameter along with the `-Paged` parameter to view more containers that were not displayed in Example 3.
113+
Example 5 uses the `-PagingToken` parameter along with the `-Paged` parameter to view more containers that were not displayed in Example 3.
88114

89-
### Example 5
115+
### Example 6
90116

91117
```powershell
92118
Get-SPOContainer -OwningApplicationId 423poi45 -SortByStorage Ascending
93119
```
94120

95-
Example 5 displays the containers belonging to the application, sorted in ascending order of storage.
121+
Example 6 displays the containers belonging to the application, sorted in ascending order of storage.
96122

97-
### Example 6
123+
### Example 7
98124

99125
```powershell
100126
Get-SPOContainer -OwningApplicationId 423poi45 -SortByStorage Ascending -Paged
101127
```
102128

103-
Example 6 displays a paged view of the the containers belonging to the application, sorted in ascending order of storage.
129+
Example 7 displays a paged view of the containers belonging to the application, sorted in ascending order of storage.
104130

105-
### Example 7
131+
### Example 8
106132

107133
```powershell
108134
Get-SPOContainer -OwningApplicationId 423poi45-as -SortByStorage Ascending -Paged -PagingToken <zacad>
109135
```
110136

111-
Example 7 displays the next list of paged view of containers belonging to the application, sorted in ascending order of storage.
137+
Example 8 displays the next list of paged view of containers belonging to the application, sorted in ascending order of storage.
112138

113-
### Example 8
139+
### Example 9
114140

115141
```powershell
116142
Get-SPOContainer -OwningApplicationId 423poi45 -ArchiveStatus RecentlyArchived | ft
117143
```
118144

119-
Example 8 returns a tabular list of recently archived containers belonging to the SharePoint Embedded application with the OwningApplicationId of 423poi45.
145+
Example 9 returns a tabular list of recently archived containers belonging to the SharePoint Embedded application with the OwningApplicationId of 423poi45.
120146

121147
## PARAMETERS
122148

@@ -130,7 +156,7 @@ The ArchiveStatus parameter is used to display containers in various stages of a
130156
- RecentlyArchived – Displays containers in the "Recently archived" state.
131157
- FullyArchived – Displays containers in the "Fully archived" state.
132158
- Reactivating – Displays containers in the "Reactivating" state.
133-
- NotArchived – Displays active containers
159+
- NotArchived – Displays active containers.
134160

135161
```yaml
136162
Type: Microsoft.Online.SharePoint.TenantAdministration.SPContainerArchiveStatusFilterProperties
@@ -203,7 +229,7 @@ Accept wildcard characters: False
203229

204230
> Applicable: SharePoint Online
205231

206-
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.
232+
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` parameter needs to be used along with this parameter.
207233

208234
```yaml
209235
Type: System.String
@@ -219,6 +245,8 @@ Accept wildcard characters: False
219245

220246
### -SortByStorage
221247

248+
> Applicable: SharePoint Online
249+
222250
This parameter can be used when you need to see the list of containers, sorted by storage.
223251

224252
```yaml
@@ -235,6 +263,9 @@ Accept wildcard characters: False
235263
```
236264

237265
### CommonParameters
266+
267+
> Applicable: SharePoint Online
268+
238269
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
239270

240271
## INPUTS

0 commit comments

Comments
 (0)