This document covers the API contract that must be implemented by each Azure Resource Provider in order to onboard to the Azure management API surface (as well as RBAC, tags, and templates).
The document is divided into seven major sections. The first section covers the request and response details common to all APIs. It includes information around the headers, client timeout, throttling, response size limitations etc. The second section covers the details of APIs around subscription lifecycle management for a particular resource provider. The third section covers the create, update, delete and read APIs that needs to be implemented for the resources exposed by the provider. The fourth section covers APIs or resources which will not be managed by Azure Resource Manager (ARM) but will be proxied directly to the resource provider. The fifth section covers asynchronous APIs design and best practices. The sixth section covers details on various things like tracing requests, guidance on designing resources and so on. The last section covers schemas for resource APIs that are to remain consistent between resource types.
The intended audience of this document is any service who wants to onboard to Azure as a resource provider.
- Common API Details
- Subscription Lifecycle API Reference
- Resource API Reference
- Proxy API Reference
- Asynchronous API Reference
- Addendum
- Common API Contracts
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.
This repository contains a collection of documents and related materials supporting the overall Microsoft REST API Guidelines initiative. To contribute to this repository, please open issues or send a pull request.