Get-SPOContainer
Returns one or more containers in a SharePoint Embedded application.
Syntax
Get-SPOContainer
-Identity <SPOContainerPipeBind>
[<CommonParameters>]Get-SPOContainer
[-OwningApplicationId] <Guid>
[-Paged]
[[-PagingToken] <String>]
[<CommonParameters>]Get-SPOContainer
[-OwningApplicationId] <Guid>
[-Paged]
[[-PagingToken] <String>]
[-SortByStorage] <SortOrder>
[<CommonParameters>]Get-SPOContainer
[-OwningApplicationId] <Guid>
[-Paged]
[[-PagingToken] <String>]
[[-SortByStorage] <SortOrder>]
[-ArchiveStatus] <SPContainerArchiveStatusFilterProperties>
[<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
Containers in the Recycle Bin will not be retrieved by using the Get-SPOContainer cmdlet.
The OwningApplicationId for Microsoft Loop is a187e399-0c36-4b98-8f04-1edc167a0996.
The OwningApplicationId for Microsoft Designer is 5e2795e3-ce8c-4cfb-b302-35fe5cd01597.
Examples
Example 1
Get-SPOContainer -Identity b66f5b2eExample 1 returns the detailed properties of the Container with associated Container ID b66f5b2e.
Example 2
Get-SPOContainer -OwningApplicationId 423poi45 | ftExample 2 returns a tabular list of Containers created under the SharePoint Embedded application with the OwningApplicationId of 423poi45.
Example 3
Get-SPOContainer -OwningApplicationId 423poi45 -Paged | ftExample 3 uses the -Paged command to retrieve a paging token.
Example 4
Get-SPOContainer -OwningApplicationId 423poi45 -Paged -PagingToken <zacad> | ftExample 4 uses the -PagingToken parameter along with the -Paged parameter to view more containers that were not displayed in Example 3.
Example 5
Get-SPOContainer -OwningApplicationId 423poi45 -SortByStorage AscendingExample 5 displays the containers belonging to the application, sorted in ascending order of storage.
Example 6
Get-SPOContainer -OwningApplicationId 423poi45 -SortByStorage Ascending -PagedExample 6 displays a paged view of the the containers belonging to the application, sorted in ascending order of storage.
Example 7
Get-SPOContainer -OwningApplicationId 423poi45-as -SortByStorage Ascending -Paged -PagingToken <zacad>Example 7 displays the next list of paged view of containers belonging to the application, sorted in ascending order of storage.
Example 8
Get-SPOContainer -OwningApplicationId 423poi45 -ArchiveStatus RecentlyArchived | ftExample 8 returns a tabular list of recently archived containers belonging to the SharePoint Embedded application with the OwningApplicationId of 423poi45.
Parameters
-ArchiveStatus
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
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Online |
-Identity
Use this parameter to specify the Container ID.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Online |
-OwningApplicationId
This parameter specifies the ID of the SharePoint Embedded application. Use the Get-SPOApplication command to retrieve the OwningApplicationId.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Online |
-Paged
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.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Online |
-PagingToken
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.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Online |
-SortByStorage
This parameter can be used when you need to see the list of containers, sorted by storage.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Online |