-
Notifications
You must be signed in to change notification settings - Fork 1k
Update SPE docs to incorporate new Container Type Management APIs #10336
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
ed821f5
be302b7
5647201
7b01459
5953f03
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,124 +1,42 @@ | ||
--- | ||
title: PAYG billing for SharePoint Embedded | ||
description: This article explains the billing models and how to set up PAYG billing. | ||
ms.date: 03/03/2025 | ||
title: Pay-as-you-go billing for SharePoint Embedded | ||
description: This article explains the billing models and how to set up pay-as-you-go billing. | ||
ms.date: 08/13/2025 | ||
ms.localizationpriority: high | ||
--- | ||
|
||
# SharePoint Embedded billing | ||
|
||
SharePoint Embedded is a consumption-based Pay-as-you-go (PAYG) offering meaning you pay only for what you use. SharePoint Embedded provides two billing models that the tenant developing the SharePoint Embedded application can select for respective container types, tailoring it to their unique business requirements. The two billing models are Standard and Pass-through billing. | ||
SharePoint Embedded is a consumption-based pay-as-you-go offering meaning you pay only for what you use. SharePoint Embedded provides two billing models that the tenant developing the SharePoint Embedded application can select for respective container types, tailoring it to their unique business requirements. The two billing models are Standard and Passthrough billing. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. "when defining their container type" I think we need to make it clear that once the CT is created the billing model can not be changed |
||
|
||
### Standard | ||
## Standard billing | ||
|
||
With the standard billing model, all consumption-based charges are directly billed to the tenant who owns or develops the application. The admin in the developer tenant must establish a valid billing profile when creating a standard container type. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think we should make a comment that setting up the billing profile is a step to be taken after the CT is created. |
||
|
||
 | ||
 | ||
|
||
### Pass-through | ||
## Passthrough billing | ||
|
||
With pass-through billing, consumption-based charges are billed directly to the tenant registered to use the SharePoint Embedded application. Admins in the developer tenant don't need to set up a billing profile when creating a pass-through SharePoint Embedded container type. Once the container type is registered in the consuming tenant, the consuming tenant admin (SharePoint Admin or Global Admin) needs to set up the billing profile in the consuming tenant to use the SharePoint Embedded application. | ||
With passthrough billing, consumption-based charges are billed directly to the tenant registered to use the SharePoint Embedded application. Admins in the developer tenant don't need to set up a billing profile when creating a passthrough SharePoint Embedded container type. Once the container type is registered in the consuming tenant, the consuming tenant admin (SharePoint Admin or Global Admin) needs to set up the billing profile in the consuming tenant to use the SharePoint Embedded application. | ||
|
||
 | ||
 | ||
|
||
## Prerequisites to create SharePoint Embedded container type | ||
## Create a SharePoint Embedded container type | ||
|
||
A new container type will be created using **SharePoint Online Management Shell**: | ||
For information on how to create a container type with billing enabled, see [creating a container type](../../getting-started/containertypes.md#creating-container-types). | ||
|
||
1. Download and install the [latest version of SharePoint Online Management Shell](https://www.microsoft.com/download/details.aspx?id=35588) | ||
1. Open SharePoint Online Management Shell from **Start** screen, type **sharepoint**, and then select **SharePoint Online Management Shell**. | ||
1. Connect to SPO service using `Connect-SPOService` cmdlet by providing admin credentials associated with tenancy. For information on [how to use Connect-SPOService](/powershell/module/sharepoint-online/connect-sposervice), refer the linked documentation. | ||
## View & edit billing properties of standard container type | ||
|
||
### Tenant requirements | ||
You can view the properties of a container type and associated billing properties by using the Container Type APIs: | ||
|
||
- An active instance of SharePoint is required in your Microsoft 365 tenant. | ||
- Users who will be authenticating into SharePoint Embedded Container Types and Containers must be in Entra ID (Members and Guests) | ||
- [List container types](/graph/api/filestorage-list-containertypes) | ||
- [Get container type](/graph/api/filestoragecontainertype-get) | ||
|
||
> [!NOTE] | ||
> An Office license is not required to collaborate on Microsoft Office documents stored in a container. | ||
To update the billing properties on a container type with standard billing, see [set the billing profile](../../getting-started/containertypes.md#set-the-billing-profile). | ||
|
||
### Roles and Permissions | ||
## Set up billing for passthrough container types in consuming tenant | ||
|
||
- The admin who sets up the billing relationship for SharePoint Embedded needs to have owner or contributor permissions on the Azure subscription. | ||
- Admin needs to have a SharePoint Embedded Administrator or Global Admin role to operate billing cmdlets. | ||
|
||
### Azure Subscription | ||
|
||
For the Standard Billing container type, the developer admin needs to set up: | ||
|
||
- An existing SharePoint tenancy | ||
- An Azure subscription in the tenancy | ||
- A resource group attached to the Azure subscription | ||
|
||
## Set up a Standard Billing container type | ||
|
||
For standard billed container types, developer admins should set up billing in their tenant. The Microsoft 365 SharePoint Embedded Administrator serves as the developer admin. Global Administrators in Microsoft 365 can assign users the SharePoint Embedded Administrator role, which already has all the permissions of the SharePoint Embedded Administrator role. The SharePoint Embedded Admin role is available in Microsoft Entra and Microsoft 365 Admin Center. | ||
|
||
SharePoint Embedded Admin can create a container type using the `New-SPOContainerType` cmdlet by providing an Azure subscription, the resource group associated with the subscription, and a region. | ||
|
||
- If you don't have an Azure subscription, you can create one by following the steps here to [create an Azure subscription in your tenancy](/azure/cloud-adoption-framework/ready/azure-best-practices/initial-subscriptions), | ||
- If you don't have a resource group, you can create one by following the steps here to [create a resource group](/azure/azure-resource-manager/management/manage-resource-groups-portal) | ||
|
||
```powershell | ||
New-SPOContainerType -ContainerTypeName <ContainerTypeName> | ||
-OwningApplicationId <OwningApplicationId> | ||
-AzureSubscriptionId <AzureSubscriptionId> | ||
-ResourceGroup <ResourceGroup> | ||
-Region <Region> | ||
``` | ||
|
||
> [!IMPORTANT] | ||
> Every container type must have an owning application. | ||
> | ||
> A single-owning app can only own one container type at a time. | ||
> | ||
> An Azure subscription can be attached to any number of container types. | ||
|
||
### View & Edit billing properties of Standard container type | ||
|
||
You can view the properties of a container type and associated billing properties by using one of the two PowerShell cmdlets: | ||
|
||
1. See all container types and billing properties except associated region: | ||
|
||
```powershell | ||
Get-SPOContainerType | ||
``` | ||
|
||
1. See billing properties associated with a container type including region: | ||
|
||
```powershell | ||
Get-SPOContainerType -ContainerTypeId <ContainerTypeId> | ||
``` | ||
|
||
1. Update Azure subscription or resource group associated with a container type: | ||
|
||
```powershell | ||
Set-SPOContainerType -ContainerTypeId <ContainerTypeId> [-AzureSubscriptionId <AzureSubscriptionId>] [-ResourceGroup <ResourceGroup>] | ||
``` | ||
|
||
|
||
## Set up a Pass-through Billing container type | ||
|
||
For Pass-through Billing container types, the developer admin doesn't have to set up billing in the developer tenant. SharePoint Embedded Admin can create container type using `New-SPOContainerType` cmdlet with `isPassThroughBilling` specified. | ||
|
||
```powershell | ||
New-SPOContainerType -ContainerTypeName <ContainerTypeName> | ||
-OwningApplicationId <OwningApplicationId> | ||
-isPassThroughBilling | ||
``` | ||
|
||
### [Set Up Guide in Consuming Tenant Admin Center](../consuming-tenant-admin/cta.md#set-up-billing-for-pass-through-app) | ||
|
||
1. In [Microsoft 365 admin center](https://admin.microsoft.com/), select **Setup**, and the view the **Files and Content** section. Select **Automate Content with Microsoft Syntex.** | ||
|
||
 | ||
|
||
1. Select **Go to Syntex settings**. | ||
1. Select **Apps** under **Syntex services for**, select **SharePoint Embedded** | ||
|
||
 | ||
|
||
1. Follow the instructions on the **SharePoint Embedded** flyer to turn on SharePoint Embedded apps. | ||
To set up billing for a passthrough container type in the consuming tenant, see the [setup guide in the consuming tenant Admin Center](../consuming-tenant-admin/cta.md#set-up-billing-for-passthrough-app). | ||
|
||
## SharePoint Embedded meters | ||
|
||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The title for the "Pay as you go message" doesn't seem related to the description, at least to me. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. In the Egress section, it says that "to the data downloaded from the SharePoint Embedded platform to the customer's client device such as a desktop or mobile device.". We have to be a bit more careful with this, to also include the case where an SPE service application makes calls that translate into Egress, but doesn't necessarily downloads that data to any end user device. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd update this title to
"SharePoint Embedded billing models"