Skip to content

Commit dbcd0a7

Browse files
jensheerinjensheerin
committed
update readme
1 parent 4dab108 commit dbcd0a7

2 files changed

Lines changed: 112 additions & 31 deletions

File tree

‎quickstart/101-azure-virtual-desktop/README.md‎

Lines changed: 10 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -30,47 +30,26 @@ This directory contains the various components for building out Azure Virtual De
3030
* `afstorage.tf`
3131
deploys Azure Files storage for profiles and creates file share with RBAC permissions for the users group ([NTFS permissions will need to be configured](https://docs.microsoft.com/en-us/azure/virtual-desktop/create-file-share))
3232
* `rbac.tf`
33-
deploys rbac assignment for the users group
33+
deploys rbac assignment for the users group
3434
* `variables.tf`
3535
Input variables
36+
* `loganalytics.tf`
37+
deploys log anaylytics workspace
38+
* `sig.tf`
39+
deploys log anaylytics workspace
40+
* `random.tf`
41+
Random provider configuration
3642
* `defaults.tfvars`
3743
declares the actual input values (keep security in mind if you are putting confidential data)
3844
* `provider.tf`
39-
Azure RM and Azure AD provider configuation
45+
Azure RM and Azure AD provider configuration
4046
* `outputs.tf`
4147
defines the outputs that will be displayed on deployment
4248
* `netappstorage.tf`
4349
as an alternate to Azure Files storage this deploys NetApp Files storage for profiles in a dedicated subnet (access needs to be granted to the ANF service) [Set up Azure NetApp Files](https://docs.microsoft.com/en-us/azure/azure-netapp-files/azure-netapp-files-quickstart-set-up-account-create-volumes?tabs=azure-portal)
4450

45-
## Varialble Inputs
46-
47-
| Name | Description | Default |
48-
|:---|:---|:---|
49-
| `rg_name` | Name of the Resource Group in which to deploy these resources | `AVD-TF` |
50-
| `deploy_location` | Region in which to deploy these resources | - |
51-
| `hostpool` | Name of the Azure Virtual Desktop host pool | `AVD-TF-HP` |
52-
| `ad_vnet` | Name of domain controller VNet | - |
53-
| `dns_servers` | Custom DNS configuration | - |
54-
| `vnet_range` | Address range for deployment VNet | - |
55-
| `subnet_range` | Address range for session host subnet | - |
56-
| `avd_users` | The resource group for AD VM | `[]` |
57-
| `aad_group_name` | Azure Active Directory Group for AVD users | - |
58-
| `rdsh_count` | Number of AVD machines to deploy | 2 |
59-
| `prefix` | Prefix of the name of the AVD machine(s) | - |
60-
| `domain_name` | Name of the domain to join | - |
61-
| `domain_user_upn` | Username for domain join (do not include domain name as this is appended | - |
62-
| `domain_password` | Password of the user to authenticate with the domain | - |
63-
| `vm_size` | Size of the machine to deploy | `Standard_DS2_v2` |
64-
| `ou_path` | The ou path for AD | `""` |
65-
| `local_admin_username` | The local admin username for the VM | - |
66-
| `local_admin_password` | The local admin password for the VM | - |
67-
| `netapp_acct_name` | The NetApp account name | `AVD_NetApp` |
68-
| `netapp_pool_name` | The NetApp pool name | `AVD_NetApp_pool` |
69-
| `netapp_volume_name` | The NetApp volume name | `AVD_NetApp_volume` |
70-
| `netapp_smb_name` | The NetApp smb name | `AVDNetApp` |
71-
| `netapp_volume_path` | The NetApp volume path | `AVDNetAppVolume` |
72-
| `netapp_subnet_name` | The NetApp subnet name | `NetAppSubnet` |
73-
| `netapp_address` | The Address range for NetApp Subnet | - |
51+
## Variable Inputs
52+
[Variable Inputs](https://github.com/jensheerin/AVD-Terraform/blob/main/USAGE.md#inputs)
7453

7554
## Deploy
7655
If you’ve not previously setup terraform, check out this article to get it installed [Quickstart - Configure Terraform using Azure Cloud Shell](https://docs.microsoft.com/en-us/azure/developer/terraform/get-started-cloud-shell)

‎quickstart/101-azure-virtual-desktop/USAGE.md‎

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
# Usage
2+
3+
<!--- BEGIN_TF_DOCS --->
4+
## Requirements
5+
6+
| Name | Version |
7+
|------|---------|
8+
| <a name="requirement_azurerm"></a> [azurerm](#requirement\_azurerm) | ~>2.0 |
9+
10+
## Providers
11+
12+
| Name | Version |
13+
|------|---------|
14+
| <a name="provider_azuread"></a> [azuread](#provider\_azuread) | n/a |
15+
| <a name="provider_azurerm"></a> [azurerm](#provider\_azurerm) | ~>2.0 |
16+
| <a name="provider_random"></a> [random](#provider\_random) | n/a |
17+
| <a name="provider_time"></a> [time](#provider\_time) | n/a |
18+
19+
## Modules
20+
21+
No modules.
22+
23+
## Resources
24+
25+
| Name | Type |
26+
|------|------|
27+
| [azuread_group.aad_group](https://registry.terraform.io/providers/hashicorp/azuread/latest/docs/resources/group) | resource |
28+
| [azuread_group_member.aad_group_member](https://registry.terraform.io/providers/hashicorp/azuread/latest/docs/resources/group_member) | resource |
29+
| [azurerm_log_analytics_workspace.law](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/log_analytics_workspace) | resource |
30+
| [azurerm_network_interface.avd_vm_nic](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/network_interface) | resource |
31+
| [azurerm_network_security_group.nsg](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/network_security_group) | resource |
32+
| [azurerm_resource_group.log](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/resource_group) | resource |
33+
| [azurerm_resource_group.rg](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/resource_group) | resource |
34+
| [azurerm_resource_group.rg_storage](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/resource_group) | resource |
35+
| [azurerm_resource_group.sigrg](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/resource_group) | resource |
36+
| [azurerm_role_assignment.af_role](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/role_assignment) | resource |
37+
| [azurerm_role_assignment.role](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/role_assignment) | resource |
38+
| [azurerm_shared_image.example](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/shared_image) | resource |
39+
| [azurerm_shared_image_gallery.sig](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/shared_image_gallery) | resource |
40+
| [azurerm_storage_account.storage](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/storage_account) | resource |
41+
| [azurerm_storage_share.FSShare](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/storage_share) | resource |
42+
| [azurerm_subnet.subnet](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/subnet) | resource |
43+
| [azurerm_subnet_network_security_group_association.nsg_assoc](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/subnet_network_security_group_association) | resource |
44+
| [azurerm_virtual_desktop_application_group.dag](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/virtual_desktop_application_group) | resource |
45+
| [azurerm_virtual_desktop_host_pool.hostpool](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/virtual_desktop_host_pool) | resource |
46+
| [azurerm_virtual_desktop_workspace.workspace](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/virtual_desktop_workspace) | resource |
47+
| [azurerm_virtual_desktop_workspace_application_group_association.ws-dag](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/virtual_desktop_workspace_application_group_association) | resource |
48+
| [azurerm_virtual_machine_extension.domain_join](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/virtual_machine_extension) | resource |
49+
| [azurerm_virtual_machine_extension.vmext_dsc](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/virtual_machine_extension) | resource |
50+
| [azurerm_virtual_network.vnet](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/virtual_network) | resource |
51+
| [azurerm_virtual_network_peering.peer1](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/virtual_network_peering) | resource |
52+
| [azurerm_virtual_network_peering.peer2](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/virtual_network_peering) | resource |
53+
| [azurerm_windows_virtual_machine.avd_vm](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/windows_virtual_machine) | resource |
54+
| [random_string.AVD_local_password](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/string) | resource |
55+
| [random_string.random](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/string) | resource |
56+
| [time_rotating.avd_token](https://registry.terraform.io/providers/hashicorp/time/latest/docs/resources/rotating) | resource |
57+
| [azuread_user.aad_user](https://registry.terraform.io/providers/hashicorp/azuread/latest/docs/data-sources/user) | data source |
58+
| [azurerm_role_definition.role](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/role_definition) | data source |
59+
| [azurerm_role_definition.storage_role](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/role_definition) | data source |
60+
| [azurerm_virtual_network.ad_vnet_data](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/virtual_network) | data source |
61+
62+
## Inputs
63+
64+
| Name | Description | Type | Default | Required |
65+
|------|-------------|------|---------|:--------:|
66+
| <a name="input_aad_group_name"></a> [aad\_group\_name](#input\_aad\_group\_name) | Azure Active Directory Group for AVD users | `string` | n/a | yes |
67+
| <a name="input_ad_rg"></a> [ad\_rg](#input\_ad\_rg) | The resource group for AD VM | `string` | n/a | yes |
68+
| <a name="input_ad_vnet"></a> [ad\_vnet](#input\_ad\_vnet) | Name of domain controller vnet | `string` | n/a | yes |
69+
| <a name="input_avd_users"></a> [avd\_users](#input\_avd\_users) | AVD users | `list` | `[]` | no |
70+
| <a name="input_deploy_location"></a> [deploy\_location](#input\_deploy\_location) | The Azure Region in which all resources in this example should be created. | `string` | n/a | yes |
71+
| <a name="input_dns_servers"></a> [dns\_servers](#input\_dns\_servers) | Custom DNS configuration | `list(string)` | n/a | yes |
72+
| <a name="input_domain_name"></a> [domain\_name](#input\_domain\_name) | Name of the domain to join | `string` | n/a | yes |
73+
| <a name="input_domain_password"></a> [domain\_password](#input\_domain\_password) | Password of the user to authenticate with the domain | `string` | n/a | yes |
74+
| <a name="input_domain_user_upn"></a> [domain\_user\_upn](#input\_domain\_user\_upn) | Username for domain join (do not include domain name as this is appended) | `string` | n/a | yes |
75+
| <a name="input_hostpool"></a> [hostpool](#input\_hostpool) | Name of the Azure Virtual Desktop host pool | `string` | `"AVD-TF-HP"` | no |
76+
| <a name="input_local_admin_password"></a> [local\_admin\_password](#input\_local\_admin\_password) | local admin password | `any` | n/a | yes |
77+
| <a name="input_local_admin_username"></a> [local\_admin\_username](#input\_local\_admin\_username) | local admin username | `string` | n/a | yes |
78+
| <a name="input_ou_path"></a> [ou\_path](#input\_ou\_path) | n/a | `string` | `""` | no |
79+
| <a name="input_prefix"></a> [prefix](#input\_prefix) | Prefix of the name of the AVD machine(s) | `string` | n/a | yes |
80+
| <a name="input_rdsh_count"></a> [rdsh\_count](#input\_rdsh\_count) | Number of AVD machines to deploy | `number` | `2` | no |
81+
| <a name="input_rg_name"></a> [rg\_name](#input\_rg\_name) | Name of the Resource group in which to deploy these resources | `string` | `"AVD-TF"` | no |
82+
| <a name="input_shared"></a> [shared](#input\_shared) | Prefix of the name of the AVD machine(s) | `string` | n/a | yes |
83+
| <a name="input_subnet_range"></a> [subnet\_range](#input\_subnet\_range) | Address range for session host subnet | `list(string)` | n/a | yes |
84+
| <a name="input_vm_size"></a> [vm\_size](#input\_vm\_size) | Size of the machine to deploy | `string` | `"Standard_DS2_v2"` | no |
85+
| <a name="input_vnet_range"></a> [vnet\_range](#input\_vnet\_range) | Address range for deployment VNet | `list(string)` | n/a | yes |
86+
| <a name="input_workspace"></a> [workspace](#input\_workspace) | Name of the Azure Virtual Desktop workspace | `string` | `"AVD TF Workspace"` | no |
87+
88+
## Outputs
89+
90+
| Name | Description |
91+
|------|-------------|
92+
| <a name="output_aadgroupname"></a> [aadgroupname](#output\_aadgroupname) | Azure Active Directory Group for AVD users |
93+
| <a name="output_avdusers"></a> [avdusers](#output\_avdusers) | AVD users |
94+
| <a name="output_dnsservers"></a> [dnsservers](#output\_dnsservers) | Custom DNS configuration |
95+
| <a name="output_location"></a> [location](#output\_location) | The Azure region |
96+
| <a name="output_rdshcount"></a> [rdshcount](#output\_rdshcount) | The number of VMs created |
97+
| <a name="output_resource_group_name"></a> [resource\_group\_name](#output\_resource\_group\_name) | Name of the Resource group created |
98+
| <a name="output_storage_account_share"></a> [storage\_account\_share](#output\_storage\_account\_share) | Name of the Azure File Share created for FSLogix |
99+
| <a name="output_vnetrange"></a> [vnetrange](#output\_vnetrange) | Address range for deployment vnet |
100+
101+
<!--- END_TF_DOCS --->
102+

0 commit comments

Comments
 (0)