terraform-azurerm-avm-template

This is a template repo for Terraform Azure Verified Modules.

Things to do:

1. Set up a GitHub repo environment called test.
2. Configure environment protection rule to ensure that approval is required before deploying to this environment.
3. Create a user-assigned managed identity in your test subscription.
4. Create a role assignment for the managed identity on your test subscription, use the minimum required role.
5. Configure federated identity credentials on the user assigned managed identity. Use the GitHub environment.
6. Create the following environment secrets on the test environment:
   1. AZURE_CLIENT_ID
   2. AZURE_TENANT_ID
   3. AZURE_SUBSCRIPTION_ID
7. Search and update TODOs within the code and remove the TODO comments once complete.

Major version Zero (0.y.z) is for initial development. Anything MAY change at any time. A module SHOULD NOT be considered stable till at least it is major version one (1.0.0) or greater. Changes will always be via new versions being published and no changes will be made to existing published versions. For more details please go to https://semver.org/

Requirements

The following requirements are needed by this module:

• terraform (>= 1.3.0)

• azurerm (>= 3.71.0)

• random (>= 3.5.0)

Providers

The following providers are used by this module:

• azurerm (>= 3.71.0)

• random (>= 3.5.0)

Resources

The following resources are used by this module:

• azurerm_management_lock.this (resource)
• azurerm_resource_group_template_deployment.telemetry (resource)
• azurerm_role_assignment.this (resource)
• azurerm_service_plan.this (resource)
• random_id.telem (resource)
• azurerm_location.region (data source)
• azurerm_resource_group.parent (data source)

Required Inputs

The following input variables are required:

name

Description: The name of the this resource.

Type: string

os_type

Description: The operating system type of the service plan. Possible values are Windows, Linux or WindowsContainer.

Type: string

resource_group_name

Description: The resource group where the resources will be deployed.

Type: string

sku_name

Description: The SKU name of the service plan.

Type: string

Optional Inputs

The following input variables are optional (have default values):

app_service_environment_id

Description: Optional: The ID of the App Service Environment.

Type: string

Default: null

enable_telemetry

Description: This variable controls whether or not telemetry is enabled for the module.
For more information see https://aka.ms/avm/telemetryinfo.
If it is set to false, then no telemetry will be collected.

Type: bool

Default: true

location

Description: Azure region where the resource should be deployed. If null, the location will be inferred from the resource group location.

Type: string

Default: null

lock

Description: Controls the Resource Lock configuration for this resource. The following properties can be specified:

• kind - (Required) The type of lock. Possible values are \"CanNotDelete\" and \"ReadOnly\".
• name - (Optional) The name of the lock. If not specified, a name will be generated based on the kind value. Changing this forces the creation of a new resource.

Type:

object({
    kind = string
    name = optional(string, null)
  })

Default: null

maximum_elastic_worker_count

Description: The minimum number of workers to allocate for this App Service Plan.

Type: number

Default: null

per_site_scaling_enabled

Description: Should per site scaling be enabled for this App Service Plan.

Type: bool

Default: false

role_assignments

Description: A map of role assignments to create on the Key Vault. The map key is deliberately arbitrary to avoid issues where map keys maybe unknown at plan time.

• role_definition_id_or_name - The ID or name of the role definition to assign to the principal.
• principal_id - The ID of the principal to assign the role to.
• description - The description of the role assignment.
• skip_service_principal_aad_check - If set to true, skips the Azure Active Directory check for the service principal in the tenant. Defaults to false.
• condition - The condition which will be used to scope the role assignment.
• condition_version - The version of the condition syntax. Leave as null if you are not using a condition, if you are then valid values are '2.0'.

Note: only set skip_service_principal_aad_check to true if you are assigning a role to a service principal.

Type:

map(object({
    role_definition_id_or_name             = string
    principal_id                           = string
    description                            = optional(string, null)
    skip_service_principal_aad_check       = optional(bool, false)
    condition                              = optional(string, null)
    condition_version                      = optional(string, null)
    delegated_managed_identity_resource_id = optional(string, null)
  }))

Default: {}

tags

Description: (Optional) Tags of the resource.

Type: map(string)

Default: null

worker_count

Description: The number of workers to allocate for this App Service Plan.

Type: number

Default: null

zone_balancing_enabled

Description: Should zone balancing be enabled for this App Service Plan.

Type: bool

Default: true

Outputs

The following outputs are exported:

resource

Description: This is the full output for the resource.

Modules

No modules.

Data Collection

The software may collect information about you and your use of the software and send it to Microsoft. Microsoft may use this information to provide services and improve our products and services. You may turn off the telemetry as described in the repository. There are also some features in the software that may enable you and Microsoft to collect data from users of your applications. If you use these features, you must comply with applicable law, including providing appropriate notices to users of your applications together with a copy of Microsoft’s privacy statement. Our privacy statement is located at https://go.microsoft.com/fwlink/?LinkID=824704. You can learn more about data collection and use in the help documentation and our privacy statement. Your use of the software operates as your consent to these practices.