Edit

PowerShell reference

Applies to: Consuming tenant administrator

SharePoint Embedded administrators use the latest SharePoint Online Management Shell and connect with Connect-SPOService. Users must be SharePoint Embedded Administrators or Global Administrators for the supported container administration cmdlets.

For task guidance, see manage containers with PowerShell.

Application administration

Task Cmdlet Parameters Example
List SharePoint Embedded applications Get-SPOApplication None Get-SPOApplication
Get a specific owning application Get-SPOApplication -OwningApplicationId Get-SPOApplication -OwningApplicationId <OwningApplicationId>
View guest application permissions Get-SPOApplication -OwningApplicationId, -ApplicationId Get-SPOApplication -OwningApplicationId <OwningApplicationId> -ApplicationId <ApplicationId>
Set application sharing capability Set-SPOApplication -OwningApplicationId, -SharingCapability, -OverrideTenantSharingCapability Set-SPOApplication -OwningApplicationId <OwningApplicationId> -SharingCapability <SharingCapability> -OverrideTenantSharingCapability <$OverrideTenantSharingCapability>
Manage guest application permission Set-SPOApplicationPermission -OwningApplicationId, -GuestApplicationId, -PermissionAppOnly, -PermissionDelegated Set-SPOApplicationPermission -OwningApplicationId <OwningApplicationId> -GuestApplicationId <GuestApplicationId> -PermissionAppOnly <AppOnlyPermission> -PermissionDelegated <DelegatedPermission>

SharingCapability accepts Disabled, ExistingExternalUserSharingOnly, ExternalUserSharingOnly, and ExternalUserAndGuestSharing. OverrideTenantSharingCapability can be $true or $false.

Note

Application administration cmdlets don't apply to Microsoft Loop.

Container administration

Task Cmdlet Parameters Example
List active containers for an application Get-SPOContainer -OwningApplicationId Get-SPOContainer -OwningApplicationId <OwningApplicationId> \| FT
List containers sorted by storage Get-SPOContainer -OwningApplicationId, -SortByStorage Get-SPOContainer -OwningApplicationId <OwningApplicationId> -SortByStorage <AscendingOrDescending> \| FT
List archived containers for an application Get-SPOContainer -OwningApplicationId, -ArchiveStatus Get-SPOContainer -OwningApplicationId <OwningApplicationId> -ArchiveStatus Archived \| FT
Get container details Get-SPOContainer -Identity Get-SPOContainer -Identity <ContainerId>
Get container details by site URL Get-SPOContainer -Identity Get-SPOContainer -Identity <siteURL>
Set a sensitivity label Set-SPOContainer -Identity, -SensitivityLabel Set-SPOContainer -Identity <ContainerID> -SensitivityLabel <SensitivityLabel>
Remove a sensitivity label Set-SPOContainer -Identity, -RemoveLabel Set-SPOContainer -Identity <ContainerID> -RemoveLabel
Soft delete a container Remove-SPOContainer -Identity Remove-SPOContainer -Identity <ContainerId>
List deleted containers Get-SPODeletedContainer None Get-SPODeletedContainer
Restore a deleted container Restore-SPODeletedContainer -Identity Restore-SPODeletedContainer -Identity <ContainerId>
Permanently delete a deleted container Remove-SPODeletedContainer -Identity Remove-SPODeletedContainer -Identity <ContainerId>

Deleted containers can be restored from the deleted container collection within 93 days. Permanently deleting a container deletes all documents and files in it. If a container was in the archived state when it was deleted, restoring it returns it to the archived state.

Note

To enumerate Microsoft Loop containers, use owning app ID a187e399-0c36-4b98-8f04-1edc167a0996.