THIS REPO HAS BEEN ARCHIVED. IT HAS BEEN REPLACED BY THIS PRIVATE/INTERNAL FORK.
- Introduction
- Intended Use
- Installation
- Commercial Marketplace Documentation
- Monitoring
- Terminology
- SaaS Accelerator Overview
- Projects
- Production Environment Reference Architecture
- Technology and Versions
- Security
- Prerequisites
- Releases
- Contributing
- Developers
- License
This project is a community-supported reference implementation for integrating Software-as-a-Service (SaaS) solutions with Microsoft commercial marketplace SaaS offers. The SaaS Accelerator may be installed as-is or may be customized to support your requirements. The project provides the following capabilities.
- A configurable landing page for SaaS customers
- A webhook that listens for subscription changes
- A private portal for the publisher to monitor customer subscriptions
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.
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.
Video instructions: Additionally, there is a quick video on how to install the SaaS Accelerator with the installer script available through Mastering the Marketplace .
- Advanced installation - This document details more manual installation instructions and how to set up a local development environment.
- Enterprise reference architectures
- Single region architectures
- Multi-region architectures
- Advanced installation checklist
The following documents provide HOW-TOs setup 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 SaaS application business policies, plus step-by step offer creation and configuration requirements.
- SaaS fulfillment API (v2). API details for SaaS 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 the marketplace subscription. Implemented using ASP.Net Core 6.0, the sample web application uses the Services client library and data access library to invoke and persist API interactions and provides an example user interface to demonstrate how a customer would manage their subscriptions and plans. | SaaS.SDK.CustomerProvisioning |
| Publisher portal - Sample web application | Demonstrates how to generate usage events used in metered billing transactions, and how to emit these events to the Marketplace Metering Service API. | SaaS.SDK.PublisherSolution |
| 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. | SaaS.SDK.Client.DataAccess |
| Services client library | Contains the services used by the Customer and Publisher portals, including the POCO classes to orchestrate calls to the marketplace APIs on client library / database. | SaaS.SDK.Services |
| Unit tests project | Helps validate and test the SDKs codebase. | SaaS.SDK.UnitTest |
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:
The sample code and SDK have been scanned for vulnerabilities and use secure configurations. Versions have been reviewed to ensure compatibility with the latest security guidelines.
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.
- We recommend using an Integrated Development Environment (IDE): Visual Studio Code, Visual Studio 2019 / 2022, etc...
- The SDK has been implemented using .NET 6
- 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.
This project is released under the MIT License.