- Introduction
- Stay current with the latest updates!
- Intended Use
- Installation
- Monitoring
- Commercial Marketplace Documentation
- AMA Meter Scheduler Overview
- Projects
- Technology and Versions
- Security
- Prerequisites
- Contributing
The Azure Managed Application (AMA) Custom Meters Scheduler is an opensource production-ready solution that enables partners to implement and manage advanced Meter models for Azure Marketplace AMA offers.
🚀 Quick & easy deployment: Go live in under 15 minutes.
💲 Flexible Meter: Surpass the constraints of current Meter features. Enable yearly Meter, milestone payments, and handling complex pricing models.
🛠️ Design in advance: Allow partners to design and create price models per plan prior having an active subscription.
💼 Subscription Management : Partner will manage and track subscriptions status.
⭐ No more exception requests: Eliminate the need for requesting an exception for partners to support price model needs.
The AMA Meter Scheduler may be installed as-is or may be customized to support your requirements. The project provides the following capabilities.
- A webhook that listens for subscription notification events
- A private portal for the publisher to monitor customer subscriptions and scheduler payment
- A Meter engine to execute the scheduler payments
The accelerator is implemented in .NET and uses the commercial marketplace Meter system, including the Partner Center Ingestion API and Marketplace Metering Service API. The AMA Meter Scheduler 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 optional components of a commercial marketplace AMA offer and complements the existing commercial marketplace documentation.
The AMA Meter Scheduler 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.
This project speed the AMA offer onboarding experience for those building using meters to submit custom price model. Whether installed and used as-is or customized for your particular requirements, this reference implementation provides all main components required by a commercial marketplace AMA offer.
Installation instructions are here, as well as documents detailing architecture and scaled installation considerations are also available. Following these instructions will typically have the AMA Meter Scheduler installed in 20 minutes or less.
The following documents provide how-tos for setting up Azure Monitoring and Alerting for the resources deployed by the accelerator.
- Web App 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 AMA offers.
- Mastering Managed Application offers. Zero-to-Hero Training on Azure Marketplace AMA offers.
- Commercial marketplace documentation. Getting started and top articles
- Azure applications in the commercial marketplace. Overview of the Azure application business policies, plus step-by step offer creation and configuration requirements.
- Product Ingestion API for the commercial marketplace. API details for Partner Center.
- Marketplace metering service API. API details for the Marketplace Metering Service that enables event-based Meter.
The source /src directory contains the following Visual Studio projects.
| Project | Description | Directory Name |
|---|---|---|
| Publisher portal - Sample web application | Demonstrates how to schedule usage events used in metered transactions, and how to emit these events to the Marketplace Metering Service API. | AdminSite |
| Client data access library | Demonstrates how to persiste subscriptions and schedule task, and historical logging for metered usaged submissions. | 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. | Services |
| Meter Engine project | WebJob Meter engine to submit metered usage. | Meter Engine |
This project has been developed using the following technologies and versions.
The accelerator code has 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 AMA Meter Scheduler has been implemented using .NET 6
- For data persistence we are using Azure Cosmos Database and Entity Framework. However, feel free to use any data repository you are comfortable with.
Support for this project is community-based and contributions are welcome. This is not an officially supported Microsoft product.
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.