This is the repo for template deployment schemas hosted under https://schema.management.azure.com/schemas. Please see below for information on contributing and publishing updated schemas.
- Ensure that any new resource types that you are adding have been added to the following top-level template schemas:
- If your schema has been manually generated, please ensure you include appropriate tests in tests
- If adding a new resource type, please add examples to the templates in tools/templateTests
- Ensure that the test suite passes (see Tests)
Use the following commands to execute the test suite locally:
cd toolsnpm installnpm test
You can use the generator in this repo to automatically generate a schema from a swagger spec checked into the azure-rest-api-specs repo. We are working on fully automating this process, but please note that until then, it is your responsibility to ensure that the auto-generated schema has been correctly formatted before submitting a pull request.
See Generator README for more information.
- Fork this repo, and clone it locally.
- Run the following commands (replace the base path accordingly - valid paths can be disovered with
npm run list-basepaths):cd generatornpm installnpm run generate-single myprovider/resource-manager
- Review the generator logs to ensure no errors, and review the changes generated.
- Ensure that you have reviewed the guidelines under Submitting a PR.
- Generate a commit and push it to your fork.
- Submit a pull request to this repo. Please include the full command output in a PR comment.
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.