diff --git a/docs/embedded/concepts/admin-exp/consuming-tenant-admin/ctaUX.md b/docs/embedded/concepts/admin-exp/consuming-tenant-admin/ctaUX.md index c986d863f..4d3e1f6b7 100644 --- a/docs/embedded/concepts/admin-exp/consuming-tenant-admin/ctaUX.md +++ b/docs/embedded/concepts/admin-exp/consuming-tenant-admin/ctaUX.md @@ -1,15 +1,15 @@ --- -title: Manage Containers in SharePoint Admin Center +title: Manage containers in SharePoint Admin Center description: This article describes how administrator can manage containers in SPAC. -ms.date: 10/16/2024 +ms.date: 02/05/2025 ms.localizationpriority: high --- # Manage SharePoint Embedded containers in SharePoint Admin Center -The organizations that use the SharePoint Embedded applications on their Microsoft 365 (Microsoft 365) tenants are the consuming tenants and the persona that is responsible for managing these applications on their Microsoft 365 tenancy is the consuming tenant administrator (CTA). Consuming tenant administrators can manage containers through a graphical user interface (GUI) using the [SharePoint Administrator Center](https://go.microsoft.com/fwlink/?linkid=2185219). +The organizations that use the SharePoint Embedded applications on their Microsoft 365 tenants are the consuming tenants and the persona that is responsible for managing these applications on their Microsoft 365 tenancy is the consuming tenant administrator (CTA). Consuming tenant administrators can manage containers through a graphical user interface (GUI) using the [SharePoint Administrator Center](https://go.microsoft.com/fwlink/?linkid=2185219). -To manage SharePoint Embedded containers, CTA need to be assigned the Microsoft 365 SharePoint Embedded Administrator role. Global Administrators in Microsoft 365 have all the permissions of the SharePoint Embedded Administrator role. A global administrator can assign a user the SharePoint Embedded administrator role to act as a consuming tenant admin for SharePoint Embedded. This role is available in both Microsoft Entra and the Microsoft 365 Admin Center. -For information on SharePoint Embedded admin role, see [SharePoint Embedded Admin](../adminrole.md). +To manage SharePoint Embedded containers, the CTA needs to be assigned the SharePoint Embedded Administrator role. +For information on SharePoint Embedded Administrator role, see [SharePoint Embedded Admin](../adminrole.md). The following actions are supported in SharePoint Admin Center: @@ -19,12 +19,17 @@ The following actions are supported in SharePoint Admin Center: 1. Delete a container 1. Restore a deleted container 1. Permanently deleted a container +2. Sort active containers in the tenant +3. Filter active containers in the tenant +4. Set sensitivity label on active containers +5. Add users to different roles on a container +6. Reassign users from existing roles on a container +7. Remove users from existing roles on a container -**Global admin** will also see "Active Containers" and "Deleted Containers" page along with Site administration pages when they sign in to SharePoint Admin Center.  -**SharePoint Embedded admin** will only see "Active Containers" and "Deleted Containers" page when they sign in to SharePoint Admin Center. +**SharePoint Embedded Administrator** will only see "Active containers" and "Deleted containers" page when they sign in to SharePoint Admin Center.  @@ -32,13 +37,16 @@ The following actions are supported in SharePoint Admin Center: The Active Containers page displays all the active containers within the tenant, providing a comprehensive overview and management capabilities. This page includes the following metadata for each container: -1. **Container name :** Name of the container provided by the container owner -1. **Application name :** Name of the SharePoint Embedded application the container belongs to -1. **Publisher name :** The name of the organization that owns the application -1. **Storage :** The total storage of the files stored in the containers -1. **Owners :** Users assigned the owner role on the container -1. **Sensitivity label :** Name of the label assigned to the container -1. **Created on :** Date and time when the container was created +1. **Container name :** Name of the container provided by the container owner. +1. **Application name :** Name of the SharePoint Embedded application the container belongs to. +1. **Publisher :** The name of the organization that owns the application. For all publishers other than Microsoft, the value is currently stored as "Other" +2. **Ownership type :** Mentions whether the container is tenant-owned, user-owned or group-owned. +3. **Principal owner :** The user whose lifecycle impacts the lifecycle of the container. There is no prinicipal owner for a tenant owned container while it is a user for a user owned container and a group for a group owned containers. +1. **Storage :** The total storage of the files stored in the containers. +1. **Owners :** Users assigned the owner role on the container. +2. **Owner count :** The count of number of owners of the container. +1. **Sensitivity label :** Name of the label assigned to the container. +1. **Created on :** Date and time when the container was created.  @@ -50,21 +58,23 @@ The detailed container view provides a deeper dive into container-specific metad  -1. **Membership:** This panel shows the user permissions for different users associated with the container. +1. **Membership:** This panel shows the user permissions for different users associated with the container. The admin can manage the membership on a container through this panel. > [!IMPORTANT] > The SharePoint Embedded platform supports four distinct [roles](../../app-concepts/sharing-and-perm.md): Owner, Manager, Writer, and Reader. The SharePoint Embedded application on your tenant may not utilize all four roles and might refer to these roles using different names. > - + ## Deleted Containers -The deleted containers page lists all containers in the tenants deleted container collection. It lists the following metadata: +The deleted containers page lists all containers in the tenant's deleted container collection. It lists the following metadata: 1. Container name 1. Application name -1. Publisher name +1. Publisher +2. Ownership type +3. Principal owner 1. Storage 1. Owners 1. Sensitivity label @@ -128,9 +138,51 @@ Upon clicking Delete, the container is permanently deleted and the status of the  -## Coming Soon +## Sorting on Active containers page + +The CTA can perform their compliance and storage management tasks better through the use of sorting capabilities on the Active containers page. Currently, sorting is supported on the following columns: +1. Storage +2. Created on + + + +## Filtering on Active containers page +The CTA can perform their compliance and storage management tasks better through the use of filtering capabilities on the Active containers page. Currently, filtering is supported on the following columns: +1. Application name : The filter provides the list of all Microsoft SharePoint Embedded applications along with all SharePoint Embedded applications published by other publishers that is registered in the tenant. +2. Publisher: +3. Ownership type: The filter provides the options of Tenant, User and Group irrespective of the type of containers present in the tenant. +4. Principal owner: The filtering experience is a people picker experience. +5. Owner count: This filter provides a set of ranges for the administrator to choose from. +6. Created on + +> [!IMPORTANT] +> The behaviour of the filtering experience on Active containers page differs from the experience on Active sites page in SharePoint Admin Center. +> + + + + +## Editing sensitivity label of a container on Active containers page + +The sensitivity label of a container can be set on the Active container page, on the detailed panel of a container. Under the settings panel, the administrator can set the sensitivity label from a list of available sensitivity label. + + + +## Managing user membership of a container + +The administrator can manage the membership of users of a container on the Active container page, on the detailed panel of a container. Under the membership panel, the administrator can view the four roles and the corresponding users in each role. The administrator can: + +**Add a user to a role:** The administrator can navigate to the desired role using the left panel and click on the Add option. This opens up a picker, using which the administrator can select a user from the tenant and assign the role. In case the selected user is already assigned to a different role, the role is displayed when the role is selected and the operation changes from Add to Reassign. + + + + + +**Reassign user to another role:** The administrator can navigate to the desired user under a role using the left panel. On selecting the user, the Reassign option appears. On selecting the option, a drop-dowm menu appears and the administrator can select the role to which the user needs to be reassigned to. + + + +**Remove user from a role:** The administrator can navigate to the desired user under a role using the left panel. On selecting the user, the Remove option appears. On selecting the option, a pop-up screen appears and the administrator can confirm the removal of the user from the role. + + -1. Sort containers by created date and storage -1. Filter containers by created date, application name and publisher name -1. Edit sensitivity label of a container -1. Add and remove users to/from a container diff --git a/docs/embedded/concepts/app-concepts/containertypes.md b/docs/embedded/concepts/app-concepts/containertypes.md index a51fcf678..916c763c4 100644 --- a/docs/embedded/concepts/app-concepts/containertypes.md +++ b/docs/embedded/concepts/app-concepts/containertypes.md @@ -1,7 +1,7 @@ --- title: SharePoint Embedded Container Types description: This article explains how Container Types work. -ms.date: 07/30/2024 +ms.date: 02/17/2025 ms.localizationpriority: high --- @@ -31,10 +31,7 @@ A container type can be created for trial/development purposes and isn't linked - Use SharePoint PowerShell. You must be a SharePoint Embedded Administrator or Global Administrator to run this cmdlet. If you're a SharePoint Administrator, grant yourself the SharePoint Embedded Admin role as well to execute these cmdlets. ```powershell -New-SPOContainerType -[–TrialContainerType] -[ -ContainerTypeName <ContainerTypeName>] -[ -OwningApplicationId <OwningApplicationId>] +New-SPOContainerType [–TrialContainerType] [-ContainerTypeName] <String> [-OwningApplicationId] <String> [-ApplicationRedirectUrl] <String> [<CommonParameters>] ``` The following restrictions are applied to container type in the trial status: @@ -46,25 +43,33 @@ The following restrictions are applied to container type in the trial status: - The container type is restricted to work in the developer tenant. It can't be deployed in other consuming tenants. ## Standard/Non-trial use +A standard container type, by definition, has a billing profile associated with it and can be either regular billed or direct to consumer billed. A standard container type is created using the [New-SPOContainerType](/powershell/module/sharepoint-online/new-spocontainertype) cmdlet . In case of regular billing, the next step after creation is the addition of a billing profile using the [Add-SPOContainerTypeBilling](/powershell/module/sharepoint-online/add-spocontainertypebilling) cmdlet. With the use of `-IsPassThroughBilling`, you can create a direct to customer billed container type. There is no need to attach a billing profile in case this case. You need the following to create a container type in the standard status: -Container type can also be created with an Azure billing profile, which includes an Azure Subscription ID and a Region Group. This container type is in the standard status and is billable. You need the following to create a container type in the standard status: - -- An Azure subscription and Resource Group must be present in the Azure portal +- An Azure subscription and Resource Group must be present in the Azure portal, in case of regular billed. - An App registration must be created in Microsoft Entra ID -- Each developer tenant can create up to five container types in the standard status. To create one, use the following PowerShell cmdlet: +- Each developer tenant can create up to five container types in the standard status. + +To create a regular billed, standard container type, use the following cmdlets: + +```powershell +New-SPOContainerType [-ContainerTypeName] <String> [-OwningApplicationId] <String> [-ApplicationRedirectUrl] <String> [<CommonParameters>] +``` ```powershell -New-SPOContainerType -[–ContainerTypeName <ContainerTypeName>] -[-OwningApplicationId <OwningApplicationId>] -[-AzureSubscriptionId <AzureSubscriptionId>] -[-ResourceGroup <ResourceGroup>] -[-Region <Region>] +Add-SPOContainerTypeBilling –ContainerTypeId <ContainerTypeId> -AzureSubscriptionId <AzureSubscriptionId> -ResourceGroup <ResourceGroup> -Region <Region> ``` > [!NOTE] > The user or admin who will set up a billing relationship for SharePoint Embedded will need to have owner or contributor permissions on the Azure subscription. + +To create a direct to customer billed, standard container type, use the following cmdlet: + +```powershell +New-SPOContainerType [-ContainerTypeName] <String> [-OwningApplicationId] <String> [-ApplicationRedirectUrl] <String> [-IsPassThroughBilling] [<CommonParameters>] +``` + + ## Configuring Container Types Developer Admin can set selected settings on the SharePoint Embedded container types created by using this PowerShell cmdlet. @@ -80,7 +85,7 @@ Set-SPOContainerTypeConfiguration -ContainerTypeId 4f0af585-8dcc-0000-223d-661eb Developer Admin can view all the SharePoint Embedded container types created by them on their tenant using this PowerShell cmdlet. This cmdlet retrieves and returns the list of container types created for a SharePoint Embedded Application in the tenant. ```powershell -Get-SPOContainerType +Get-SPOContainerType [<CommonParameters>] ``` Example output of the `Get-SPOContainerType` cmdlet @@ -101,7 +106,7 @@ To create and interact with containers, you must [register](../app-concepts/regi ## Deleting Container Types -Developer Admins can only delete container types in trial status. To delete a container type in trial status, you must remove all containers of the container type first, including from the deleted container collection. To remove containers, refer to [Consuming Tenant Admin](../admin-exp/consuming-tenant-admin/cta.md). Once all the containers are deleted, Developer Admins can delete the container types using the below PowerShell cmdlet. +Developer admins can delete container types of both trial and standard status. To delete a container type, you must remove all containers of the container type first, including from the deleted container collection. To remove containers, refer to [Consuming Tenant Admin](../admin-exp/consuming-tenant-admin/cta.md). Once all the containers are deleted, Developer admins can delete the container type using the below PowerShell cmdlet. ```powershell Remove-SPOContainerType diff --git a/docs/embedded/images/Filter.png b/docs/embedded/images/Filter.png new file mode 100644 index 000000000..6f1eacbeb Binary files /dev/null and b/docs/embedded/images/Filter.png differ diff --git a/docs/embedded/images/Reassignuser.png b/docs/embedded/images/Reassignuser.png new file mode 100644 index 000000000..5ae1447ed Binary files /dev/null and b/docs/embedded/images/Reassignuser.png differ diff --git a/docs/embedded/images/Removeuser.png b/docs/embedded/images/Removeuser.png new file mode 100644 index 000000000..ffa8d357a Binary files /dev/null and b/docs/embedded/images/Removeuser.png differ diff --git a/docs/embedded/images/Sensitivitylabel.png b/docs/embedded/images/Sensitivitylabel.png new file mode 100644 index 000000000..5180a30a0 Binary files /dev/null and b/docs/embedded/images/Sensitivitylabel.png differ diff --git a/docs/embedded/images/Sorting.png b/docs/embedded/images/Sorting.png new file mode 100644 index 000000000..3f495f85c Binary files /dev/null and b/docs/embedded/images/Sorting.png differ diff --git a/docs/embedded/images/addowners-1.png b/docs/embedded/images/addowners-1.png new file mode 100644 index 000000000..bba134252 Binary files /dev/null and b/docs/embedded/images/addowners-1.png differ diff --git a/docs/embedded/images/addowners-2.png b/docs/embedded/images/addowners-2.png new file mode 100644 index 000000000..fe7af04ed Binary files /dev/null and b/docs/embedded/images/addowners-2.png differ