Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/azure/deployment-what-if-action
GitHub Action to preview Azure infrastructure changes before its deployment.
https://github.com/azure/deployment-what-if-action
arm-templates azure bicep github-actions what-if
Last synced: 4 months ago
JSON representation
GitHub Action to preview Azure infrastructure changes before its deployment.
- Host: GitHub
- URL: https://github.com/azure/deployment-what-if-action
- Owner: Azure
- License: mit
- Created: 2021-09-16T11:56:16.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-04-02T17:56:30.000Z (almost 2 years ago)
- Last Synced: 2024-09-30T16:10:13.160Z (4 months ago)
- Topics: arm-templates, azure, bicep, github-actions, what-if
- Homepage:
- Size: 13.7 KB
- Stars: 6
- Watchers: 5
- Forks: 7
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Azure Deployment What-If Action
GitHub Action that previews the effects of your Azure infrastructure changes before its deployment by running an [ARM template deployment what-if operation](https://docs.microsoft.com/en-us/azure/azure-resource-manager/templates/deploy-what-if?tabs=azure-powershell).
## When to use
The action is particularly useful on Infrastructure as Code Continuous Integration (CI) workflows, where you can provide detailed information of how Azure resources will change if you deploy the ARM template. The action doesn't make any changes to existing resources.
## Getting Started
### Prerequisites
- Have your service principal credentials stored as [encrypted secrets](https://docs.github.com/en/actions/reference/encrypted-secrets) on GitHub.
Additionally, if your GitHub Actions workflows are running on a [self-hosted runner](https://docs.github.com/en/actions/hosting-your-own-runners/about-self-hosted-runners):
- [Azure CLI](https://docs.microsoft.com/en-us/azure/azure-resource-manager/bicep/install#azure-cli) 2.20.0 or later installed
### Example Usage
#### **Preview changes with a parameters file**
```yml
steps:
- name: Azure Login
uses: Azure/[email protected]
with:
creds: '{"clientId":"${{ secrets.CLIENT_ID }}","clientSecret":"${{ secrets.CLIENT_SECRET }}","subscriptionId":"${{ secrets.SUBSCRIPTION_ID }}","tenantId":"${{ secrets.TENANT_ID }}"}'
- name: Preview changes
uses: Azure/[email protected]
with:
subscription: ${{ secrets.SUBSCRIPTION_ID }}
resourceGroup: ''
templateFile: azuredeploy.json # main.bicep
parametersFile: parameters.json
```
#### **Preview changes with additional parameters**
```yml
steps:
- name: Azure Login
uses: Azure/[email protected]
with:
creds: '{"clientId":"${{ secrets.CLIENT_ID }}","clientSecret":"${{ secrets.CLIENT_SECRET }}","subscriptionId":"${{ secrets.SUBSCRIPTION_ID }}","tenantId":"${{ secrets.TENANT_ID }}"}'
- name: Preview changes
uses: Azure/[email protected]
with:
subscription: ${{ secrets.SUBSCRIPTION_ID }}
resourceGroup: ''
templateFile: azuredeploy.json # main.bicep
additionalParameters: key1=value key2=value keyN=value
```
> Note: `parametersFile` and `additionalParameters` can be used together.
### Inputs
| Name | Description | Required |
| --- | --- | --- |
| `subscription` | Subscription ID | true |
| `resourceGroup` | Resource group name | true |
| `templateFile` | ARM template (`.json`) or Bicep (`.bicep`) file | true |
| `parametersFile` | Parameters file for the ARM template or Bicep | false |
| `additionalParameters` | Additional parameters to be applied on the ARM template or Bicep. Multiple parameters should be separated by spaces. | false |
## Contributing
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](https://opensource.microsoft.com/codeofconduct/).
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
## Trademarks
This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft
trademarks or logos is subject to and must follow
[Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).
Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
Any use of third-party trademarks or logos are subject to those third-party's policies.