Skip to content

Commit

Permalink
Sync azure Terraform module documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
1 parent 910cc71 commit 721a8c8
Show file tree
Hide file tree
Showing 18 changed files with 1,069 additions and 345 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,7 @@ terraform destroy
Name | Version | Source | Description
--- | --- | --- | ---
`vnet` | - | ../../modules/vnet |
`public_ip` | - | ../../modules/public_ip |
`panorama` | - | ../../modules/panorama |

### Resources
Expand All @@ -175,16 +176,17 @@ Name | Type | Description
[`name_prefix`](#name_prefix) | `string` | A prefix that will be added to all created resources.
[`create_resource_group`](#create_resource_group) | `bool` | When set to `true` it will cause a Resource Group creation.
[`tags`](#tags) | `map` | Map of tags to assign to the created resources.
[`public_ips`](#public_ips) | `object` | A map defining Public IP Addresses and Prefixes.
[`availability_sets`](#availability_sets) | `map` | A map defining availability sets.
[`panoramas`](#panoramas) | `map` | A map defining Azure Virtual Machine based on Palo Alto Networks Panorama image.

### Outputs

Name | Description
--- | ---
`username` | Initial administrative username to use for VM-Series.
`password` | Initial administrative password to use for VM-Series.
`panorama_mgmt_ips` |
`username` | Initial administrative username to use for Panorama.
`password` | Initial administrative password to use for Panorama.
`panorama_mgmt_ips` | IP addresses for the Panorama management interface.

### Required Inputs details

Expand Down Expand Up @@ -215,6 +217,8 @@ For detailed documentation on each property refer to [module documentation](../.
- `name` - (`string`, required) a name of a VNET. In case `create_virtual_network = false` this should be a
full resource name, including prefixes.
- `address_space` - (`list`, required when `create_virtual_network = false`) a list of CIDRs for a newly created VNET.
- `dns_servers` - (`list`, optional, defaults to module defaults) a list of IP addresses of custom DNS servers (by
default Azure DNS is used).
- `vnet_encryption` - (`string`, optional, defaults to module default) enables Azure Virtual Network Encryption when
set, only possible value at the moment is `AllowUnencrypted`. When set to `null`, the feature is
disabled.
Expand All @@ -238,6 +242,7 @@ map(object({
resource_group_name = optional(string)
create_virtual_network = optional(bool, true)
address_space = optional(list(string))
dns_servers = optional(list(string))
vnet_encryption = optional(string)
network_security_groups = optional(map(object({
name = string
Expand All @@ -259,7 +264,7 @@ map(object({
})), {})
route_tables = optional(map(object({
name = string
disable_bgp_route_propagation = optional(bool)
bgp_route_propagation_enabled = optional(bool)
routes = map(object({
name = string
address_prefix = string
Expand Down Expand Up @@ -325,6 +330,49 @@ Map of tags to assign to the created resources.
Type: map(string)
Default value: `map[]`
<sup>[back to list](#modules-optional-inputs)</sup>
#### public_ips
A map defining Public IP Addresses and Prefixes.
Following properties are available:
- `public_ip_addresses` - (`map`, optional) map of objects describing Public IP Addresses, please refer to
[module documentation](../../modules/public_ip#public_ip_addresses)
for available properties.
- `public_ip_prefixes` - (`map`, optional) map of objects describing Public IP Prefixes, please refer to
[module documentation](../../modules/public_ip#public_ip_prefixes)
for available properties.
Type:
```hcl
object({
public_ip_addresses = optional(map(object({
create = bool
name = string
resource_group_name = optional(string)
zones = optional(list(string))
domain_name_label = optional(string)
idle_timeout_in_minutes = optional(number)
prefix_name = optional(string)
prefix_resource_group_name = optional(string)
})), {})
public_ip_prefixes = optional(map(object({
create = bool
name = string
resource_group_name = optional(string)
zones = optional(list(string))
length = optional(number)
})), {})
})
```
Default value: `map[]`
<sup>[back to list](#modules-optional-inputs)</sup>
Expand Down Expand Up @@ -458,10 +506,11 @@ map(object({
interfaces = list(object({
name = string
subnet_key = string
private_ip_address = optional(string)
create_public_ip = optional(bool, false)
public_ip_name = optional(string)
public_ip_resource_group_name = optional(string)
public_ip_key = optional(string)
private_ip_address = optional(string)
}))
logging_disks = optional(map(object({
name = string
Expand Down
Loading

0 comments on commit 721a8c8

Please sign in to comment.