Skip to content
Merged
Show file tree
Hide file tree
Changes from 6 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
89 changes: 79 additions & 10 deletions sharepoint/sharepoint-ps/sharepoint-online/Get-SPOContainer.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,48 +21,81 @@ Returns one or more containers in a SharePoint Embedded application.
### ParamSet1

```powershell
Get-SPOContainer -Identity <ContainerId> [<CommonParameters>]
Get-SPOContainer [[-Identity] <Guid>] [<CommonParameters>]
Comment thread
ShreyasSar26 marked this conversation as resolved.
Outdated
```

### ParamSet2

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

### ParamSet3
```powershell
Get-SPOContainer -OwningApplicationId <OwningApplicationId> [-Paged] [<CommonParameters>]
Get-SPOContainer [[-OwningApplicationId] <Guid>] [-Paged] [<CommonParameters>]
```

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

### ParamSet5

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

### ParamSet6

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

```powershell
Get-SPOContainer -OwningApplicationId <OwningApplicationId> [-SortByStorage <Ascending | Descending>] [-Paged] [-PagingToken <TokenString>] [<CommonParameters>]
Get-SPOContainer [[-OwningApplicationId] <Guid>] [-SortByStorage <Ascending | Descending>] [-Paged] [[-PagingToken] <TokenString>] [<CommonParameters>]
```
### ParamSet8

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

### ParamSet9
```powershell
Get-SPOContainer [[-OwningApplicationId] <Guid>] [[-ArchiveStatus] <String>][-Paged] [<CommonParameters>]
```

### ParamSet10
```powershell
Get-SPOContainer [[-OwningApplicationId] <Guid>] [[-ArchiveStatus]<String>][-Paged] [-PagingToken <TokenString>] [<CommonParameters>]
```

### ParamSet11

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

### ParamSet12

```powershell
Get-SPOContainer [[-OwningApplicationId] <Guid>] [[-ArchiveStatus] <String>][-SortByStorage <Ascending | Descending>] [-Paged] [<CommonParameters>]
```
### ParamSet13

```powershell
Get-SPOContainer [[-OwningApplicationId] <Guid>] [-ArchiveStatus<String>][-SortByStorage <Ascending | Descending>] [-Paged] [[-PagingToken] <TokenString>] [<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 +161,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 +208,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 +226,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 +255,34 @@ 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
```


## RELATED LINKS

[Intro to SharePoint Embedded Containers Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell)
Expand Down
54 changes: 36 additions & 18 deletions sharepoint/sharepoint-ps/sharepoint-online/Set-SPOContainer.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,39 @@
---
external help file: sharepointonline.xml
Module Name: Microsoft.Online.SharePoint.PowerShell
online version: https://learn.microsoft.com/powershell/module/sharepoint-online/set-SPOContainer
online version: https://learn.microsoft.com/powershell/module/sharepoint-online/Set-SPOContainer
Applicable: SharePoint Embedded
title: Set-SPOContainer
schema: 2.0.0
author: abiramisuresh
ms.author: abisuresh
author: ShreyasSar26
ms.author: shsaravanan
ms.reviewer:
---

# Set-SPOContainer

## SYNOPSIS

Sets or updates one or more property values for a Container in SharePoint Embedded.
Sets or updates one or more property values for a container in SharePoint Embedded.

## SYNTAX

### ParamSet1

```powershell
Set-SPOContainer [-Identity]
[-BlockDownloadPolicy <Boolean>]
[-ConditionalAccessPolicy <SPOConditionalAccessPolicyType>]
[-SensitivityLabel <String>]
Set-SPOContainer [[-Identity]<String>]
[[-BlockDownloadPolicy <Boolean>]]
[[-ConditionalAccessPolicy] <SPOConditionalAccessPolicyType>]
[[-SensitivityLabel] <String>]
[-RemoveLabel]
```

## DESCRIPTION

For any parameters that are passed in, the `Set-SPOContainer` cmdlet sets or updates the setting for the Container collection identified by the parameter Identity.
For any parameters that are passed in, the `Set-SPOContainer` cmdlet sets or updates the setting for the active container identified by the parameter `Identity`. The cmdlet throws an error if the identity of an archived container is provided.

You must be a SharePoint Embedded Administrator to run the cmdlet.

You must be at least a SharePoint administrator to run the cmdlet.

For permissions and the most current information about Windows PowerShell for SharePoint Embedded Containers, see the online documentation at [Intro to SharePoint Embedded Containers Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps).

Expand All @@ -52,27 +53,42 @@ Example 1 sets the Block Download policy on the Container mentioned in the Ident
Set-SPOContainer -Identity https://contoso.sharepoint.com/contentstorage/CSP_33a63968-abae-49a3-a255-f83d0ab2260a/ -ConditionalAccessPolicy AllowLimitedAccess
```

In this example, limited access is provided to content residing in the Container.
In this example, limited access is provided to content residing in the container.

### Example 3

```powershell
Set-SPOContainer -Identity https://contoso.sharepoint.com/contentstorage/CSP_33a63968-abae-49a3-a255-f83d0ab2260a/ -SensitivityLabel ab310e93-9f19-43f2-bc19-bf3386dc0956
```
This example sets a sensitivity label on the Container.
This example sets a sensitivity label on the container.

### Example 4
```powershell
Set-SPOContainer -Identity https://contoso.sharepoint.com/contentstorage/CSP_33a63968-abae-49a3-a255-f83d0ab2260a/ -RemoveLabel
```
This example sets any previously set sensitivity label on the Container.
This example sets any previously set sensitivity label on the container.

## PARAMETERS

### -Identity

Use this parameter to specify the container url.

```yaml
Type: String
Applicable: SharePoint Embedded
Required: True
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
```


### -BlockDownloadPolicy
As a SharePoint Administrator or above in Microsoft 365, you can block the download of files from SharePoint Embedded Containers. This feature does not need Microsoft Entra Conditional Access policies. This feature can be set for individual Containers but not at the organization level.
As a SharePoint Embedded Administrator, you can block the download of files from SharePoint Embedded containers. This feature does not need Microsoft Entra Conditional Access policies. This feature can be set for individual containers but not at the organization level.

Blocking the download of files allows users to remain productive while addressing the risk of accidental data loss. Users have browser-only access with no ability to download, print, or sync files. They also won't be able to access content through apps, including the Microsoft Office desktop apps. When web access is limited, users will see the following message at the top of Containers: "Your organization doesn't allow you to download, print, or sync from this Container. For help contact your IT department." Read the full documentation for advanced capabilities at [Block download policy for SharePoint Containers and OneDrive](/sharepoint/block-download-from-sites).
Blocking the download of files allows users to remain productive while addressing the risk of accidental data loss. Users have browser-only access with no ability to download, print, or sync files. They also won't be able to access content through apps, including the Microsoft Office desktop apps. When web access is limited, users will see the following message at the top of containers: "Your organization doesn't allow you to download, print, or sync from this Container. For help contact your IT department." Read the full documentation for advanced capabilities at [Block download policy for SharePoint Containers and OneDrive](/sharepoint/block-download-from-sites).

PARAMVALUE: $true | $false

Expand All @@ -89,7 +105,7 @@ Accept wildcard characters: False
```

### -ConditionalAccessPolicy
Read the [Control access from unmanaged devices](/sharepoint/control-access-from-unmanaged-devices) documentation to understand Conditional Access Policy usage in SharePoint Embedded Container.
Read the [Control access from unmanaged devices](/sharepoint/control-access-from-unmanaged-devices) documentation to understand Conditional Access Policy usage in SharePoint Embedded container.

Possible values:
- AllowFullAccess: Allows full access from desktop apps, mobile apps, and the web.
Expand Down Expand Up @@ -124,7 +140,7 @@ Accept wildcard characters: False
```

### -RemoveLabel
This parameter allows you to remove the assigned sensitivity label on a Container.
This parameter allows you to remove the assigned sensitivity label on a container.

```yaml
Type: SwitchParameter
Expand All @@ -141,4 +157,6 @@ Accept wildcard characters: False

[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online?view=sharepoint-ps)

[Set-SPOTenant](set-spotenant.md)
[Set-SPOTenant](./set-spotenant.md)

[Get-SPOContainer](./Get-SPOContainer.md)