Get-SPOContainer
Returns one or more containers in a SharePoint Embedded application.
Syntax
All (Default)
Get-SPOContainer
[[-PagingToken] <String>]
[[-SortByStorage] <SortOrder>]
[[-ArchiveStatus] <SPContainerArchiveStatusFilterProperties>]
[-Identity <SPOContainerPipeBind>]
[-Paged]
[-ProgressAction <ActionPreference>]
[<CommonParameters>]
OwningApplicationId
Get-SPOContainer
[-OwningApplicationId] <Guid>
[[-PagingToken] <String>]
[-Paged]
[-ProgressAction <ActionPreference>]
[<CommonParameters>]
Sort
Get-SPOContainer
[-OwningApplicationId] <Guid>
[[-PagingToken] <String>]
[-SortByStorage] <SortOrder>
[-Paged]
[-ProgressAction <ActionPreference>]
[<CommonParameters>]
Archive
Get-SPOContainer
[-OwningApplicationId] <Guid>
[[-PagingToken] <String>]
[[-SortByStorage] <SortOrder>]
[-ArchiveStatus] <SPContainerArchiveStatusFilterProperties>
[-Paged]
[-ProgressAction <ActionPreference>]
[<CommonParameters>]
Identity
Get-SPOContainer
-Identity <SPOContainerPipeBind>
[-ProgressAction <ActionPreference>]
[<CommonParameters>]
Description
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.
You must be a SharePoint Embedded Administrator to run this cmdlet.
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.
Note
You can't retrieve containers in the Recycle Bin using this cmdlet.
Use the following OwningApplicationId values to identify specific Microsoft applications:
| Application | OwningApplicationId |
|---|---|
| Microsoft Declarative Agent | e8be65d6-d430-4289-a665-51bf2a194bda |
| Microsoft Designer | 5e2795e3-ce8c-4cfb-b302-35fe5cd01597 |
| Microsoft Loop | a187e399-0c36-4b98-8f04-1edc167a0996 |
| Microsoft Outlook Newsletters | 155d75a8-799c-4ad4-ae3f-0084ccced5fa |
| Microsoft Teams Events Video on Demand | 7fc21101-d09b-4343-8eb3-21187e0431a4 |
Examples
Example 1
Get-SPOContainer
Example 1 returns the details of all the containers in the tenant.
Example 2
Get-SPOContainer -Identity b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_8U
Example 2 returns the detailed properties of the Container with associated Container ID b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_8U.
Example 3
Get-SPOContainer -OwningApplicationId 2ce03211-353e-45d7-b487-8ac6981332cf | ft
Example 3 returns a tabular list of Containers created under the SharePoint Embedded application with the OwningApplicationId of 2ce03211-353e-45d7-b487-8ac6981332cf.
Example 4
Get-SPOContainer -OwningApplicationId 2ce03211-353e-45d7-b487-8ac6981332cf -Paged | ft
Example 4 uses the -Paged command to retrieve a paging token.
Example 5
Get-SPOContainer -OwningApplicationId 2ce03211-353e-45d7-b487-8ac6981332cf -Paged -PagingToken <zacad> | ft
Example 5 uses the -PagingToken parameter along with the -Paged parameter to view more containers that were not displayed in Example 3.
Example 6
Get-SPOContainer -OwningApplicationId 2ce03211-353e-45d7-b487-8ac6981332cf -SortByStorage Ascending
Example 6 displays the containers belonging to the application, sorted in ascending order of storage.
Example 7
Get-SPOContainer -OwningApplicationId 2ce03211-353e-45d7-b487-8ac6981332cf -SortByStorage Ascending -Paged
Example 7 displays a paged view of the containers belonging to the application, sorted in ascending order of storage.
Example 8
Get-SPOContainer -OwningApplicationId 2ce03211-353e-45d7-b487-8ac6981332cf -SortByStorage Ascending -Paged -PagingToken <zacad>
Example 8 displays the next list of paged view of containers belonging to the application, sorted in ascending order of storage.
Example 9
Get-SPOContainer -OwningApplicationId 2ce03211-353e-45d7-b487-8ac6981332cf -ArchiveStatus RecentlyArchived | ft
Example 9 returns a tabular list of recently archived containers belonging to the SharePoint Embedded application with the OwningApplicationId of 423poi45.
Parameters
-ArchiveStatus
Applicable: SharePoint Online
The ArchiveStatus parameter is used to display containers in various stages of archiving. The following states are supported:
- Archived – Displays containers in all archived states.
- RecentlyArchived – Displays containers in the "Recently archived" state.
- FullyArchived – Displays containers in the "Fully archived" state.
- Reactivating – Displays containers in the "Reactivating" state.
- NotArchived – Displays active containers.
Parameter properties
| Type: | Microsoft.Online.SharePoint.TenantAdministration.SPContainerArchiveStatusFilterProperties |
| Default value: | None |
| Accepted values: | NotArchived, FullyArchived, RecentlyArchived, Reactivating, Archived |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Archive
| Position: | 1 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Identity
Applicable: SharePoint Online
Use this parameter to specify the Container ID.
Parameter properties
| Type: | Microsoft.Online.SharePoint.PowerShell.SPOContainerPipeBind |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Identity
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-OwningApplicationId
Applicable: SharePoint Online
This parameter specifies the ID of the SharePoint Embedded application. Use the Get-SPOApplication command to retrieve the OwningApplicationId.
Parameter properties
| Type: | System.Guid |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
OwningApplicationId
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
Sort
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
Archive
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Paged
Applicable: SharePoint Online
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.
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
OwningApplicationId
| Position: | 1 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
Sort
| Position: | 1 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
Archive
| Position: | 1 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-PagingToken
Applicable: SharePoint Online
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.
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
OwningApplicationId
| Position: | 2 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
Sort
| Position: | 2 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
Archive
| Position: | 2 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-SortByStorage
Applicable: SharePoint Online
This parameter can be used when you need to see the list of containers, sorted by storage.
Parameter properties
| Type: | Microsoft.Online.SharePoint.TenantManagement.SortOrder |
| Default value: | None |
| Accepted values: | Ascending, Descending |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Sort
| Position: | 1 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.