The SaaS Accelerator is offered under the MIT License as open source software and is by Microsoft. If you need help with the accelerator or would like to report defects or feature requests, use the Issues feature on this GitHub repository.
Note: This branch targets .NET 10 and uses
Marketplace.SaaS.Client3.0.0. The client supports extensible billing term units, including custom ISO 8601 durations in addition to the previously supported monthly and yearly terms.
- Introduction
- Recent Updates
- Intended Use
- Installation
- Commercial Marketplace Documentation
- SaaS Accelerator Overview
- Projects
- Technology and Versions
- Security
- Prerequisites
- Contributing
- Developers
- FAQs
- License
📝 Please leave us your ideas and feedback on the SaaS Accelerator in this brief, anonymous survey.
The SaaS Accelerator is a production-ready solution designed to make it easier for Microsoft partners to sell their SaaS solutions via Microsoft Commercial Marketplace. Microsoft partners can use SaaS Accelerator to simplify the process of bringing their SaaS solutions to the Marketplace. It is a ready-to-use, community-supported solution providing the following capabilities:
🚀 Quick & Easy Deployment: Go live in under 15 minutes with our low-code, production-ready solution.
🔧 Turnkey Solution: Meets all technical prerequisites for your SaaS offers.
💼 Subscriptions Simplified: A streamlined interface to optimize your subscription workflow.
💲 Flexible Billing: Advanced capabilities for custom billing and pricing models.
🛠️ Stay in Control: A dedicated adminstrative portal for managing all your customer subscriptions.
Transform your SaaS game. Leverage SaaS Accelerator now!
The project is implemented in .NET and uses the commercial marketplace billing system, including the SaaS Fulfillment API (v2) and Marketplace Metering Service API. The SaaS Accelerator models how a typical SaaS platform interacts with the marketplace APIs to provision subscriptions for customers, enable logging, and manage commercial marketplace subscriptions. The SaaS Accelerator may be installed as-is or may be customized to support your requirements.
The SaaS Accelerator project team releases regularly releases new versions. Please see the release notes page for updates. We recommend keeping up to date with latest releases to stay current on security patches, bug fixes, and new features.
To update your SaaS Accelerator installation, use the Update script documented here.
This branch includes the following platform and Marketplace integration updates:
- All solution projects now target .NET 10. The repository pins the .NET SDK to
10.0.400inglobal.jsonand allows roll-forward to a later compatible feature band. - The Services project uses the public
Marketplace.SaaS.Client3.0.0 package for Marketplace SaaS Fulfillment and Metering API operations. - Billing term handling now uses the extensible
TermUnittype supplied by the client package. Standard and custom ISO 8601 durations can be deserialized, stored, serialized, and displayed without requiring a fixed local enum value.
This code is a reference implementation of required components of a commercial marketplace SaaS offer and complements the existing commercial marketplace documentation.
This project accelerates the SaaS offer onboarding experience for those building SaaS solutions for the Microsoft commercial marketplace. Whether installed and used as-is or customized for your particular requirements, this reference implementation provides all main components required by a commercial marketplace SaaS offer.
NOTE: Support for this project is community-based and contributions are welcome. Details on contributing can be found below.. This is not an officially supported Microsoft product.
Installation instructions are here, as well as documents detailing architecture and scaled installation considerations are also available. Following these instructions will typically have the SaaS Accelerator installed in 20 minutes or less.
Advanced Installation instructions are here. These are detailed instructions to address different deployment scenarios such as how-to run it locally or deploy it from Visual Studio.
Video instructions Additionally, there is a quick video on the installation process. Installing the SaaS Accelerator with the Azure portal cloud shell available through Mastering the Marketplace.
Upgrade to newer version Follow these instructions to move your release to the current version.
- Enterprise reference architectures
- Single region architectures
- Multi-region architectures
- Advanced installation checklist
The following documents provide how-tos for setting up Azure Monitoring and Alerting for the resources deployed by the SaaS Accelerator:
- Web App Monitoring and Alerting instructions
- SQL Server Monitoring and Alerting instructions
- App Registration Credentials Monitoring and Alerting instructions
Before using this project, please review the commercial marketplace documentation resources below to understand the important concepts, account setup, and offer configuration requirements for publishing SaaS SaaS application offers.
- Mastering the Marketplace - SaaS Offers. Zero-to-Hero Training on Azure Marketplace SaaS offers using the Accelerator.
- Commercial marketplace documentation. Getting started and top articles
- SaaS applications in the commercial marketplace. Overview of the SaaS application business policies, plus step-by step offer creation and configuration requirements.
- SaaS fulfillment API (v2). API details for SaaS application subscription creation and management.
- Marketplace metering service API. API details for the Marketplace Metering Service which, when used in conjunction with the SaaS Fulfillment API, enables event-based billing.
- SaaS fulfillment API FAQ. Frequently asked questions about the SaaS Fulfillment APIs.
The source /src directory contains the following Visual Studio projects.
| Project | Description | Directory Name |
|---|---|---|
| Customer portal - Sample web application | Demonstrates how to register, provision, and activate Marketplace subscriptions. Implemented using ASP.NET Core 10.0, the sample web application uses the Services and data access libraries to invoke and persist API interactions, process subscription lifecycle webhooks, and provide an example interface for customers to manage subscriptions and plans. | CustomerSite |
| Publisher portal - Sample web application | Demonstrates how to manage Marketplace subscriptions, generate metered billing usage events, and submit those events to the Marketplace Metering Service API. Implemented using ASP.NET Core 10.0. | AdminSite |
| Client data access library | Demonstrates how to persist plans, marketplace subscriptions, and related transaction attributes when using the SaaS Fulfillment API (v2) and Marketplace Metering Service API. | DataAccess |
| Services client library | Contains the services and models used by the Customer and Publisher portals. It uses Marketplace.SaaS.Client to call the Marketplace APIs and coordinates persistence through the data access library. |
Services |
| Metered billing trigger job | A .NET 10 background job that submits scheduled usage events to the Marketplace Metering Service API. | MeteredTriggerJob |
| Unit tests project | Validates service behavior, package integration, and custom billing term serialization. | Services.Test |
| UI tests project | Contains Selenium-based Customer and Publisher portal UI tests. A compatible browser and WebDriver are required to run them. | UI.Test |
The sample code in this repository runs in the publisher's environment as illustrated below. The metering SDK (.NET class library) and a sample web application to report usage events for subscriptions against those plans that support metering (have the dimensions defined and enabled) and correlate to SaaS Metering and SaaS Service blocks in the below image, respectively.
This project has been developed using the following technologies and versions:
- .NET SDK 10.0.400, configured in
global.json - ASP.NET Core Runtime 10
- Entity Framework Core 10
Marketplace.SaaS.Client3.0.0
The accelerator code has been scanned for vulnerabilities and use secure configurations. Versions have been reviewed to ensure compatibility with the latest security guidelines. To enhance the best practices please see Security best practices.
Ensure the following prerequisites are met before getting started:
- You must have an active Azure subscription for development and testing purposes. Create an Azure subscription here.
- You must have a Partner Center account enabled for use with the commercial marketplace. Create an account here.
- Install the .NET 10 SDK. The repository
requests SDK
10.0.400and permits roll-forward to a later compatible feature band. - We recommend using an IDE with .NET 10 support, such as Visual Studio Code or Visual Studio.
- For data persistence we are using Azure SQL Database and Entity Framework. However, feel free to use any data repository you are comfortable with.
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.
Code contributed should follow the C# specifications and best practices as documented here.
There is a list of the Frequent Asked Questions here.
This project is released under the MIT License.