Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 47 additions & 24 deletions sharepoint/sharepoint-ps/sharepoint-online/Get-SPOContainer.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,48 +21,32 @@ Returns one or more containers in a SharePoint Embedded application.
### ParamSet1

```powershell
Get-SPOContainer -Identity <ContainerId> [<CommonParameters>]
Get-SPOContainer -Identity <SPOContainerPipeBind> [<CommonParameters>]
```

### ParamSet2

```powershell
Get-SPOContainer -OwningApplicationId <OwningApplicationId> [<CommonParameters>]
Get-SPOContainer [-OwningApplicationId] <Guid> [-Paged] [[-PagingToken] <String>] [<CommonParameters>]
```

### ParamSet3
```powershell
Get-SPOContainer -OwningApplicationId <OwningApplicationId> [-Paged] [<CommonParameters>]
Get-SPOContainer [-OwningApplicationId] <Guid> [-Paged] [[-PagingToken] <String>] [-SortByStorage] <SortOrder> [<CommonParameters>]
```

### ParamSet4
```powershell
Get-SPOContainer -OwningApplicationId <OwningApplicationId> [-Paged] [-PagingToken <TokenString>] [<CommonParameters>]
```

### ParamSet5

```powershell
Get-SPOContainer -OwningApplicationId <OwningApplicationId> [-SortByStorage <Ascending | Descending>] [<CommonParameters>]
```

### ParamSet6

```powershell
Get-SPOContainer -OwningApplicationId <OwningApplicationId> [-SortByStorage <Ascending | Descending>] [-Paged] [<CommonParameters>]
```
### ParamSet7

```powershell
Get-SPOContainer -OwningApplicationId <OwningApplicationId> [-SortByStorage <Ascending | Descending>] [-Paged] [-PagingToken <TokenString>] [<CommonParameters>]
Get-SPOContainer [-OwningApplicationId] <Guid> [-Paged] [[-PagingToken] <String>] [[-SortByStorage] <SortOrder>] [-ArchiveStatus] <SPContainerArchiveStatusFilterProperties> [<CommonParameters>]
```

## DESCRIPTION

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.
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](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell).


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

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

### Example 8

```powershell
Get-SPOContainer -OwningApplicationId 423poi45 -ArchiveStatus RecentlyArchived | ft
```

Example 8 returns a tabular list of recently archived containers belonging to the SharePoint Embedded application with the OwningApplicationId of 423poi45.


## PARAMETERS

Expand Down Expand Up @@ -167,7 +159,7 @@ Accept wildcard characters: False

### -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.
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.

```yaml
Type: String
Expand All @@ -185,7 +177,7 @@ Accept wildcard characters: False

### -PagingToken

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.
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.

```yaml
Type: String
Expand Down Expand Up @@ -214,6 +206,37 @@ Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -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


```yaml
Type: String
Applicable: SharePoint Online

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

### CommonParameters
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).


## RELATED LINKS

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