Skip to content

Commit 5454d6a

Browse files
Merge pull request SharePoint#10117 from ShreyasSar26/patch-3
Updates to container type concept information
2 parents 2a131ad + a0351ca commit 5454d6a

File tree

1 file changed

+38
-27
lines changed

1 file changed

+38
-27
lines changed
Lines changed: 38 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,17 @@
11
---
22
title: SharePoint Embedded Container Types
33
description: This article explains how Container Types work.
4-
ms.date: 07/30/2024
4+
ms.date: 02/17/2025
55
ms.localizationpriority: high
66
---
77

88
# SharePoint Embedded Container Types
99

1010
A container type is a SharePoint Embedded resource that defines the relationship, access privileges, and billing accountability between a SharePoint Embedded application and a set of containers. Also, the container type defines behaviors on the set of containers.
1111

12-
Each container type is strongly coupled with one SharePoint Embedded application, which is referred to as the owning application. The owning application developer is responsible for creating and managing their container types. SharePoint Embedded mandates a 1:1 relationship between owning application and container type.
12+
Each container type is strongly coupled with one SharePoint Embedded application, which is referred to as the owning application. The owning application developer is responsible for creating and managing their container types.
13+
14+
SharePoint Embedded mandates a 1:1 relationship between owning application and a container type.
1315

1416
Container type is represented on each container instance as an immutable property (ContainerTypeID) and is used across the entire SharePoint Embedded ecosystem, including:
1517

@@ -20,24 +22,24 @@ Container type is represented on each container instance as an immutable propert
2022

2123
> [!NOTE]
2224
>
23-
> 1. You must specify the purpose of the container type you are creating at creation time. Depending on the purpose, you may or may not need to provide your Azure Subscription ID. A container type set for trial purpose cannot be converted for production; or vice versa.
24-
> 1. You must use the latest version of SharePoint Powershell for container type configurations.
25+
> 1. You must specify the purpose of the container type you're creating at creation time. Depending on the purpose, you may or may not need to provide your Azure Subscription ID. A container type set for trial purposes can't be converted for production; or vice versa.
26+
> 1. You must use the latest version of SharePoint PowerShell to configure a container type. For permissions and the most current information about Windows PowerShell for SharePoint Embedded, see the documentation at [Intro to SharePoint Embedded Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell).
2527
2628
## Trial use
2729

28-
A container type can be created for trial/development purposes and isn't linked to any Azure billing profile. This enables developers to explore SharePoint Embedded application development and assess its features for free. In this scenario, the developer tenant is the same as the consuming tenant. Each developer can have only one container type in the trial status in their tenant at a time. The container type is valid for up to 30 days but can be removed at any time within this period. To create a container type for trial purposes, you can:
30+
A container type can be created for trial/development purposes and isn't linked to any Azure billing profile. This enables developers to explore SharePoint Embedded application development and assess its features for free. For trial container types, the developer tenant is the same as the consuming tenant.
31+
Each developer can have only one container type in the trial status in their tenant at a time. The trial container type is valid for up to 30 days but can be removed at any time within this period.
32+
33+
To create a container type for trial purposes, you can:
2934

30-
- Use SharePoint Embedded Visual Studio Code Extension to create the container type in just a few steps. The Visual Studio Code extension also registers your container type and creates containers for you.
35+
- Use SharePoint Embedded Visual Studio Code Extension to create the container type in just a few steps. The Visual Studio Code extension registers your container type and creates containers for you.
3136
- 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.
3237

3338
```powershell
34-
New-SPOContainerType
35-
[–TrialContainerType]
36-
[ -ContainerTypeName <ContainerTypeName>]
37-
[ -OwningApplicationId <OwningApplicationId>]
39+
New-SPOContainerType [–TrialContainerType] [-ContainerTypeName] <String> [-OwningApplicationId] <String> [-ApplicationRedirectUrl] <String> [<CommonParameters>]
3840
```
3941

40-
The following restrictions are applied to container type in the trial status:
42+
The following restrictions are applied to trial container types:
4143

4244
- Up to five active containers of the container type can be created.
4345
- Each container has up to 1 GB of storage space.
@@ -47,27 +49,36 @@ The following restrictions are applied to container type in the trial status:
4749

4850
## Standard/Non-trial use
4951

50-
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:
52+
A standard container type is linked to a billing profile, which can be regular or direct-to-consumer billing. Each developer tenant can create up to five standard container types.
53+
Standard container types are created using the [New-SPOContainerType](/powershell/module/sharepoint-online/new-spocontainertype) cmdlet. For container types with regular billing, create a billing profile using the [Add-SPOContainerTypeBilling](/powershell/module/sharepoint-online/add-spocontainertypebilling) cmdlet. For container types with direct to customer billing, use the flag `-IsPassThroughBilling`. For the direct to customer billed container type, there's no need to attach a billing profile.
54+
55+
You need the following to create a standard container type:
5156

52-
- An Azure subscription and Resource Group must be present in the Azure portal
57+
- An Azure subscription and a resource group must be present in the Azure portal for regular billing.
5358
- An App registration must be created in Microsoft Entra ID
54-
- Each developer tenant can create up to five container types in the standard status. To create one, use the following PowerShell cmdlet:
59+
60+
To create a standard container type with a regular billing profile, use the following cmdlets:
5561

5662
```powershell
57-
New-SPOContainerType
58-
[–ContainerTypeName <ContainerTypeName>]
59-
[-OwningApplicationId <OwningApplicationId>]
60-
[-AzureSubscriptionId <AzureSubscriptionId>]
61-
[-ResourceGroup <ResourceGroup>]
62-
[-Region <Region>]
63+
New-SPOContainerType [-ContainerTypeName] <String> [-OwningApplicationId] <String> [-ApplicationRedirectUrl] <String> [<CommonParameters>]
64+
```
65+
66+
```powershell
67+
Add-SPOContainerTypeBilling –ContainerTypeId <ContainerTypeId> -AzureSubscriptionId <AzureSubscriptionId> -ResourceGroup <ResourceGroup> -Region <Region>
6368
```
6469

6570
> [!NOTE]
66-
> 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.
71+
> The user or admin who sets up a billing relationship for SharePoint Embedded must have owner or contributor permissions on the Azure subscription.
72+
73+
To create a direct to customer billed, standard container type, use the following cmdlet:
74+
75+
```powershell
76+
New-SPOContainerType [-ContainerTypeName] <String> [-OwningApplicationId] <String> [-ApplicationRedirectUrl] <String> [-IsPassThroughBilling] [<CommonParameters>]
77+
```
6778

6879
## Configuring Container Types
6980

70-
Developer Admin can set selected settings on the SharePoint Embedded container types created by using this PowerShell cmdlet.
81+
The Developer Admin can set selected settings on the SharePoint Embedded container types created by using this PowerShell cmdlet.
7182

7283
This cmdlet allows admins to set [Microsoft 365 content discoverability](../content-experiences/user-experiences-overview.md) and [sharing](../app-concepts/sharing-and-perm.md) settings on container types. The setting applies to all container instances of the container type
7384

@@ -77,10 +88,10 @@ Set-SPOContainerTypeConfiguration -ContainerTypeId 4f0af585-8dcc-0000-223d-661eb
7788

7889
## Viewing Container Types
7990

80-
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.
91+
The Developer Admin can view all the SharePoint Embedded container types they created on their tenant using `Get-SPOContainerType`. This cmdlet retrieves and returns the list of container types created for a SharePoint Embedded Application in the tenant.
8192

8293
```powershell
83-
Get-SPOContainerType
94+
Get-SPOContainerType [<CommonParameters>]
8495
```
8596

8697
Example output of the `Get-SPOContainerType` cmdlet
@@ -101,9 +112,9 @@ To create and interact with containers, you must [register](../app-concepts/regi
101112

102113
## Deleting Container Types
103114

104-
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.
115+
Developer admins can delete both trial and standard container types. To delete a container type, you must first remove all containers of that container type, including from the deleted container collection. To remove containers, refer to [Consuming Tenant Admin](../admin-exp/consuming-tenant-admin/cta.md).
116+
Once all the containers are deleted, Developer admins can delete the container type using `Remove-SPOContainerType`.
105117

106118
```powershell
107-
Remove-SPOContainerType
108-
[-ContainerTypeId <ContainerTypeId>]
119+
Remove-SPOContainerType [-ContainerTypeId <ContainerTypeId>]
109120
```

0 commit comments

Comments
 (0)