Skip to content

Commit

Permalink
terraform-docs: automated action
Browse files Browse the repository at this point in the history
  • Loading branch information
@github-actions
github-actions[bot] committed Sep 23, 2024
1 parent 24f38f7 commit b02aac6
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,16 +68,16 @@ resource "azurerm_subnet" "this" {

| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| <a name="input_admin_credential"></a> [admin\_credential](#input\_admin\_credential) | <pre>Specify either admin_password or public_key:<br> admin_password: Password of the local administrator.<br> public_key: SSH public key file (e.g. file(id_rsa.pub))</pre> | <pre>object({<br> admin_password = optional(string)<br> public_key = optional(string)<br> })</pre> | n/a | yes |
| <a name="input_admin_credential"></a> [admin\_credential](#input\_admin\_credential) | <pre>Specify either admin_password or public_key:<br/> admin_password: Password of the local administrator.<br/> public_key: SSH public key file (e.g. file(id_rsa.pub))</pre> | <pre>object({<br/> admin_password = optional(string)<br/> public_key = optional(string)<br/> })</pre> | n/a | yes |
| <a name="input_resource_group_name"></a> [resource\_group\_name](#input\_resource\_group\_name) | Name of the resource group where the resources will be created. | `string` | n/a | yes |
| <a name="input_subnet"></a> [subnet](#input\_subnet) | The variable takes the subnet as input and takes the id and the address prefix for further configuration. | <pre>object({<br> id = string<br> address_prefixes = list(string)<br> })</pre> | n/a | yes |
| <a name="input_virtual_machine_config"></a> [virtual\_machine\_config](#input\_virtual\_machine\_config) | <pre>hostname: Name of system hostname.<br> size: The size of the vm. Possible values can be seen here: https://learn.microsoft.com/en-us/azure/virtual-machines/sizes<br> location: The location of the virtual machine.<br> os_sku: (Required) The os that will be running on the vm.<br> os_offer: (Required) Specifies the offer of the image used to create the virtual machines. Changing this forces a new resource to be created.<br> os_version: (Required) Optionally specify an os version for the chosen sku.<br> os_publisher: (Required) Specifies the Publisher of the Marketplace Image this Virtual Machine should be created from. Changing this forces a new resource to be created.<br> os_disk_caching: Optionally change the caching option of the os disk. Defaults to ReadWrite.<br> os_disk_size_gb: Optionally change the size of the os disk. Defaults to be specified by image.<br> os_disk_storage_type: Optionally change the os_disk_storage_type. Defaults to StandardSSD_LRS.<br> zone: Optionally specify an availibility zone for the vm. Values 1, 2 or 3.<br> availability_set_id: Optionally specify an availibility set for the vm. Not compatible with zone.<br> os_disk_write_accelerator_enabled: Optionally activate write accelaration for the os disk. Can only<br> be activated on Premium disks and caching deactivated. Defaults to false.<br> proximity_placement_group_id: (Optional) The ID of the Proximity Placement Group which the Virtual Machine should be assigned to.<br> severity_group: (Required) Sets tag 'Severity Group Monthly' to a specific time and date when an update will be done automatically.<br> update_allowed: Sets tag 'Update allowed' to yes or no to specify if this VM should currently receive updates.<br> enable_plan: When using marketplace images, sending plan information might be required. Also accepts the terms of the marketplace product.</pre> | <pre>object({<br> hostname = string<br> size = string<br> location = string<br> os_sku = string<br> os_offer = string<br> os_version = string<br> os_publisher = string<br> os_disk_caching = optional(string, "ReadWrite")<br> os_disk_size_gb = optional(number)<br> os_disk_storage_type = optional(string, "Premium_LRS")<br> os_disk_write_accelerator_enabled = optional(bool, false)<br> zone = optional(number)<br> availability_set_id = optional(string)<br> proximity_placement_group_id = optional(string)<br> severity_group = string<br> update_allowed = optional(bool, true)<br> enable_plan = optional(bool, false)<br> })</pre> | n/a | yes |
| <a name="input_subnet"></a> [subnet](#input\_subnet) | The variable takes the subnet as input and takes the id and the address prefix for further configuration. | <pre>object({<br/> id = string<br/> address_prefixes = list(string)<br/> })</pre> | n/a | yes |
| <a name="input_virtual_machine_config"></a> [virtual\_machine\_config](#input\_virtual\_machine\_config) | <pre>hostname: Name of system hostname.<br/> size: The size of the vm. Possible values can be seen here: https://learn.microsoft.com/en-us/azure/virtual-machines/sizes<br/> location: The location of the virtual machine.<br/> os_sku: (Required) The os that will be running on the vm.<br/> os_offer: (Required) Specifies the offer of the image used to create the virtual machines. Changing this forces a new resource to be created.<br/> os_version: (Required) Optionally specify an os version for the chosen sku.<br/> os_publisher: (Required) Specifies the Publisher of the Marketplace Image this Virtual Machine should be created from. Changing this forces a new resource to be created.<br/> os_disk_caching: Optionally change the caching option of the os disk. Defaults to ReadWrite.<br/> os_disk_size_gb: Optionally change the size of the os disk. Defaults to be specified by image.<br/> os_disk_storage_type: Optionally change the os_disk_storage_type. Defaults to StandardSSD_LRS.<br/> zone: Optionally specify an availibility zone for the vm. Values 1, 2 or 3.<br/> availability_set_id: Optionally specify an availibility set for the vm. Not compatible with zone.<br/> os_disk_write_accelerator_enabled: Optionally activate write accelaration for the os disk. Can only<br/> be activated on Premium disks and caching deactivated. Defaults to false.<br/> proximity_placement_group_id: (Optional) The ID of the Proximity Placement Group which the Virtual Machine should be assigned to.<br/> severity_group: (Required) Sets tag 'Severity Group Monthly' to a specific time and date when an update will be done automatically.<br/> update_allowed: Sets tag 'Update allowed' to yes or no to specify if this VM should currently receive updates.<br/> enable_plan: When using marketplace images, sending plan information might be required. Also accepts the terms of the marketplace product.</pre> | <pre>object({<br/> hostname = string<br/> size = string<br/> location = string<br/> os_sku = string<br/> os_offer = string<br/> os_version = string<br/> os_publisher = string<br/> os_disk_caching = optional(string, "ReadWrite")<br/> os_disk_size_gb = optional(number)<br/> os_disk_storage_type = optional(string, "Premium_LRS")<br/> os_disk_write_accelerator_enabled = optional(bool, false)<br/> zone = optional(number)<br/> availability_set_id = optional(string)<br/> proximity_placement_group_id = optional(string)<br/> severity_group = string<br/> update_allowed = optional(bool, true)<br/> enable_plan = optional(bool, false)<br/> })</pre> | n/a | yes |
| <a name="input_additional_network_interface_ids"></a> [additional\_network\_interface\_ids](#input\_additional\_network\_interface\_ids) | List of ids for additional azurerm\_network\_interface. | `list(string)` | `[]` | no |
| <a name="input_admin_username"></a> [admin\_username](#input\_admin\_username) | Optionally choose the admin\_username of the vm. Defaults to loc\_sysadmin. | `string` | `"loc_sysadmin"` | no |
| <a name="input_data_disks"></a> [data\_disks](#input\_data\_disks) | <pre><logical name of the data disk> = {<br> lun: Number of the lun.<br> disk_size_gb: The size of the data disk.<br> storage_account_type: Optionally change the storage_account_type. Defaults to StandardSSD_LRS.<br> caching: Optionally activate disk caching. Defaults to None.<br> create_option: Optionally change the create option. Defaults to Empty disk.<br> source_resource_id: (Optional) The ID of an existing Managed Disk or Snapshot to copy when create_option is Copy or<br> the recovery point to restore when create_option is Restore. Changing this forces a new resource to be created.<br> write_accelerator_enabled: Optionally activate write accelaration for the data disk. Can only<br> be activated on Premium disks and caching deactivated. Defaults to false.<br> on_demand_bursting_enabled: Optionally activate disk bursting. Only for Premium disk. Default false.<br> }</pre> | <pre>map(object({<br> lun = number<br> disk_size_gb = number<br> caching = optional(string, "ReadWrite")<br> create_option = optional(string, "Empty")<br> source_resource_id = optional(string)<br> storage_account_type = optional(string, "Premium_LRS")<br> write_accelerator_enabled = optional(bool, false)<br> on_demand_bursting_enabled = optional(bool, false)<br> }))</pre> | `{}` | no |
| <a name="input_name_overrides"></a> [name\_overrides](#input\_name\_overrides) | Possibility to override names that will be generated according to q.beyond naming convention. | <pre>object({<br> nic = optional(string)<br> nic_ip_config = optional(string)<br> public_ip = optional(string)<br> virtual_machine = optional(string)<br> os_disk = optional(string)<br> data_disks = optional(map(string), {})<br> })</pre> | `{}` | no |
| <a name="input_nic_config"></a> [nic\_config](#input\_nic\_config) | <pre>private_ip: Optioanlly specify a private ip to use. Otherwise it will be allocated dynamically.<br> dns_servers: Optionally specify a list of dns servers for the nic.<br> enable_accelerated_networking: Enabled Accelerated networking (SR-IOV) on the NIC. The machine SKU must support this feature.<br> nsg: Although it is discouraged you can optionally assign an NSG to the NIC. Optionally specify a NSG object.</pre> | <pre>object({<br> private_ip = optional(string)<br> dns_servers = optional(list(string))<br> enable_accelerated_networking = optional(bool, false)<br> nsg = optional(object({<br> id = string<br> }))<br> })</pre> | `{}` | no |
| <a name="input_public_ip_config"></a> [public\_ip\_config](#input\_public\_ip\_config) | <pre>allocation_method: The allocation method of the public ip that will be created. Defaults to static.<br> stage: The stage of this PIP. Ex: prd, dev, tst, ...</pre> | <pre>object({<br> allocation_method = optional(string, "Static")<br> stage = string<br> })</pre> | `null` | no |
| <a name="input_data_disks"></a> [data\_disks](#input\_data\_disks) | <pre><logical name of the data disk> = {<br/> lun: Number of the lun.<br/> disk_size_gb: The size of the data disk.<br/> storage_account_type: Optionally change the storage_account_type. Defaults to StandardSSD_LRS.<br/> caching: Optionally activate disk caching. Defaults to None.<br/> create_option: Optionally change the create option. Defaults to Empty disk.<br/> source_resource_id: (Optional) The ID of an existing Managed Disk or Snapshot to copy when create_option is Copy or<br/> the recovery point to restore when create_option is Restore. Changing this forces a new resource to be created.<br/> write_accelerator_enabled: Optionally activate write accelaration for the data disk. Can only<br/> be activated on Premium disks and caching deactivated. Defaults to false.<br/> on_demand_bursting_enabled: Optionally activate disk bursting. Only for Premium disk. Default false.<br/> }</pre> | <pre>map(object({<br/> lun = number<br/> disk_size_gb = number<br/> caching = optional(string, "ReadWrite")<br/> create_option = optional(string, "Empty")<br/> source_resource_id = optional(string)<br/> storage_account_type = optional(string, "Premium_LRS")<br/> write_accelerator_enabled = optional(bool, false)<br/> on_demand_bursting_enabled = optional(bool, false)<br/> }))</pre> | `{}` | no |
| <a name="input_name_overrides"></a> [name\_overrides](#input\_name\_overrides) | Possibility to override names that will be generated according to q.beyond naming convention. | <pre>object({<br/> nic = optional(string)<br/> nic_ip_config = optional(string)<br/> public_ip = optional(string)<br/> virtual_machine = optional(string)<br/> os_disk = optional(string)<br/> data_disks = optional(map(string), {})<br/> })</pre> | `{}` | no |
| <a name="input_nic_config"></a> [nic\_config](#input\_nic\_config) | <pre>private_ip: Optioanlly specify a private ip to use. Otherwise it will be allocated dynamically.<br/> dns_servers: Optionally specify a list of dns servers for the nic.<br/> enable_accelerated_networking: Enabled Accelerated networking (SR-IOV) on the NIC. The machine SKU must support this feature.<br/> nsg: Although it is discouraged you can optionally assign an NSG to the NIC. Optionally specify a NSG object.</pre> | <pre>object({<br/> private_ip = optional(string)<br/> dns_servers = optional(list(string))<br/> enable_accelerated_networking = optional(bool, false)<br/> nsg = optional(object({<br/> id = string<br/> }))<br/> })</pre> | `{}` | no |
| <a name="input_public_ip_config"></a> [public\_ip\_config](#input\_public\_ip\_config) | <pre>allocation_method: The allocation method of the public ip that will be created. Defaults to static.<br/> stage: The stage of this PIP. Ex: prd, dev, tst, ...</pre> | <pre>object({<br/> allocation_method = optional(string, "Static")<br/> stage = string<br/> })</pre> | `null` | no |
| <a name="input_tags"></a> [tags](#input\_tags) | A map of tags that will be set on every resource this module creates. | `map(string)` | `{}` | no |
## Outputs

Expand Down

0 comments on commit b02aac6

Please sign in to comment.