{"id":15291400,"url":"https://github.com/azure/psrule.rules.azure-quickstart","last_synced_at":"2025-05-12T17:25:42.485Z","repository":{"id":40261710,"uuid":"421026959","full_name":"Azure/PSRule.Rules.Azure-quickstart","owner":"Azure","description":"Sample code you can use to quickly start using PSRule for Azure.","archived":false,"fork":false,"pushed_at":"2025-05-02T22:23:06.000Z","size":130,"stargazers_count":35,"open_issues_count":2,"forks_count":27,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-05-10T00:12:10.241Z","etag":null,"topics":["azure","bicep","devops","github-actions","psrule","sample-code"],"latest_commit_sha":null,"homepage":"https://azure.github.io/PSRule.Rules.Azure/","language":"Bicep","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Azure.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":"SECURITY.md","support":"SUPPORT.md","governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2021-10-25T13:05:04.000Z","updated_at":"2025-04-24T02:03:54.000Z","dependencies_parsed_at":"2024-01-01T02:23:40.366Z","dependency_job_id":"08df0ed4-26b0-40e6-8196-a99e11c852da","html_url":"https://github.com/Azure/PSRule.Rules.Azure-quickstart","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Azure%2FPSRule.Rules.Azure-quickstart","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Azure%2FPSRule.Rules.Azure-quickstart/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Azure%2FPSRule.Rules.Azure-quickstart/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Azure%2FPSRule.Rules.Azure-quickstart/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Azure","download_url":"https://codeload.github.com/Azure/PSRule.Rules.Azure-quickstart/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253785852,"owners_count":21964039,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["azure","bicep","devops","github-actions","psrule","sample-code"],"created_at":"2024-09-30T16:12:19.243Z","updated_at":"2025-05-12T17:25:42.453Z","avatar_url":"https://github.com/Azure.png","language":"Bicep","funding_links":[],"categories":[],"sub_categories":[],"readme":"# PSRule for Azure Quick Start\n\nThis repository contains a sample code you can use to quickly start using PSRule for Azure.\nTo learn more about PSRule for Azure, see \u003chttps://aka.ms/ps-rule-azure\u003e.\n\n[![Use this template](https://img.shields.io/static/v1?label=GitHub\u0026message=Use%20this%20template\u0026logo=github\u0026color=007acc)][1]\n[![Open in vscode.dev](https://img.shields.io/badge/Open%20in-vscode.dev-blue)][2]\n\n  [1]: https://github.com/Azure/PSRule.Rules.Azure-quickstart/generate\n  [2]: https://vscode.dev/github/Azure/PSRule.Rules.Azure-quickstart\n\n## What's included?\n\nThis repository includes:\n\n- **Azure Bicep deployment** \u0026mdash; Starter Azure Bicep deployments.\n  - Use the files in the `deployments/` folder if you are using Bicep to deploy resources.\n- **Azure Bicep modules** \u0026mdash; Starter Azure Bicep modules.\n  - Use the files in the `modules/` folder if you are using Bicep to create reusable modules with tests.\n- **GitHub Actions** \u0026mdash; Starter workflow for checking Azure Infrastructure as Code (IaC).\n  - Use the files in the `.github/workflows/` to check your Azure IaC with GitHub Actions.\n  - The `ms-analyze.yaml` file can be ignore or removed as this will not execute outside this repository.\n- **Azure Pipelines** \u0026mdash; Starter pipeline for checking Azure Infrastructure as Code (IaC).\n  - Use the files in the `.pipelines/` to check your Azure IaC with Azure Pipelines.\n- **Custom rules and baselines** \u0026mdash; Example custom rules and baselines.\n  - These rules and baselines can be used to enforce organization specific requirements.\n  - Use the files in the `.ps-rule/` folder to configure custom rules and baselines.\n- **PSRule options** \u0026mdash; Example options for using PSRule for Azure.\n  - PSRule options are configures within `ps-rule.yaml`.\n  - Options include suppressing rules, configuring input/ output, and any rules modules.\n\n\u003e [!NOTE]\n\u003e PSRule for Azure supports ARM templates in addition to Bicep code.\n\u003e However going forward this repository will focus on Bicep deployments and modules.\n\u003e Existing ARM templates samples are no longer maintained and have been archived.\n\u003e To access these samples jump to the [archive/with-arm-templates][3] branch.\n\n  [3]: https://github.com/Azure/PSRule.Rules.Azure-quickstart/tree/archive/with-arm-templates\n\n## What to expect?\n\nThis repository shows valid uses of PSRule for Azure, both pass and failure cases.\nInspect the following files for instructions to test PSRule for Azure rules by creating a failure.\n\n- [deployments/contoso/landing-zones/subscription-1/rg-app-001/dev.bicepparam](deployments/contoso/landing-zones/subscription-1/rg-app-001/dev.bicepparam)\n- [deployments/contoso/landing-zones/subscription-1/rg-app-002/deploy.bicep](deployments/contoso/landing-zones/subscription-1/rg-app-002/deploy.bicep)\n\n## Support\n\nThis project uses GitHub Issues to track bugs and feature requests.\nPlease search the existing issues before filing new issues to avoid duplicates.\n\n- For new issues, file your bug or feature request as a new [issue].\n- For help, discussion, and support questions about using this project, join or start a [discussion].\n\nSupport for this project/ product is limited to the resources listed above.\n\n## Contributing\n\nThis project welcomes contributions and suggestions.\nIf you are ready to contribute, please visit the [contribution guide](CONTRIBUTING.md).\n\n## Code of Conduct\n\nThis project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).\nFor more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)\nor contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.\n\n## Maintainers\n\n- [Bernie White](https://github.com/BernieWhite)\n\n## License\n\nThis project is [licensed under the MIT License](LICENSE).\n\n## Trademarks\n\nThis project may contain trademarks or logos for projects, products, or services.\nAuthorized use of Microsoft trademarks or logos is subject to and must follow [Microsoft's Trademark \u0026 Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).\nUse of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.\nAny use of third-party trademarks or logos are subject to those third-party's policies.\n\n[issue]: https://github.com/Azure/PSRule.Rules.Azure-quickstart/issues\n[discussion]: https://github.com/Azure/PSRule.Rules.Azure-quickstart/discussions\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fazure%2Fpsrule.rules.azure-quickstart","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fazure%2Fpsrule.rules.azure-quickstart","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fazure%2Fpsrule.rules.azure-quickstart/lists"}