Skip to content

Azure/terraform-azurerm-avm-res-edge-site

Repository files navigation

terraform-azurerm-avm-res-edge-site

Module to deploy site manager for azure arc.

Requirements

The following requirements are needed by this module:

Resources

The following resources are used by this module:

Required Inputs

The following input variables are required:

Description: A resource name for the address.

Type: string

Description: The order country of the site.

Type: string

Description: Azure region where the resource should be deployed.

Type: string

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

Type: string

Description: A display name for the site.

Type: string

Description: A resource name for the site.

Type: string

Optional Inputs

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

Description: The city of the site.

Type: string

Default: ""

Description: The company name of the site.

Type: string

Default: ""

Description: The contact name of the site.

Type: string

Default: " "

Description: A map describing customer-managed keys to associate with the resource. This includes the following properties:

  • key_vault_resource_id - The resource ID of the Key Vault where the key is stored.
  • key_name - The name of the key.
  • key_version - (Optional) The version of the key. If not specified, the latest version is used.
  • user_assigned_identity - (Optional) An object representing a user-assigned identity with the following properties:
    • resource_id - The resource ID of the user-assigned identity.

Type:

object({
    key_vault_resource_id = string
    key_name              = string
    key_version           = optional(string, null)
    user_assigned_identity = optional(object({
      resource_id = string
    }), null)
  })

Default: null

Description: A list of email addresses for the site.

Type: list(string)

Default: []

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

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

Description: The mobile phone number of the site.

Type: string

Default: ""

Description: The phone number of the site.

Type: string

Default: ""

Description: The phone extension of the site.

Type: string

Default: ""

Description: The postal code of the site.

Type: string

Default: ""

Description: A map of role assignments to create on this resource. 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. 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)
    principal_type                         = optional(string, null)
  }))

Default: {}

Description: The state or province of the site.

Type: string

Default: ""

Description: The first line of the street address of the site.

Type: string

Default: ""

Description: The second line of the street address of the site.

Type: string

Default: ""

Description: The third line of the street address of the site.

Type: string

Default: ""

Description: (Optional) Tags of the resource.

Type: map(string)

Default: null

Description: The extended ZIP code of the site.

Type: string

Default: ""

Outputs

The following outputs are exported:

Description: This is the full output for the resource.

Description: This is the resource id for the site 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.