mirror of
https://github.com/opentofu/opentofu.git
synced 2025-02-25 18:45:20 -06:00
Added documentation.
This commit is contained in:
aznashwan
parent
137cb9778e
commit
329424c04b
@ -17,7 +17,7 @@ it will attach that disk. Otherwise it will create and attach a new empty disk.
|
||||
resource "azure_data_disk" "data" {
|
||||
lun = 0
|
||||
size = 10
|
||||
storage = "yourstorage"
|
||||
storage_service_name = "yourstorage"
|
||||
virtual_machine = "server1"
|
||||
}
|
||||
```
|
||||
@ -43,10 +43,10 @@ The following arguments are supported:
|
||||
* `caching` - (Optional) The caching behavior of data disk. Valid options are:
|
||||
`None`, `ReadOnly` and `ReadWrite` (defaults `None`)
|
||||
|
||||
* `storage ` - (Optional) The name of an existing storage account within the
|
||||
subscription which will be used to store the VHD of this disk. Required
|
||||
if no value is supplied for `media_link`. Changing this forces a new
|
||||
resource to be created.
|
||||
* `storage_service_name` - (Optional) The name of an existing storage account
|
||||
within the subscription which will be used to store the VHD of this disk.
|
||||
Required if no value is supplied for `media_link`. Changing this forces
|
||||
a new resource to be created.
|
||||
|
||||
* `media_link` - (Optional) The location of the blob in storage where the VHD
|
||||
of this disk will be created. The storage account where must be associated
|
||||
|
||||
@ -0,0 +1,36 @@
|
||||
---
|
||||
layout: "azure"
|
||||
page_title: "Azure: azure_dns_server"
|
||||
sidebar_current: "docs-azure-resource-dns-server"
|
||||
description: |-
|
||||
Creates a new DNS server definition to be used internally in Azure.
|
||||
---
|
||||
|
||||
# azure\_dns\_server
|
||||
|
||||
Creates a new DNS server definition to be used internally in Azure.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```
|
||||
resource "azure_dns_server" "google-dns" {
|
||||
name = "google"
|
||||
dns_address = "8.8.8.8"
|
||||
}
|
||||
`
|
||||
```
|
||||
|
||||
## Argument Reference
|
||||
|
||||
The following arguments are supported:
|
||||
|
||||
* `name` - (Required) The name of the DNS server reference. Changing this
|
||||
forces a new resource to be created.
|
||||
|
||||
* `dns_address` - (Required) The IP address of the DNS server.
|
||||
|
||||
## Attributes Reference
|
||||
|
||||
The following attributes are exported:
|
||||
|
||||
* `id` - The DNS server definition ID. Coincides with the given `name`.
|
||||
@ -0,0 +1,50 @@
|
||||
---
|
||||
layout: "azure"
|
||||
page_title: "Azure: azure_hosted_service"
|
||||
sidebar_current: "docs-azure-hosted-service"
|
||||
description: |-
|
||||
Creates a new hosted service on Azure with its own .cloudapp.net domain.
|
||||
---
|
||||
|
||||
# azure\_hosted\_service
|
||||
|
||||
Creates a new hosted service on Azure with its own .cloudapp.net domain.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```
|
||||
resource "azure_hosted_service" "terraform-service" {
|
||||
name = "terraform-service"
|
||||
location = "North Europe"
|
||||
ephemeral_contents = false
|
||||
description = "Hosted service created by Terraform."
|
||||
label = "tf-hs-01"
|
||||
}
|
||||
```
|
||||
|
||||
## Argument Reference
|
||||
|
||||
The following arguments are supported:
|
||||
|
||||
* `name` - (Required) The name of the hosted service. Must be unique on Azure.
|
||||
|
||||
* `location` - (Required) The location where the hosted service should be created.
|
||||
For a list of all Azure locations, please consult [this link](http://azure.microsoft.com/en-us/regions/).
|
||||
|
||||
* `ephemeral_contents` - (Required) A boolean value (true|false), specifying
|
||||
whether all the resources present in the hosted hosted service should be
|
||||
destroyed following the hosted service's destruction.
|
||||
|
||||
* `reverse_dns_fqdn` - (Optional) The reverse of the fully qualified domain name
|
||||
for the hosted service.
|
||||
|
||||
* `label` - (Optional) A label to be used for tracking purposes. Must be
|
||||
non-void. Defaults to `Made by Terraform.`.
|
||||
|
||||
* `description` - (Optional) A description for the hosted service.
|
||||
|
||||
## Attributes Reference
|
||||
|
||||
The following attributes are exported:
|
||||
|
||||
* `id` - The hosted service ID. Coincides with the given `name`.
|
||||
@ -18,7 +18,7 @@ resource "azure_instance" "web" {
|
||||
name = "terraform-test"
|
||||
image = "Ubuntu Server 14.04 LTS"
|
||||
size = "Basic_A1"
|
||||
storage = "yourstorage"
|
||||
storage_service_name = "yourstorage"
|
||||
location = "West US"
|
||||
username = "terraform"
|
||||
password = "Pass!admin123"
|
||||
@ -56,9 +56,9 @@ The following arguments are supported:
|
||||
belongs to. If a value is supplied `subnet` is required. Changing this
|
||||
forces a new resource to be created.
|
||||
|
||||
* `storage` - (Optional) The name of an existing storage account within the
|
||||
subscription which will be used to store the VHDs of this instance.
|
||||
Changing this forces a new resource to be created.
|
||||
* `storage_service_name` - (Optional) The name of an existing storage account
|
||||
within the subscription which will be used to store the VHDs of this
|
||||
instance. Changing this forces a new resource to be created.
|
||||
|
||||
* `reverse_dns` - (Optional) The DNS address to which the IP address of the
|
||||
hosted service resolves when queried using a reverse DNS query. Changing
|
||||
|
||||
@ -0,0 +1,39 @@
|
||||
---
|
||||
layout: "azure"
|
||||
page_title: "Azure: azure_local_network_connection"
|
||||
sidebar_current: "docs-azure-resource-local-network-connection"
|
||||
description: |-
|
||||
Defines a new connection to a remote network throguh a VPN tunnel.
|
||||
---
|
||||
|
||||
# azure\_local\_network\_connection
|
||||
|
||||
Defines a new connection to a remote network throguh a VPN tunnel.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```
|
||||
resource "azure_local_network_connection" "localnet" {
|
||||
name = "terraform-local-network-connection"
|
||||
vpn_gateway_address = "45.12.189.2"
|
||||
address_space_prefixes = ["10.10.10.0/24", "10.10.11.0/24"]
|
||||
}
|
||||
```
|
||||
|
||||
## Argument Reference
|
||||
|
||||
The following arguments are supported:
|
||||
|
||||
* `name` - (Required) The name by which this local network connection will
|
||||
be referenced by. Changing this forces a new resource to be created.
|
||||
|
||||
* `vpn_gateway_address` - (Required) The public IPv4 of the VPN endpoint.
|
||||
|
||||
* `address_space_prefixes` - (Required) List of address spaces accessible
|
||||
through the VPN connection. The elements are in the CIDR format.
|
||||
|
||||
## Attributes Reference
|
||||
|
||||
The following attributes are exported:
|
||||
|
||||
* `id` - The local network connection ID.
|
||||
@ -0,0 +1,42 @@
|
||||
---
|
||||
layout: "azure"
|
||||
page_title: "Azure: azure_security_group"
|
||||
sidebar_current: "docs-azure-resource-security-group"
|
||||
description: |-
|
||||
Creates a new network security group within the context of the specified subscription.
|
||||
---
|
||||
|
||||
# azure\_security\_group
|
||||
|
||||
Creates a new network security group within the context of the specified
|
||||
subscription.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```
|
||||
resource "azure_security_group" "web" {
|
||||
name = "webservers"
|
||||
location = "West US"
|
||||
}
|
||||
```
|
||||
|
||||
## Argument Reference
|
||||
|
||||
The following arguments are supported:
|
||||
|
||||
* `name` - (Required) The name of the security group. Changing this forces a
|
||||
new resource to be created.
|
||||
|
||||
* `label` - (Optional) The identifier for the security group. The label can be
|
||||
up to 1024 characters long. Changing this forces a new resource to be
|
||||
created (defaults to the security group name)
|
||||
|
||||
* `location` - (Required) The location/region where the security group is
|
||||
created. Changing this forces a new resource to be created.
|
||||
|
||||
## Attributes Reference
|
||||
|
||||
The following attributes are exported:
|
||||
|
||||
* `id` - The security group ID.
|
||||
* `label` - The identifier for the security group.
|
||||
@ -1,84 +0,0 @@
|
||||
---
|
||||
layout: "azure"
|
||||
page_title: "Azure: azure_security_group"
|
||||
sidebar_current: "docs-azure-resource-security-group"
|
||||
description: |-
|
||||
Creates a new network security group within the context of the specified subscription.
|
||||
---
|
||||
|
||||
# azure\_security\_group
|
||||
|
||||
Creates a new network security group within the context of the specified
|
||||
subscription.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```
|
||||
resource "azure_security_group" "web" {
|
||||
name = "webservers"
|
||||
location = "West US"
|
||||
|
||||
rule {
|
||||
name = "HTTPS"
|
||||
priority = 101
|
||||
source_cidr = "*"
|
||||
source_port = "*"
|
||||
destination_cidr = "*"
|
||||
destination_port = "443"
|
||||
protocol = "TCP"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Argument Reference
|
||||
|
||||
The following arguments are supported:
|
||||
|
||||
* `name` - (Required) The name of the security group. Changing this forces a
|
||||
new resource to be created.
|
||||
|
||||
* `label` - (Optional) The identifier for the security group. The label can be
|
||||
up to 1024 characters long. Changing this forces a new resource to be
|
||||
created (defaults to the security group name)
|
||||
|
||||
* `location` - (Required) The location/region where the security group is
|
||||
created. Changing this forces a new resource to be created.
|
||||
|
||||
* `rule` - (Required) Can be specified multiple times to define multiple
|
||||
rules. Each `rule` block supports fields documented below.
|
||||
|
||||
The `rule` block supports:
|
||||
|
||||
* `name` - (Required) The name of the security rule.
|
||||
|
||||
* `type ` - (Optional) The type of the security rule. Valid options are:
|
||||
`Inbound` and `Outbound` (defaults `Inbound`)
|
||||
|
||||
* `priority` - (Required) The priority of the network security rule. Rules with
|
||||
lower priority are evaluated first. This value can be between 100 and 4096.
|
||||
|
||||
* `action` - (Optional) The action that is performed when the security rule is
|
||||
matched. Valid options are: `Allow` and `Deny` (defaults `Allow`)
|
||||
|
||||
* `source_cidr` - (Required) The CIDR or source IP range. An asterisk (\*) can
|
||||
also be used to match all source IPs.
|
||||
|
||||
* `source_port` - (Required) The source port or range. This value can be
|
||||
between 0 and 65535. An asterisk (\*) can also be used to match all ports.
|
||||
|
||||
* `destination_cidr` - (Required) The CIDR or destination IP range. An asterisk
|
||||
(\*) can also be used to match all destination IPs.
|
||||
|
||||
* `destination_port` - (Required) The destination port or range. This value can
|
||||
be between 0 and 65535. An asterisk (\*) can also be used to match all
|
||||
ports.
|
||||
|
||||
* `protocol` - (Optional) The protocol of the security rule. Valid options are:
|
||||
`TCP`, `UDP` and `*` (defaults `TCP`)
|
||||
|
||||
## Attributes Reference
|
||||
|
||||
The following attributes are exported:
|
||||
|
||||
* `id` - The security group ID.
|
||||
* `label` - The identifier for the security group.
|
||||
@ -0,0 +1,71 @@
|
||||
---
|
||||
layout: "azure"
|
||||
page_title: "Azure: azure_security_group_rule"
|
||||
sidebar_current: "docs-azure-resource-security-group-rule"
|
||||
description: |-
|
||||
Creates a new network security rule to be associated with a given security group.
|
||||
---
|
||||
|
||||
# azure\_security\_group\_rule
|
||||
|
||||
Creates a new network security rule to be associated with a given security group.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```
|
||||
resource "azure_security_group" "web" {
|
||||
...
|
||||
}
|
||||
|
||||
resource "azure_security_group_rule" "ssh_access" {
|
||||
name = "ssh-access-rule"
|
||||
security_group_name = "${azure_security_group.web.name}"
|
||||
type = "Inbound"
|
||||
action = "Allow"
|
||||
priority = 200
|
||||
source_address_prefix = "100.0.0.0/32"
|
||||
source_port_range = "*"
|
||||
destination_address_prefix = "10.0.0.0/32"
|
||||
destination_port_range = "22"
|
||||
protocol = "TCP"
|
||||
}
|
||||
```
|
||||
|
||||
## Argument Reference
|
||||
|
||||
The following arguments are supported:
|
||||
* `name` - (Required) The name of the security group the rule should be
|
||||
applied to.
|
||||
|
||||
* `security_group_name` - (Required) The name of the security group m
|
||||
|
||||
* `type` - (Required) The type of the security rule. Valid options are:
|
||||
`Inbound` and `Outbound`.
|
||||
|
||||
* `priority` - (Required) The priority of the network security rule. Rules with
|
||||
lower priority are evaluated first. This value can be between 100 and 4096.
|
||||
|
||||
* `action` - (Optional) The action that is performed when the security rule is
|
||||
matched. Valid options are: `Allow` and `Deny`.
|
||||
|
||||
* `source_address_prefix` - (Required) The address prefix of packet sources that
|
||||
that should be subjected to the rule. An asterisk (\*) can also be used to
|
||||
match all source IPs.
|
||||
|
||||
* `source_port_range` - (Required) The source port or range. This value can be
|
||||
between 0 and 65535. An asterisk (\*) can also be used to match all ports.
|
||||
|
||||
* `destination_address_prefix` - (Required) The address prefix of packet
|
||||
destinations that should be subjected to the rule. An asterisk
|
||||
(\*) can also be used to match all destination IPs.
|
||||
|
||||
* `destination_port_range` - (Required) The destination port or range. This value
|
||||
can be between 0 and 65535. An asterisk (\*) can also be used to match all
|
||||
ports.
|
||||
|
||||
* `protocol` - (Optional) The protocol of the security rule. Valid options are:
|
||||
`TCP`, `UDP` and `*`.
|
||||
|
||||
The following attributes are exported:
|
||||
|
||||
* `id` - The security group rule ID. Coincides with its given `name`.
|
||||
@ -0,0 +1,49 @@
|
||||
---
|
||||
layout: "azure"
|
||||
page_title: "Azure: azure_storage_blob"
|
||||
sidebar_current: "docs-azure-storage-blob"
|
||||
description: |-
|
||||
Creates a new storage blob within a given storage container on Azure.
|
||||
---
|
||||
|
||||
# azure\_storage\_blob
|
||||
|
||||
Creates a new storage blob within a given storage container on Azure.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```
|
||||
resource "azure_storage_blob" "foo" {
|
||||
name = "tftesting-blob"
|
||||
storage_service_name = "tfstorserv"
|
||||
storage_container_name = "terraform-storage-container"
|
||||
type = "PageBlob"
|
||||
size = 1024
|
||||
}
|
||||
````
|
||||
|
||||
## Argument Reference
|
||||
|
||||
The following arguments are supported:
|
||||
|
||||
* `name` - (Required) The name of the storage blob. Must be unique within
|
||||
the storage service the blob is located.
|
||||
|
||||
* `storage_service_name` - (Required) The name of the storage service within
|
||||
which the storage container in which the blob will be created resides.
|
||||
|
||||
* `storage_container_name` - (Required) The name of the storage container
|
||||
in which this blob should be created. Must be located on the storage
|
||||
service given with `storage_service_name`.
|
||||
|
||||
* `type` - (Required) The type of the storage blob to be created. One of either
|
||||
`BlockBlob` or `PageBlob`.
|
||||
|
||||
* `size` - (Optional) Used only for `PageBlob`'s to specify the size in bytes
|
||||
of the blob to be created. Must be a multiple of 512. Defaults to 0.
|
||||
|
||||
## Attributes Reference
|
||||
|
||||
The following attributes are exported:
|
||||
|
||||
* `id` - The storage blob ID. Coincides with the given `name`.
|
||||
@ -0,0 +1,43 @@
|
||||
---
|
||||
layout: "azure"
|
||||
page_title: "Azure: azure_storage_container"
|
||||
sidebar_current: "docs-azure-storage-container"
|
||||
description: |-
|
||||
Creates a new storage container within a given storage service on Azure.
|
||||
---
|
||||
|
||||
# azure\_storage\_container
|
||||
|
||||
Creates a new storage container within a given storage service on Azure.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```
|
||||
resource "azure_storage_container" "stor-cont" {
|
||||
name = "terraform-storage-container"
|
||||
container_access_type = "blob"
|
||||
storage_service_name = "tfstorserv"
|
||||
}
|
||||
````
|
||||
|
||||
## Argument Reference
|
||||
|
||||
The following arguments are supported:
|
||||
|
||||
* `name` - (Required) The name of the storage container. Must be unique within
|
||||
the storage service the container is located.
|
||||
|
||||
* `storage_service_name` - (Required) The name of the storage service within
|
||||
which the storage container should be created.
|
||||
|
||||
* `container_access_type` - (Required) The 'interface' for access the container
|
||||
provides. Can be either `blob`, `container` or ``.
|
||||
|
||||
* `properties` - (Optional) Key-value definition of additional properties
|
||||
associated to the storage service.
|
||||
|
||||
## Attributes Reference
|
||||
|
||||
The following attributes are exported:
|
||||
|
||||
* `id` - The storage container ID. Coincides with the given `name`.
|
||||
@ -0,0 +1,55 @@
|
||||
---
|
||||
layout: "azure"
|
||||
page_title: "Azure: azure_storage_service"
|
||||
sidebar_current: "docs-azure-storage-service"
|
||||
description: |-
|
||||
Creates a new storage service on Azure in which storage containers may be created.
|
||||
---
|
||||
|
||||
# azure\_storage\_service
|
||||
|
||||
Creates a new storage service on Azure in which storage containers may be created.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```
|
||||
resource "azure_storage_service" "tfstor" {
|
||||
name = "tfstor"
|
||||
location = "West US"
|
||||
description = "Made by Terraform."
|
||||
account_type = "Standard_LRS"
|
||||
}
|
||||
````
|
||||
|
||||
## Argument Reference
|
||||
|
||||
The following arguments are supported:
|
||||
|
||||
* `name` - (Required) The name of the storage service. Must be between 4 and 24
|
||||
lowercase-only characters or digits Must be unique on Azure.
|
||||
|
||||
* `location` - (Required) The location where the storage service should be created.
|
||||
For a list of all Azure locations, please consult [this link](http://azure.microsoft.com/en-us/regions/).
|
||||
|
||||
* `account_type` - (Required) The type of storage account to be created.
|
||||
Available options include `Standard_LRS`, `Standard_ZRS`, `Standard_GRS`,
|
||||
`Standard_RAGRS` and `Premium_LRS`. To learn more about the differences
|
||||
of each storage account type, please consult [this link](http://blogs.msdn.com/b/windowsazurestorage/archive/2013/12/11/introducing-read-access-geo-replicated-storage-ra-grs-for-windows-azure-storage.aspx).
|
||||
|
||||
* `affinity_group` - (Optional) The affinity group the storage service should
|
||||
belong to.
|
||||
|
||||
* `properties` - (Optional) Key-value definition of additional properties
|
||||
associated to the storage service. For additional information on what
|
||||
these properties do, please consult [this link](https://msdn.microsoft.com/en-us/library/azure/hh452235.aspx).
|
||||
|
||||
* `label` - (Optional) A label to be used for tracking purposes. Must be
|
||||
non-void. Defaults to `Made by Terraform.`.
|
||||
|
||||
* `description` - (Optional) A description for the storage service.
|
||||
|
||||
## Attributes Reference
|
||||
|
||||
The following attributes are exported:
|
||||
|
||||
* `id` - The storage service ID. Coincides with the given `name`.
|
||||
@ -40,6 +40,9 @@ The following arguments are supported:
|
||||
* `location` - (Required) The location/region where the virtual network is
|
||||
created. Changing this forces a new resource to be created.
|
||||
|
||||
* `dns_servers` - (Optional) List of names of DNS servers previously registered
|
||||
on Azure.
|
||||
|
||||
* `subnet` - (Required) Can be specified multiple times to define multiple
|
||||
subnets. Each `subnet` block supports fields documented below.
|
||||
|
||||
|
||||
@ -17,14 +17,42 @@
|
||||
<a href="/docs/providers/azure/r/data_disk.html">azure_data_disk</a>
|
||||
</li>
|
||||
|
||||
<li<%= sidebar_current("docs-azure-resource-dns-server") %>>
|
||||
<a href="/docs/providers/azure/r/dns_server.html">azure_dns_server</a>
|
||||
</li>
|
||||
|
||||
<li<%= sidebar_current("docs-azure-resource-hosted-service") %>>
|
||||
<a href="/docs/providers/azure/r/hosted_service.html">azure_hosted_service</a>
|
||||
</li>
|
||||
|
||||
<li<%= sidebar_current("docs-azure-resource-instance") %>>
|
||||
<a href="/docs/providers/azure/r/instance.html">azure_instance</a>
|
||||
</li>
|
||||
|
||||
<li<%= sidebar_current("docs-azure-resource-local-network") %>>
|
||||
<a href="/docs/providers/azure/r/local_network_connection.html">azure_local_network_connection</a>
|
||||
</li>
|
||||
|
||||
<li<%= sidebar_current("docs-azure-resource-security-group") %>>
|
||||
<a href="/docs/providers/azure/r/security_group.html">azure_security_group</a>
|
||||
</li>
|
||||
|
||||
<li<%= sidebar_current("docs-azure-resource-security-group-rule") %>>
|
||||
<a href="/docs/providers/azure/r/security_group_rule.html">azure_security_group_rule</a>
|
||||
</li>
|
||||
|
||||
<li<%= sidebar_current("docs-azure-resource-storage-blob") %>>
|
||||
<a href="/docs/providers/azure/r/storage_blob.html">azure_storage_blob</a>
|
||||
</li>
|
||||
|
||||
<li<%= sidebar_current("docs-azure-resource-storage-container") %>>
|
||||
<a href="/docs/providers/azure/r/storage_container.html">azure_storage_container</a>
|
||||
</li>
|
||||
|
||||
<li<%= sidebar_current("docs-azure-resource-storage-service") %>>
|
||||
<a href="/docs/providers/azure/r/storage_service.html">azure_storage_service</a>
|
||||
</li>
|
||||
|
||||
<li<%= sidebar_current("docs-azure-resource-virtual-network") %>>
|
||||
<a href="/docs/providers/azure/r/virtual_network.html">azure_virtual_network</a>
|
||||
</li>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user