Skip to content

Update Get-SPOContainer.md #980

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Changes from 2 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
Original file line number Diff line number Diff line change
Expand Up @@ -18,27 +18,36 @@ Returns one or more containers in a SharePoint Embedded application.

## SYNTAX

### All (Default)
```
Get-SPOContainer [-Identity <SPOContainerPipeBind>] [-Paged] [[-PagingToken] <String>]
[[-SortByStorage] <SortOrder>] [[-ArchiveStatus] <SPContainerArchiveStatusFilterProperties>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
```

### OwningApplicationId
```
Get-SPOContainer [-OwningApplicationId] <Guid> [-Paged] [[-PagingToken] <String>] [<CommonParameters>]
Get-SPOContainer [-OwningApplicationId] <Guid> [-Paged] [[-PagingToken] <String>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
```


### Sort
```
Get-SPOContainer [-OwningApplicationId] <Guid> [-Paged] [[-PagingToken] <String>] [-SortByStorage] <SortOrder>
[<CommonParameters>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
```

### Archive
```
Get-SPOContainer [-OwningApplicationId] <Guid> [-Paged] [[-PagingToken] <String>]
[[-SortByStorage] <SortOrder>] [-ArchiveStatus] <SPContainerArchiveStatusFilterProperties>
[<CommonParameters>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
```

### Identity
```
Get-SPOContainer -Identity <SPOContainerPipeBind> [<CommonParameters>]
Get-SPOContainer -Identity <SPOContainerPipeBind> [-ProgressAction <ActionPreference>] [<CommonParameters>]
```

## DESCRIPTION
Expand All @@ -53,70 +62,80 @@ For permissions and the most current information about Windows PowerShell for Sh
> 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`.
> The OwningApplicationId for Microsoft Teams Events VOD is `f574b137-eb91-46a0-8811-1a04d80c7ffa`.
> The OwningApplicationId for Microsoft Outlook Newsletters is `a6804318-a92d-4f36-b499-441033991274`.
> The OwningApplicationId for Microsoft Declarative Agent is `3FBEE041-E7D6-4F14-8826-6BF27F0A2849`.

## EXAMPLES

### Example 1

```powershell
Get-SPOContainer
```
Example 1 returns the details of all the containers in the tenant

### Example 2

```powershell
Get-SPOContainer -Identity b66f5b2e
```

Example 1 returns the detailed properties of the Container with associated Container ID b66f5b2e.
Example 2 returns the detailed properties of the Container with associated Container ID b66f5b2e.

### Example 2
### Example 3

```powershell
Get-SPOContainer -OwningApplicationId 423poi45 | ft
```
Example 2 returns a tabular list of Containers created under the SharePoint Embedded application with the `OwningApplicationId` of `423poi45`.
Example 3 returns a tabular list of Containers created under the SharePoint Embedded application with the `OwningApplicationId` of `423poi45`.

### Example 3
### Example 4

```powershell
Get-SPOContainer -OwningApplicationId 423poi45 -Paged | ft
```
Example 3 uses the `-Paged` command to retrieve a paging token.
Example 4 uses the `-Paged` command to retrieve a paging token.

### Example 4
### Example 5

```powershell
Get-SPOContainer -OwningApplicationId 423poi45 -Paged -PagingToken <zacad> | ft
```

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

### Example 5
### Example 6

```powershell
Get-SPOContainer -OwningApplicationId 423poi45 -SortByStorage Ascending
```

Example 5 displays the containers belonging to the application, sorted in ascending order of storage.
Example 6 displays the containers belonging to the application, sorted in ascending order of storage.

### Example 6
### Example 7

```powershell
Get-SPOContainer -OwningApplicationId 423poi45 -SortByStorage Ascending -Paged
```

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

### Example 7
### Example 8

```powershell
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 displays the next list of paged view of containers belonging to the application, sorted in ascending order of storage.

### Example 8
### Example 9

```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.
Example 9 returns a tabular list of recently archived containers belonging to the SharePoint Embedded application with the OwningApplicationId of 423poi45.

## PARAMETERS

Expand Down Expand Up @@ -219,6 +238,8 @@ Accept wildcard characters: False

### -SortByStorage

> Applicable: SharePoint Online

This parameter can be used when you need to see the list of containers, sorted by storage.

```yaml
Expand All @@ -235,6 +256,9 @@ Accept wildcard characters: False
```

### CommonParameters

> Applicable: SharePoint Online

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

## INPUTS
Expand Down