diff --git a/docs/embedded/administration/consuming-tenant-admin/cta.md b/docs/embedded/administration/consuming-tenant-admin/cta.md index 27b49467c2..3c5476efe5 100644 --- a/docs/embedded/administration/consuming-tenant-admin/cta.md +++ b/docs/embedded/administration/consuming-tenant-admin/cta.md @@ -41,6 +41,7 @@ On PowerShell, the SharePoint Embedded Admin can run the following cmdlets: 1. Enumerate applications in a tenant 1. Enumerate containers of an application in a tenant 1. Enumerate containers of an application sorted by storage basis storage +2. Enumerate archived containers of an application 1. Edit the sensitivity label on a container 1. Set the sharing capability configuration on a container @@ -51,8 +52,10 @@ For information on consuming tenant admin in [PowerShell](../consuming-tenant-ad The SharePoint Embedded Admin can access the Active and Deleted containers page on SPAC and perform SharePoint Embedded application-level and container-level actions. This includes the following: 1. View the Active container page +2. View the Archived container page 1. View the Deleted container page 1. View the detailed information of a container +2. Archive and reactivate containers 1. Soft delete, restore, and purge deleted containers For information on consuming tenant admin in SharePoint Admin, see [container management](ctaUX.md) @@ -67,13 +70,14 @@ To use passthrough billing SharePoint Embedded app, the SharePoint Embedded Admi ### [Meters](../billing/meters.md) -SharePoint Embedded employs a pay-as-you-go (PAYG) billing model through an Azure subscription. Billing is determined by how much data in GB you store in SharePoint Embedded, transactions used to access and modify the container and container contents, and data that is egressed from the SharePoint Embedded platform. Each of these factors contributes to the overall cost, ensuring that you only pay for the resources and services you use. You can view this usage and billing details in the [Azure Cost Management](https://ms.portal.azure.com/). +SharePoint Embedded employs a pay-as-you-go (PAYG) billing model through an Azure subscription. Billing is determined by how much data in GB you store in SharePoint Embedded in active and archived states, transactions used to access and modify the container and container contents, and data that is egressed from the SharePoint Embedded platform. Each of these factors contributes to the overall cost, ensuring that you only pay for the resources and services you use. You can view this usage and billing details in the [Azure Cost Management](https://ms.portal.azure.com/). SharePoint Embedded has three billing meters, as shown. Refer to the [product page](https://adoption.microsoft.com/en-us/sharepoint/embedded/) for pricing details | SharePoint Embedded Service Meters | Meter Unit | | :--------------------------------: | :------------: | | Storage | $/GB | +| Archived Storage | $/GB | | API Transactions | $/Transactions | | Egress | $/GB | diff --git a/docs/embedded/administration/consuming-tenant-admin/ctaUX.md b/docs/embedded/administration/consuming-tenant-admin/ctaUX.md index 052f26f50e..85c1b0f0d3 100644 --- a/docs/embedded/administration/consuming-tenant-admin/ctaUX.md +++ b/docs/embedded/administration/consuming-tenant-admin/ctaUX.md @@ -15,9 +15,12 @@ For information on the SharePoint Embedded Administrator role, see [SharePoint E The following actions are supported in SharePoint Admin Center: 1. View active containers in the tenant +2. View archived containers in the tenant 1. View deleted containers in the tenant 1. View detailed information about a container -1. Delete a container +2. Archive an active container +1. Reactivate an archived container +1. Delete an active or archived container 1. Restore a deleted container 1. Permanently deleted a container 2. Sort active containers in the tenant @@ -65,6 +68,68 @@ The detailed container view provides a deeper dive into container-specific metad ![SharePoint Embedded Membership Roles](../../images/ctaux5.png) +## Archived Containers + +The Archived containers page lists all containers in the tenant's archived container collection. It lists the following metadata: + +1. Container name +1. Application name +1. Publisher +1. Status +1. Time archived +1. Archived by +1. Storage (GB) +1. Ownership type +1. Principal owner + +![Archived Containers](../../images/ArchivedContainersPage.png) + +## Archive a container + +A container can be archived when it’s no longer actively used but must be retained for legal, compliance, or business purposes. From the Active containers page, the CTA can select a container and choose Archive option to start the archival process. + +![Active Containers Archive action](../../images/ActiveContainersArchiveAction.png) + +This opens the side panel that educates admin about the implication of archival action and ways of getting back the archived content. The CTA can at this stage either cancel the panel and go back to the active containers page or proceed further with the archival by clicking on “Archive”. + +![Archive Containers Confirmation Panel](../../images/ArchiveContainerConfirmationPanel.png) + +The selected container is successfully archived and moved into the Archived containers page. + +![Container Archival confirmed](../../images/ContainerArchivedConfirmation.png) + +## Reactivate Archived Containers + +Archived containers aren’t accessible to users or applications until they’re reactivated. The time required to reactivate a container depends on how long it has been archived. Containers archived within the last seven days are in the Recently archived state. After this period, containers transition to the Fully archived state. + +### Reactivate Recently Archived Containers + +From the Archived containers page, the CTA can select a Recently archived container and choose Reactivate option to start the reactivation process. + +![Reactivate Recently Archived Container](../../images/ReactivateRecentlyArchivedContainer.png) + +This opens a side panel that informs admin about the reactivation time. The CTA can at this stage either cancel the panel and go back to the Archived containers page or proceed further with the reactivation by clicking on “Reactivate”. + +![Reactivate Recently Archived Container Confirmation](../../images/ReactivateRecentlyArchivedContainerConfirmation.png) + +The selected container is successfully reactivated and moved into the Active containers page. + +![Container Reactivated Confirmation](../../images/ContainerReactivatedConfirmation.png) + +### Reactivate Fully Archived Containers + +From the Archived containers page, the CTA can select a Fully archived container and choose Reactivate option to start the reactivation process. + +![Reactivate Fully Archived Container](../../images/ReactivateFullyArchivedContainer.png) + +This opens a side panel that informs admin about the reactivation time of __24 hours__. The CTA can at this stage either cancel the panel and go back to the Archived containers page or proceed further with the reactivation by clicking on “Reactivate”. + +![Reactivate Fully Archived Container Confirmation](../../images/ReactivateFullyArchivedContainerConfirmation.png) + +Reactivation request gets submitted for the selected container and it is displayed on the Archived containers page in the "Reactivating" state. Once the reactivation completes after 24 hours, the container is moved to the Active containers page. + +![Reactivation Request Submission](../../images/ReactivationRequestSubmission.png) + ## Deleted Containers The deleted containers page lists all containers in the tenant's deleted container collection. It lists the following metadata: @@ -106,13 +171,15 @@ The selected container is successfully deleted and moved into the deleted contai **Deleted containers are permanently purged after 93 days unless there is a retention policy applied to the containers.** +Archived containers page also provides the same delete experience for selecting archived containers and deleting. + ## Restore a container A container in the deleted container collection can be restored on the Deleted containers page by selecting the corresponding containers by selecting the "Restore" link ![Restore Button SPE Container](../../images/ctaux10.png) -Restoration of the container happens in the background and the status of the same is displayed on the top-right corner of the page. Upon successful restoration, the container will be available in the Active Containers page. +Restoration of the container happens in the background and the status of the same is displayed on the top-right corner of the page. Upon successful restoration, the container will be available in the Active Containers page. If the container was in archived state at the time of deletion, then the container will be restored back to archived state. ![Restored SPE Container](../../images/ctaux11.png) diff --git a/docs/embedded/development/support-archival-of-containers.md b/docs/embedded/development/support-archival-of-containers.md new file mode 100644 index 0000000000..5e0eacb76a --- /dev/null +++ b/docs/embedded/development/support-archival-of-containers.md @@ -0,0 +1,31 @@ +--- +title: Support archival of SharePoint Embedded containers +description: This article explains how archival functionality can be supported for a container type. +ms.date: 03/20/2026 +ms.localizationpriority: high +--- + +# Onboard your application to support archival functionality + +Archival of containers helps customers in reducing the cost of storing infrequently used data. Support archival in your application by enabling the -IsArchiveEnabled flag using the following PowerShell cmdlet. This cmdlet is supported only by the SharePoint Embedded administrator of your organization. + +Use the following command on already existing container type: + +```powershell +Set-SPOContainerTypeConfiguration -ContainerTypeId -IsArchiveEnabled $true +``` + +Use the following command while creating a new container type: + +```powershell +New-SPOContainerType -ContainerTypeName -OwningApplicationId -IsArchiveEnabled $true +``` + +APIs for supporting the archive and reactivate actions on the containers: + +|Action|API Documentation link|Example| +|--------|--------|-------| +|Archive an active container|[Archive](https://learn.microsoft.com/graph/api/filestoragecontainer-archive)|POST https://graph.microsoft.com/beta/storage/fileStorage/containers/{ContainerId}/archive| +|Reactivate an archived container|[Unarchive](https://learn.microsoft.com/graph/api/filestoragecontainer-unarchive)|POST https://graph.microsoft.com/beta/storage/fileStorage/containers/{containerId}/unarchive| +|Retrieve an archived container using ID|[Get](https://learn.microsoft.com/graph/api/filestoragecontainer-get)|GET https://graph.microsoft.com/beta/storage/fileStorage/containers/{containerId}| +|Retrieve all archived container collection|[Get](https://learn.microsoft.com/graph/api/filestoragecontainer-get)|GET https://graph.microsoft.com/beta/storage/fileStorage/containers?$filter=containerTypeId eq {containerTypeId} and archivalDetails ne null| diff --git a/docs/embedded/getting-started/m365-archive-support-for-containers.md b/docs/embedded/getting-started/m365-archive-support-for-containers.md new file mode 100644 index 0000000000..ad63eacc40 --- /dev/null +++ b/docs/embedded/getting-started/m365-archive-support-for-containers.md @@ -0,0 +1,26 @@ +--- +title: Microsoft 365 Archive support for SharePoint Embedded containers +description: This article provides overview of Microsoft 365 Archive support for archival of SharePoint Embedded containers +ms.date: 03/20/2026 +ms.localizationpriority: high +--- + +# Microsoft 365 Archive for SharePoint Embedded Containers (Preview) + +Microsoft 365 Archive provides a cost-effective storage option for inactive or aging content stored in SharePoint Embedded containers. + +Your organization and consuming tenants might need to retain data for extended periods to meet legal, compliance, or regulatory requirements. You might prefer to store the data in SharePoint to simplify searchability, security, compliance, and data lifecycle management. + +Microsoft 365 Archive enables you to retain inactive SharePoint Embedded container data by moving it to a cold storage tier (archive) within SharePoint. Archived data continues to benefit from the same Microsoft 365 security, compliance, and search standards, while significantly reducing storage costs. + +Once a container is archived, it becomes inaccessible. To access it again, the container must be reactivated. Reactivation is instantaneous if performed within the first 7 days after archival. If reactivated after 7 days, the process can take up to 24 hours to complete. + +Archival and reactivation actions are supported for users with the Owner or Principal Owner roles on the container. Global Administrators and SharePoint Embedded Administrators can perform these actions on all containers. In addition, the application must have write permission on the container. + +Microsoft 365 Archive is available for SharePoint sites. Detailed documentation is available here: [Microsoft 365 Archive Overview](https://learn.microsoft.com/microsoft-365/archive/archive-overview) + +### SharePoint Embedded container archival guide + +- Developer tenant guide: [Support archival of containers](../development/support-archival-of-containers.md) + +- Consuming tenant guide: [Manage Archival of containers using SharePoint Admin Center](../administration/consuming-tenant-admin/ctaUX.md) diff --git a/docs/embedded/images/ActiveContainersArchiveAction.png b/docs/embedded/images/ActiveContainersArchiveAction.png new file mode 100644 index 0000000000..006d64d875 Binary files /dev/null and b/docs/embedded/images/ActiveContainersArchiveAction.png differ diff --git a/docs/embedded/images/ArchiveContainerConfirmationPanel.png b/docs/embedded/images/ArchiveContainerConfirmationPanel.png new file mode 100644 index 0000000000..874523677f Binary files /dev/null and b/docs/embedded/images/ArchiveContainerConfirmationPanel.png differ diff --git a/docs/embedded/images/ArchivedContainersPage.png b/docs/embedded/images/ArchivedContainersPage.png new file mode 100644 index 0000000000..2120b11ec2 Binary files /dev/null and b/docs/embedded/images/ArchivedContainersPage.png differ diff --git a/docs/embedded/images/ContainerArchivedConfirmation.png b/docs/embedded/images/ContainerArchivedConfirmation.png new file mode 100644 index 0000000000..f5b706ac09 Binary files /dev/null and b/docs/embedded/images/ContainerArchivedConfirmation.png differ diff --git a/docs/embedded/images/ContainerReactivatedConfirmation.png b/docs/embedded/images/ContainerReactivatedConfirmation.png new file mode 100644 index 0000000000..202f4a598b Binary files /dev/null and b/docs/embedded/images/ContainerReactivatedConfirmation.png differ diff --git a/docs/embedded/images/ReactivateFullyArchivedContainer.png b/docs/embedded/images/ReactivateFullyArchivedContainer.png new file mode 100644 index 0000000000..cab9f72b58 Binary files /dev/null and b/docs/embedded/images/ReactivateFullyArchivedContainer.png differ diff --git a/docs/embedded/images/ReactivateFullyArchivedContainerConfirmation.png b/docs/embedded/images/ReactivateFullyArchivedContainerConfirmation.png new file mode 100644 index 0000000000..406dfa2623 Binary files /dev/null and b/docs/embedded/images/ReactivateFullyArchivedContainerConfirmation.png differ diff --git a/docs/embedded/images/ReactivateRecentlyArchivedContainer.png b/docs/embedded/images/ReactivateRecentlyArchivedContainer.png new file mode 100644 index 0000000000..f6e269faed Binary files /dev/null and b/docs/embedded/images/ReactivateRecentlyArchivedContainer.png differ diff --git a/docs/embedded/images/ReactivateRecentlyArchivedContainerConfirmation.png b/docs/embedded/images/ReactivateRecentlyArchivedContainerConfirmation.png new file mode 100644 index 0000000000..1d229998f5 Binary files /dev/null and b/docs/embedded/images/ReactivateRecentlyArchivedContainerConfirmation.png differ diff --git a/docs/embedded/images/ReactivationRequestSubmission.png b/docs/embedded/images/ReactivationRequestSubmission.png new file mode 100644 index 0000000000..3c9724cb7b Binary files /dev/null and b/docs/embedded/images/ReactivationRequestSubmission.png differ diff --git a/docs/toc.yml b/docs/toc.yml index 551e034d96..dfba461084 100644 --- a/docs/toc.yml +++ b/docs/toc.yml @@ -596,6 +596,8 @@ href: embedded/getting-started/containertypes.md - name: Register Container Type API href: embedded/getting-started/register-api-documentation.md + - name: Microsoft 365 Archive support for containers + href: embedded/getting-started/m365-archive-support-for-containers.md - name: Development items: - name: Application Architecture @@ -608,6 +610,8 @@ href: embedded/development/limits-calling.md - name: Fluid Framework href: embedded/development/fluid.md + - name: Support archive funcationality in your application + href: embedded/development/support-archival-of-containers.md - name: Office Experiences href: embedded/development/content-experiences/office-experience.md - name: User Experiences