Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add parameters and outputs overview #16

Merged
merged 3 commits into from
Dec 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,21 @@ Azure Resource Manager (ARM) template that creates an Azure Storage account to s
terraform init
```

## Parameters

| Name | Description | Type | Default |
| - | - | - | - |
| `storageAccountName` | The name of the storage account to create. | `string` | |
| `ipRules` | An array of IP addresses or ranges that should be granted access to the storage account. If empty, all IP addresses and ranges will be granted access to the storage account. | `array` | `[]` |
| `principalIds` | An array of object IDs for user, group or service principals that should be granted access to the storage account. | `array` | `[]` |

## Outputs

| Name | Description | Type |
| - | - | - |
| `storageAccountName` | The name of the storage account that was created. | `string` |
| `containerName` | The name of the storage container that was created. | `string` |

## References

- [Store Terraform state in Azure Storage](https://learn.microsoft.com/en-us/azure/developer/terraform/store-state-in-azure-storage?tabs=azure-cli)
Expand Down
4 changes: 2 additions & 2 deletions azuredeploy.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
"metadata": {
"_generator": {
"name": "bicep",
"version": "0.31.92.45157",
"templateHash": "17216029301364810951"
"version": "0.32.4.45862",
"templateHash": "6435624962667709005"
}
},
"parameters": {
Expand Down