Azure REST API Specifications

Description

This repository is the canonical source for REST API specifications for Microsoft Azure. You can learn more about it here.

Getting started

If you're a Microsoft employee looking for information about all of the repositories and steps for Azure SDK Libraries Releases, go to the aka.ms/azsdk/join.

External Contributors can read Getting Started with OpenAPI Specifications and Getting Started with TypeSpec Specifications.

See the documentation index for contributor workflows, specification structure, and pull request check references.

Directory Structure

See the specification folder structure guide (also available at aka.ms/azsdk/spec-dirs).

Examples

These examples provide a starting point for how a library should be structured, as well as the expected options that libraries should use:

• Data plane: https://aka.ms/azsdk/tspconfig-sample-dpg
• Management plane (ARM): https://aka.ms/azsdk/tspconfig-sample-mpg

Next steps

The next step in the process after a spec is completed is to generate SDKs and API reference documentation. If you're a Microsoft employee, go to the Azure SDK - Internal Wiki for more information.

External Contributors can read Getting Started with OpenAPI Specifications and Getting Started with TypeSpec Specifications.

---

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.