Available in the current Nightly Release only.

Get-PnPContainer

SYNOPSIS

Required Permissions

  • SharePoint: Access to the SharePoint Tenant Administration site

Returns one or more Containers in a SharePoint Embedded application.

SYNTAX

Get-PnPContainer [-Identity <ContainerPipeBind>] [-OwningApplicationId <Guid>] [-Paged <switchparameter>] [-PagingToken <string>][-SortOrder <SortOrder>] [-ArchiveStatus <SPContainerArchiveStatusFilterProperties>] [-Connection <PnPConnection>]

DESCRIPTION

EXAMPLES

EXAMPLE 1

Get-PnPContainer -OwningApplicationId a187e399-0c36-4b98-8f04-1edc167a0996

Returns a tabular list of Containers created under the specified SharePoint Embedded application.

EXAMPLE 2

Get-PnPContainer -OwningApplicationId a187e399-0c36-4b98-8f04-1edc167a0996 -Identity "b!aBrXSxKDdUKZsaK3Djug6C5rF4MG3pRBomypnjOHiSrjkM_EBk_1S57U3gD7oW-1"

Returns the properties of the specified container by using the container id

EXAMPLE 3

Get-PnPContainer -Identity "bc07d4b8-1c2f-4184-8cc2-a52dfd6fe0c4" -Identity  "https://contoso.sharepoint.com/contentstorage/CSP_4bd71a68-8312-4275-99b1-a2b70e3ba0e8"

Returns the properties of the specified container by using the container url

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: SPContainerArchiveStatusFilterProperties
Parameter Sets: (All)

Required: False
Position: Named
Default value: NotArchived
Accept pipeline input: False
Accept wildcard characters: False

-Connection

Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.

Type: PnPConnection
Parameter Sets: (All)

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Identity

Specify container site url or container id.

Type: ContainerPipeBind
Parameter Sets: (All)

Required: False
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-OwningApplicationId

This parameter specifies the ID of the SharePoint repository services application.

To retrieve Containers for the Microsoft Loop app, use OwningApplicationId: a187e399-0c36-4b98-8f04-1edc167a0996. To retrieve Containers for the Microsoft Designer app, use OwningApplicationId: 5e2795e3-ce8c-4cfb-b302-35fe5cd01597

Type: Guid
Parameter Sets: (All)

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Paged

This parameter can be used when there are more than 5,000 Containers in a given SharePoint Embedded application. Using -Paged will provide a that will display the next 5,000 Containers.

Type: SwitchParameter
Parameter Sets: (All)

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-PagingToken

Use this parameter to provide the provided to view the remaining Containers as shown in Example 5. If there are no more Containers to display, the commandlet output will return the message End of Containers view. Otherwise, use the given to retrieve the next batch of up to 5,000 ontainers.

Type: String
Parameter Sets: (All)

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-SortOrder

Use this parameter to specify the sort order. The sorting will be done based on Storage used in ascending or descending order.

Type: SortOrder
Parameter Sets: (All)

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

Microsoft 365 Patterns and Practices