volocloud_tenancy_azure
Example Usage
data "volocloud_tenancy_azure" "example" {
account_id = "00000000-0000-0000-0000-000000000000"
tenancy_id = "00000000-0000-0000-0000-000000000000"
}
Schema
Required
account_id(String) Volocloud Account ID.tenancy_id(String) Volocloud Tenancy ID.
Read-Only
configuration(Attributes) Provides configuration required to setup the Tenancy. (see below for nested schema)credentials(Attributes) Provides credentials required to setup the Tenancy. (see below for nested schema)id(String) ID of the resource computed from the account_id and tenancy_id separated by : .name(String) Volocloud Tenancy Nameresources(Map of String) These are all the resources created in the tenancy.
Nested Schema for configuration
Required:
billing(Attributes) Provides the details required for Microsoft Azure billing. Must provide only one of ea, existing, mca, mpa attributes. (see below for nested schema)regions(Attributes) Defines which regions to deploy into. (see below for nested schema)
Optional:
budgets(Attributes) Provides a nested List of nested budget object to associate with a Management Group. (see below for nested schema)
Read-Only:
abbreviation(String) This abbreviation will be used to uniquily identify resources created. Only applies to resources that require Azure global uniqueness and to Management Groups.dns_domain(String) DNS domain associated with this tenancy.environments(List of String) List of environments deployed part of the tenancy.subscriptions(Attributes) Azure Core Subscriptions: connectivity, identity and management configuration. (see below for nested schema)tags(Map of String) Key-value map of resource tags for all the tenancy resources.
Nested Schema for configuration.billing
Required:
account_type(String) Microsoft Azure Billing Account type. Possible values areea,mcaormpa.
Optional:
ea(Attributes) Provides required billing information to create subscriptions for a Microsoft Enterprise Agreement billing account. Conflicts with existing, mca, mpa. (see below for nested schema)existing(Attributes) Provides existing tenancy core subscription ids. Conflicts with ea, mca, mpa. (see below for nested schema)mca(Attributes) Provides required billing information to create subscriptions for an Microsoft Customer Agreement billing account. Conflicts with existing, ea, mpa. (see below for nested schema)mpa(Attributes) All the CSP Partners that we support to create subscriptions programatically. Conflicts with ea, existing, mca attributes. (see below for nested schema)
Nested Schema for configuration.billing.ea
Required:
account_id(String) Microsoft Enterprise Agreement billing account id.enrollment_id(String) Microsoft Enterprise Agreement billing enrollment id.
Nested Schema for configuration.billing.existing
Required:
connectivity_subscription_id(String) Existing subscription id to be used for connectivity.identity_subscription_id(String) Existing subscription id to be used for identity.management_subscription_id(String) Existing subscription id to be used for management.security_subscription_id(String) Existing subscription id to be used for security.
Nested Schema for configuration.billing.mca
Required:
account_id(String) Microsoft Customer Agreement billing account id.invoice_id(String) Microsoft Customer Agreement billing invoice id.profile_id(String) Microsoft Customer Agreement billing profile id.
Nested Schema for configuration.billing.mpa
Optional:
rhipe(Attributes) (see below for nested schema)
Nested Schema for configuration.billing.mpa.rhipe
Optional:
description(String) Rhipe Description.
Nested Schema for configuration.regions
Required:
home(Attributes) Home geography containing a pair of primary/secondary regions. (see below for nested schema)
Optional:
other(Attributes List) A list of Non-Home geographies containing a pair of primary/secondary regions in each geography. (see below for nested schema)
Nested Schema for configuration.regions.home
Required:
primary(Attributes) Primary Aws Region details. (see below for nested schema)
Optional:
secondary(Attributes) Secondary Aws Region details. (see below for nested schema)
Nested Schema for configuration.regions.home.primary
Required:
location(String) The Azure location of the region. Possible values are[australiacentral australiacentral2 australiaeast australiasoutheast austriaeast brazilsouth brazilsoutheast canadacentral canadaeast centralindia centralus chilecentral chinaeast chinaeast2 chinanorth chinanorth2 eastasia eastus eastus2 francecentral francesouth germanynorth germanywestcentral indonesiacentral israelcentral italynorth japaneast japanwest koreacentral koreasouth malaysiawest mexicocentral newzealandnorth northcentralus northeurope norwayeast norwaywest polandcentral qatarcentral southafricanorth southafricawest southcentralus southeastasia southindia spaincentral swedencentral switzerlandnorth switzerlandwest uaecentral uaenorth uksouth ukwest usdodcentral usdodeast usgovarizona usgovtexas usgovvirginia westcentralus westeurope westindia westus westus2 westus3].network(Attributes) This information is used to deploy a network on top of the landing zone. A lot of other services depend on this. (see below for nested schema)region(String) The Azure region code of the location. Possible values are[aecc aenn apee apse atee auc2 aucc auee ause brse brss cacc caee chnn chww clee cne2 cnee cnn2 cnnn decw denn escc eunn euww frcc frss gbss gbww idcc ilcc incc inss inww itnn jpee jpww krcc krss mxcc myww noee noww nznn plcc qacc secc uscc uscn uscs uscw usdc usde use2 usee usgc usge usgw usw2 usw3 usww zann zaww].
Nested Schema for configuration.regions.home.primary.network
Required:
enabled(Boolean) If enabled, it will deploy a network on top of the landing zone.
Optional:
ip_schema(Attributes) (see below for nested schema)
Nested Schema for configuration.regions.home.primary.network.ip_schema
Optional:
address(String) The base IP Network for the entire region (e.g. x.x.x.x). It will be used to perform IPAM for the tenancy and it's tenancy accounts. CANNOT be changed after creation without destroying everything running on top of the network. Defaults to172.16.0.0.environments(Attributes) The Network CIDR configuration for environments. (see below for nested schema)mask(Number) The base IP Network Mask for the entire region (e.g.16). It will be used to perform IPAM for the tenancy and it's tenancy accounts. It MUST be between8and18. CANNOT be changed after creation without destroying everything running on top of the network. Defaults to16
Nested Schema for configuration.regions.home.primary.network.ip_schema.environments
Optional:
core(Attributes) The IP CIDR for environment. (see below for nested schema)dev(Attributes) The IP CIDR for environment. (see below for nested schema)prod(Attributes) The IP CIDR for environment. (see below for nested schema)qa(Attributes) The IP CIDR for environment. (see below for nested schema)test(Attributes) The IP CIDR for environment. (see below for nested schema)
Nested Schema for configuration.regions.home.primary.network.ip_schema.environments.core
Optional:
address(String) The base IP Network for the environment. CANNOT be changed after creation without destroying everything running on top of the network.mask(Number) The base IP Network Mask for the environment. It MUST be between10and20. CANNOT be changed after creation without destroying everything running on top of the network.
Nested Schema for configuration.regions.home.primary.network.ip_schema.environments.dev
Optional:
address(String) The base IP Network for the environment. CANNOT be changed after creation without destroying everything running on top of the network.mask(Number) The base IP Network Mask for the environment. It MUST be between10and20. CANNOT be changed after creation without destroying everything running on top of the network.
Nested Schema for configuration.regions.home.primary.network.ip_schema.environments.prod
Optional:
address(String) The base IP Network for the environment. CANNOT be changed after creation without destroying everything running on top of the network.mask(Number) The base IP Network Mask for the environment. It MUST be between10and20. CANNOT be changed after creation without destroying everything running on top of the network.
Nested Schema for configuration.regions.home.primary.network.ip_schema.environments.qa
Optional:
address(String) The base IP Network for the environment. CANNOT be changed after creation without destroying everything running on top of the network.mask(Number) The base IP Network Mask for the environment. It MUST be between10and20. CANNOT be changed after creation without destroying everything running on top of the network.
Nested Schema for configuration.regions.home.primary.network.ip_schema.environments.test
Optional:
address(String) The base IP Network for the environment. CANNOT be changed after creation without destroying everything running on top of the network.mask(Number) The base IP Network Mask for the environment. It MUST be between10and20. CANNOT be changed after creation without destroying everything running on top of the network.
Nested Schema for configuration.regions.home.secondary
Required:
location(String) The Azure location of the region. Possible values are[australiacentral australiacentral2 australiaeast australiasoutheast austriaeast brazilsouth brazilsoutheast canadacentral canadaeast centralindia centralus chilecentral chinaeast chinaeast2 chinanorth chinanorth2 eastasia eastus eastus2 francecentral francesouth germanynorth germanywestcentral indonesiacentral israelcentral italynorth japaneast japanwest koreacentral koreasouth malaysiawest mexicocentral newzealandnorth northcentralus northeurope norwayeast norwaywest polandcentral qatarcentral southafricanorth southafricawest southcentralus southeastasia southindia spaincentral swedencentral switzerlandnorth switzerlandwest uaecentral uaenorth uksouth ukwest usdodcentral usdodeast usgovarizona usgovtexas usgovvirginia westcentralus westeurope westindia westus westus2 westus3].network(Attributes) This information is used to deploy a network on top of the landing zone. A lot of other services depend on this. (see below for nested schema)region(String) The Azure region code of the location. Possible values are[aecc aenn apee apse atee auc2 aucc auee ause brse brss cacc caee chnn chww clee cne2 cnee cnn2 cnnn decw denn escc eunn euww frcc frss gbss gbww idcc ilcc incc inss inww itnn jpee jpww krcc krss mxcc myww noee noww nznn plcc qacc secc uscc uscn uscs uscw usdc usde use2 usee usgc usge usgw usw2 usw3 usww zann zaww].
Nested Schema for configuration.regions.home.secondary.network
Required:
enabled(Boolean) If enabled, it will deploy a network on top of the landing zone.
Optional:
ip_schema(Attributes) (see below for nested schema)
Nested Schema for configuration.regions.home.secondary.network.ip_schema
Optional:
address(String) The base IP Network for the entire region (e.g. x.x.x.x). It will be used to perform IPAM for the tenancy and it's tenancy accounts. CANNOT be changed after creation without destroying everything running on top of the network. Defaults to172.16.0.0.environments(Attributes) The Network CIDR configuration for environments. (see below for nested schema)mask(Number) The base IP Network Mask for the entire region (e.g.16). It will be used to perform IPAM for the tenancy and it's tenancy accounts. It MUST be between8and18. CANNOT be changed after creation without destroying everything running on top of the network. Defaults to16
Nested Schema for configuration.regions.home.secondary.network.ip_schema.environments
Optional:
core(Attributes) The IP CIDR for environment. (see below for nested schema)dev(Attributes) The IP CIDR for environment. (see below for nested schema)prod(Attributes) The IP CIDR for environment. (see below for nested schema)qa(Attributes) The IP CIDR for environment. (see below for nested schema)test(Attributes) The IP CIDR for environment. (see below for nested schema)
Nested Schema for configuration.regions.home.secondary.network.ip_schema.environments.core
Optional:
address(String) The base IP Network for the environment. CANNOT be changed after creation without destroying everything running on top of the network.mask(Number) The base IP Network Mask for the environment. It MUST be between10and20. CANNOT be changed after creation without destroying everything running on top of the network.
Nested Schema for configuration.regions.home.secondary.network.ip_schema.environments.dev
Optional:
address(String) The base IP Network for the environment. CANNOT be changed after creation without destroying everything running on top of the network.mask(Number) The base IP Network Mask for the environment. It MUST be between10and20. CANNOT be changed after creation without destroying everything running on top of the network.
Nested Schema for configuration.regions.home.secondary.network.ip_schema.environments.prod
Optional:
address(String) The base IP Network for the environment. CANNOT be changed after creation without destroying everything running on top of the network.mask(Number) The base IP Network Mask for the environment. It MUST be between10and20. CANNOT be changed after creation without destroying everything running on top of the network.
Nested Schema for configuration.regions.home.secondary.network.ip_schema.environments.qa
Optional:
address(String) The base IP Network for the environment. CANNOT be changed after creation without destroying everything running on top of the network.mask(Number) The base IP Network Mask for the environment. It MUST be between10and20. CANNOT be changed after creation without destroying everything running on top of the network.
Nested Schema for configuration.regions.home.secondary.network.ip_schema.environments.test
Optional:
address(String) The base IP Network for the environment. CANNOT be changed after creation without destroying everything running on top of the network.mask(Number) The base IP Network Mask for the environment. It MUST be between10and20. CANNOT be changed after creation without destroying everything running on top of the network.
Nested Schema for configuration.regions.other
Required:
primary(Attributes) Primary Aws Region details. (see below for nested schema)
Optional:
secondary(Attributes) Secondary Aws Region details. (see below for nested schema)
Nested Schema for configuration.regions.other.primary
Required:
location(String) The Azure location of the region. Possible values are[australiacentral australiacentral2 australiaeast australiasoutheast austriaeast brazilsouth brazilsoutheast canadacentral canadaeast centralindia centralus chilecentral chinaeast chinaeast2 chinanorth chinanorth2 eastasia eastus eastus2 francecentral francesouth germanynorth germanywestcentral indonesiacentral israelcentral italynorth japaneast japanwest koreacentral koreasouth malaysiawest mexicocentral newzealandnorth northcentralus northeurope norwayeast norwaywest polandcentral qatarcentral southafricanorth southafricawest southcentralus southeastasia southindia spaincentral swedencentral switzerlandnorth switzerlandwest uaecentral uaenorth uksouth ukwest usdodcentral usdodeast usgovarizona usgovtexas usgovvirginia westcentralus westeurope westindia westus westus2 westus3].network(Attributes) This information is used to deploy a network on top of the landing zone. A lot of other services depend on this. (see below for nested schema)region(String) The Azure region code of the location. Possible values are[aecc aenn apee apse atee auc2 aucc auee ause brse brss cacc caee chnn chww clee cne2 cnee cnn2 cnnn decw denn escc eunn euww frcc frss gbss gbww idcc ilcc incc inss inww itnn jpee jpww krcc krss mxcc myww noee noww nznn plcc qacc secc uscc uscn uscs uscw usdc usde use2 usee usgc usge usgw usw2 usw3 usww zann zaww].
Nested Schema for configuration.regions.other.primary.network
Required:
enabled(Boolean) If enabled, it will deploy a network on top of the landing zone.
Optional:
ip_schema(Attributes) (see below for nested schema)
Nested Schema for configuration.regions.other.primary.network.ip_schema
Optional:
address(String) The base IP Network for the entire region (e.g. x.x.x.x). It will be used to perform IPAM for the tenancy and it's tenancy accounts. CANNOT be changed after creation without destroying everything running on top of the network. Defaults to172.16.0.0.environments(Attributes) The Network CIDR configuration for environments. (see below for nested schema)mask(Number) The base IP Network Mask for the entire region (e.g.16). It will be used to perform IPAM for the tenancy and it's tenancy accounts. It MUST be between8and18. CANNOT be changed after creation without destroying everything running on top of the network. Defaults to16
Nested Schema for configuration.regions.other.primary.network.ip_schema.environments
Optional:
core(Attributes) The IP CIDR for environment. (see below for nested schema)dev(Attributes) The IP CIDR for environment. (see below for nested schema)prod(Attributes) The IP CIDR for environment. (see below for nested schema)qa(Attributes) The IP CIDR for environment. (see below for nested schema)test(Attributes) The IP CIDR for environment. (see below for nested schema)
Nested Schema for configuration.regions.other.primary.network.ip_schema.environments.core
Optional:
address(String) The base IP Network for the environment. CANNOT be changed after creation without destroying everything running on top of the network.mask(Number) The base IP Network Mask for the environment. It MUST be between10and20. CANNOT be changed after creation without destroying everything running on top of the network.
Nested Schema for configuration.regions.other.primary.network.ip_schema.environments.dev
Optional:
address(String) The base IP Network for the environment. CANNOT be changed after creation without destroying everything running on top of the network.mask(Number) The base IP Network Mask for the environment. It MUST be between10and20. CANNOT be changed after creation without destroying everything running on top of the network.
Nested Schema for configuration.regions.other.primary.network.ip_schema.environments.prod
Optional:
address(String) The base IP Network for the environment. CANNOT be changed after creation without destroying everything running on top of the network.mask(Number) The base IP Network Mask for the environment. It MUST be between10and20. CANNOT be changed after creation without destroying everything running on top of the network.
Nested Schema for configuration.regions.other.primary.network.ip_schema.environments.qa
Optional:
address(String) The base IP Network for the environment. CANNOT be changed after creation without destroying everything running on top of the network.mask(Number) The base IP Network Mask for the environment. It MUST be between10and20. CANNOT be changed after creation without destroying everything running on top of the network.
Nested Schema for configuration.regions.other.primary.network.ip_schema.environments.test
Optional:
address(String) The base IP Network for the environment. CANNOT be changed after creation without destroying everything running on top of the network.mask(Number) The base IP Network Mask for the environment. It MUST be between10and20. CANNOT be changed after creation without destroying everything running on top of the network.
Nested Schema for configuration.regions.other.secondary
Required:
location(String) The Azure location of the region. Possible values are[australiacentral australiacentral2 australiaeast australiasoutheast austriaeast brazilsouth brazilsoutheast canadacentral canadaeast centralindia centralus chilecentral chinaeast chinaeast2 chinanorth chinanorth2 eastasia eastus eastus2 francecentral francesouth germanynorth germanywestcentral indonesiacentral israelcentral italynorth japaneast japanwest koreacentral koreasouth malaysiawest mexicocentral newzealandnorth northcentralus northeurope norwayeast norwaywest polandcentral qatarcentral southafricanorth southafricawest southcentralus southeastasia southindia spaincentral swedencentral switzerlandnorth switzerlandwest uaecentral uaenorth uksouth ukwest usdodcentral usdodeast usgovarizona usgovtexas usgovvirginia westcentralus westeurope westindia westus westus2 westus3].network(Attributes) This information is used to deploy a network on top of the landing zone. A lot of other services depend on this. (see below for nested schema)region(String) The Azure region code of the location. Possible values are[aecc aenn apee apse atee auc2 aucc auee ause brse brss cacc caee chnn chww clee cne2 cnee cnn2 cnnn decw denn escc eunn euww frcc frss gbss gbww idcc ilcc incc inss inww itnn jpee jpww krcc krss mxcc myww noee noww nznn plcc qacc secc uscc uscn uscs uscw usdc usde use2 usee usgc usge usgw usw2 usw3 usww zann zaww].
Nested Schema for configuration.regions.other.secondary.network
Required:
enabled(Boolean) If enabled, it will deploy a network on top of the landing zone.
Optional:
ip_schema(Attributes) (see below for nested schema)
Nested Schema for configuration.regions.other.secondary.network.ip_schema
Optional:
address(String) The base IP Network for the entire region (e.g. x.x.x.x). It will be used to perform IPAM for the tenancy and it's tenancy accounts. CANNOT be changed after creation without destroying everything running on top of the network. Defaults to172.16.0.0.environments(Attributes) The Network CIDR configuration for environments. (see below for nested schema)mask(Number) The base IP Network Mask for the entire region (e.g.16). It will be used to perform IPAM for the tenancy and it's tenancy accounts. It MUST be between8and18. CANNOT be changed after creation without destroying everything running on top of the network. Defaults to16
Nested Schema for configuration.regions.other.secondary.network.ip_schema.environments
Optional:
core(Attributes) The IP CIDR for environment. (see below for nested schema)dev(Attributes) The IP CIDR for environment. (see below for nested schema)prod(Attributes) The IP CIDR for environment. (see below for nested schema)qa(Attributes) The IP CIDR for environment. (see below for nested schema)test(Attributes) The IP CIDR for environment. (see below for nested schema)
Nested Schema for configuration.regions.other.secondary.network.ip_schema.environments.core
Optional:
address(String) The base IP Network for the environment. CANNOT be changed after creation without destroying everything running on top of the network.mask(Number) The base IP Network Mask for the environment. It MUST be between10and20. CANNOT be changed after creation without destroying everything running on top of the network.
Nested Schema for configuration.regions.other.secondary.network.ip_schema.environments.dev
Optional:
address(String) The base IP Network for the environment. CANNOT be changed after creation without destroying everything running on top of the network.mask(Number) The base IP Network Mask for the environment. It MUST be between10and20. CANNOT be changed after creation without destroying everything running on top of the network.
Nested Schema for configuration.regions.other.secondary.network.ip_schema.environments.prod
Optional:
address(String) The base IP Network for the environment. CANNOT be changed after creation without destroying everything running on top of the network.mask(Number) The base IP Network Mask for the environment. It MUST be between10and20. CANNOT be changed after creation without destroying everything running on top of the network.
Nested Schema for configuration.regions.other.secondary.network.ip_schema.environments.qa
Optional:
address(String) The base IP Network for the environment. CANNOT be changed after creation without destroying everything running on top of the network.mask(Number) The base IP Network Mask for the environment. It MUST be between10and20. CANNOT be changed after creation without destroying everything running on top of the network.
Nested Schema for configuration.regions.other.secondary.network.ip_schema.environments.test
Optional:
address(String) The base IP Network for the environment. CANNOT be changed after creation without destroying everything running on top of the network.mask(Number) The base IP Network Mask for the environment. It MUST be between10and20. CANNOT be changed after creation without destroying everything running on top of the network.
Nested Schema for configuration.budgets
Optional:
landingzone_nonprod(Attributes List) Provides a list of budget objects. (see below for nested schema)landingzone_prod(Attributes List) Provides a list of budget objects. (see below for nested schema)platform(Attributes List) Provides a list of budget objects. (see below for nested schema)root(Attributes List) Provides a list of budget objects. (see below for nested schema)
Nested Schema for configuration.budgets.landingzone_nonprod
Required:
amount(Number) The total amount of cost to track with the budget.notifications(Attributes List) One or more notification objects. (see below for nested schema)
Optional:
time_grain(String) The time covered by a budget. Tracking of the amount will be reset based on the time grain. Possible values areBillingAnnual,BillingMonth,BillingQuarter,Annually,MonthlyandQuarterly. Defaults toMonthly. Changing this forces a new resource to be created.
Nested Schema for configuration.budgets.landingzone_nonprod.notifications
Required:
contact_emails(List of String) Specifies a list of email addresses to send the budget notification to when the threshold is exceeded.threshold(Number) Threshold value associated with a notification. Notification is sent when the cost exceeded the threshold. It is always percent and has to be between 0 and 1000.
Optional:
operator(String) The comparison operator for the notification. Possible values areEqualTo,GreaterThan, orGreaterThanOrEqualTo. Defaults toEqualTo.threshold_type(String) The type of threshold for the notification. This determines whether the notification is triggered by forecasted costs or actual costs. The allowed values are Actual and Forecasted. Default is Actual. Changing this forces a new resource to be created.
Nested Schema for configuration.budgets.landingzone_prod
Required:
amount(Number) The total amount of cost to track with the budget.notifications(Attributes List) One or more notification objects. (see below for nested schema)
Optional:
time_grain(String) The time covered by a budget. Tracking of the amount will be reset based on the time grain. Possible values areBillingAnnual,BillingMonth,BillingQuarter,Annually,MonthlyandQuarterly. Defaults toMonthly. Changing this forces a new resource to be created.
Nested Schema for configuration.budgets.landingzone_prod.notifications
Required:
contact_emails(List of String) Specifies a list of email addresses to send the budget notification to when the threshold is exceeded.threshold(Number) Threshold value associated with a notification. Notification is sent when the cost exceeded the threshold. It is always percent and has to be between 0 and 1000.
Optional:
operator(String) The comparison operator for the notification. Possible values areEqualTo,GreaterThan, orGreaterThanOrEqualTo. Defaults toEqualTo.threshold_type(String) The type of threshold for the notification. This determines whether the notification is triggered by forecasted costs or actual costs. The allowed values are Actual and Forecasted. Default is Actual. Changing this forces a new resource to be created.
Nested Schema for configuration.budgets.platform
Required:
amount(Number) The total amount of cost to track with the budget.notifications(Attributes List) One or more notification objects. (see below for nested schema)
Optional:
time_grain(String) The time covered by a budget. Tracking of the amount will be reset based on the time grain. Possible values areBillingAnnual,BillingMonth,BillingQuarter,Annually,MonthlyandQuarterly. Defaults toMonthly. Changing this forces a new resource to be created.
Nested Schema for configuration.budgets.platform.notifications
Required:
contact_emails(List of String) Specifies a list of email addresses to send the budget notification to when the threshold is exceeded.threshold(Number) Threshold value associated with a notification. Notification is sent when the cost exceeded the threshold. It is always percent and has to be between 0 and 1000.
Optional:
operator(String) The comparison operator for the notification. Possible values areEqualTo,GreaterThan, orGreaterThanOrEqualTo. Defaults toEqualTo.threshold_type(String) The type of threshold for the notification. This determines whether the notification is triggered by forecasted costs or actual costs. The allowed values are Actual and Forecasted. Default is Actual. Changing this forces a new resource to be created.
Nested Schema for configuration.budgets.root
Required:
amount(Number) The total amount of cost to track with the budget.notifications(Attributes List) One or more notification objects. (see below for nested schema)
Optional:
time_grain(String) The time covered by a budget. Tracking of the amount will be reset based on the time grain. Possible values areBillingAnnual,BillingMonth,BillingQuarter,Annually,MonthlyandQuarterly. Defaults toMonthly. Changing this forces a new resource to be created.
Nested Schema for configuration.budgets.root.notifications
Required:
contact_emails(List of String) Specifies a list of email addresses to send the budget notification to when the threshold is exceeded.threshold(Number) Threshold value associated with a notification. Notification is sent when the cost exceeded the threshold. It is always percent and has to be between 0 and 1000.
Optional:
operator(String) The comparison operator for the notification. Possible values areEqualTo,GreaterThan, orGreaterThanOrEqualTo. Defaults toEqualTo.threshold_type(String) The type of threshold for the notification. This determines whether the notification is triggered by forecasted costs or actual costs. The allowed values are Actual and Forecasted. Default is Actual. Changing this forces a new resource to be created.
Nested Schema for configuration.subscriptions
Required:
connectivity(Attributes) Provides details for configuring connectivity resources. (see below for nested schema)identity(Attributes) Provides details for configuring identity resources. (see below for nested schema)management(Attributes) Provides details for configuring management resources. (see below for nested schema)
Nested Schema for configuration.subscriptions.connectivity
Required:
abbreviation(String) This abbreviation will be used to uniquily identify resources created in this subscription. Only applies to resources that require Azure global uniqueness.
Optional:
azure_bastion(Attributes) Azure Bastion configuration details. (see below for nested schema)backups(Attributes) Configuration settings for backups in this subscription. Defaults to {"recovery_services_vault":{"backup_policies":{"file_share":[{"frequency":{"daily":{"time":"23:00"},"hourly":},"name":"daily","retention":{"daily":{"count":33},"monthly": ,"weekly": ,"yearly": },"timezone":"UTC"},{"frequency":{"daily":{"time":"23:00"},"hourly": },"name":"monthly","retention":{"daily":{"count":33},"monthly":{"count":13,"days": ,"include_last_days": ,"weekdays":["Sunday"],"weeks":["Last"]},"weekly":{"count":13,"weekdays":["Saturday"]},"yearly": },"timezone":"UTC"},{"frequency":{"daily":{"time":"23:00"},"hourly": },"name":"weekly","retention":{"daily":{"count":33},"monthly": ,"weekly":{"count":13,"weekdays":["Saturday"]},"yearly": },"timezone":"UTC"},{"frequency":{"daily":{"time":"23:00"},"hourly": },"name":"yearly","retention":{"daily":{"count":33},"monthly":{"count":13,"days": ,"include_last_days": ,"weekdays":["Sunday"],"weeks":["Last"]},"weekly":{"count":13,"weekdays":["Saturday"]},"yearly":{"count":7,"days": ,"include_last_days": ,"months":["January"],"weekdays":["Monday"],"weeks":["First"]}},"timezone":"UTC"}],"vm":[{"frequency":{"daily":{"time":"23:00"},"hourly": ,"weekly": },"name":"daily","policy_type":{"v1": ,"v2":{"instant_restore_retention_days":7}},"retention":{"daily":{"count":33},"monthly": ,"weekly": ,"yearly": },"tiering_policy": ,"timezone":"UTC"},{"frequency":{"daily":{"time":"23:00"},"hourly": ,"weekly": },"name":"monthly","policy_type":{"v1": ,"v2":{"instant_restore_retention_days":7}},"retention":{"daily":{"count":33},"monthly":{"count":13,"days": ,"include_last_days": ,"weekdays":["Sunday"],"weeks":["Last"]},"weekly":{"count":5,"weekdays":["Saturday"]},"yearly": },"tiering_policy": ,"timezone":"UTC"},{"frequency":{"daily":{"time":"23:00"},"hourly": ,"weekly": },"name":"weekly","policy_type":{"v1": ,"v2":{"instant_restore_retention_days":7}},"retention":{"daily":{"count":33},"monthly": ,"weekly":{"count":5,"weekdays":["Saturday"]},"yearly": },"tiering_policy": ,"timezone":"UTC"},{"frequency":{"daily":{"time":"23:00"},"hourly": ,"weekly": },"name":"yearly","policy_type":{"v1": ,"v2":{"instant_restore_retention_days":7}},"retention":{"daily":{"count":33},"monthly":{"count":13,"days": ,"include_last_days": ,"weekdays":["Sunday"],"weeks":["Last"]},"weekly":{"count":5,"weekdays":["Saturday"]},"yearly":{"count":7,"days": ,"include_last_days": ,"months":["January"],"weekdays":["Monday"],"weeks":["First"]}},"tiering_policy": ,"timezone":"UTC"}]},"encryption":{"enabled":true,"infrastructure_encryption":false},"immutability": ,"monitoring":{"alerts_for_all_job_failures":true},"sku":"Standard","soft_delete":true,"storage_mode_type":"GeoRedundant","tags": }} (see below for nested schema) budgets(Attributes List) Provides a list of budget objects. (see below for nested schema)ddos_protection_plan(Attributes) Azure DDOS Protection Plan configuration. If not provides, DDOS Protection Plan will not be enabled. (see below for nested schema)dns_resolver(Attributes) Azure Private DNS Resolver configuration. (see below for nested schema)dns_zones(Attributes) Azure DNS Zones for public and private DNS object. (see below for nested schema)hub_networks(Attributes) Hub and Spoke setup. Conflicts with vwan_hub_networks. (see below for nested schema)keyvault(Attributes) Azure KeyVault configuration details. (see below for nested schema)resource_groups_lock(Attributes) Configures Azure Delete Lock at Resource Groups level. (see below for nested schema)vwan_hub_networks(Attributes) VWAN setup. Conflicts with hub_networks. (see below for nested schema)
Nested Schema for configuration.subscriptions.connectivity.azure_bastion
Optional:
copy_paste(Boolean) Is Copy/Paste feature enabled for the Bastion Host. Defaults to true.enabled(Boolean) Is Azure Bastion enabled? Defaults to true.file_copy(Boolean) Is File Copy feature enabled for the Bastion Host. Defaults to false.sku(String) The SKU of the Bastion Host. Accepted values are Basic and Standard. Defaults to Basic.tunneling(Boolean) Is Tunneling feature enabled for the Bastion Host. Defaults to false.
Nested Schema for configuration.subscriptions.connectivity.backups
Optional:
recovery_services_vault(Attributes) Configuration settings for Recovery Services Vault in this subscription. Defaults to{"backup_policies":{"file_share":[{"frequency":{"daily":{"time":"23:00"},"hourly":<null>},"name":"daily","retention":{"daily":{"count":33},"monthly":<null>,"weekly":<null>,"yearly":<null>},"timezone":"UTC"},{"frequency":{"daily":{"time":"23:00"},"hourly":<null>},"name":"monthly","retention":{"daily":{"count":33},"monthly":{"count":13,"days":<null>,"include_last_days":<null>,"weekdays":["Sunday"],"weeks":["Last"]},"weekly":{"count":13,"weekdays":["Saturday"]},"yearly":<null>},"timezone":"UTC"},{"frequency":{"daily":{"time":"23:00"},"hourly":<null>},"name":"weekly","retention":{"daily":{"count":33},"monthly":<null>,"weekly":{"count":13,"weekdays":["Saturday"]},"yearly":<null>},"timezone":"UTC"},{"frequency":{"daily":{"time":"23:00"},"hourly":<null>},"name":"yearly","retention":{"daily":{"count":33},"monthly":{"count":13,"days":<null>,"include_last_days":<null>,"weekdays":["Sunday"],"weeks":["Last"]},"weekly":{"count":13,"weekdays":["Saturday"]},"yearly":{"count":7,"days":<null>,"include_last_days":<null>,"months":["January"],"weekdays":["Monday"],"weeks":["First"]}},"timezone":"UTC"}],"vm":[{"frequency":{"daily":{"time":"23:00"},"hourly":<null>,"weekly":<null>},"name":"daily","policy_type":{"v1":<null>,"v2":{"instant_restore_retention_days":7}},"retention":{"daily":{"count":33},"monthly":<null>,"weekly":<null>,"yearly":<null>},"tiering_policy":<null>,"timezone":"UTC"},{"frequency":{"daily":{"time":"23:00"},"hourly":<null>,"weekly":<null>},"name":"monthly","policy_type":{"v1":<null>,"v2":{"instant_restore_retention_days":7}},"retention":{"daily":{"count":33},"monthly":{"count":13,"days":<null>,"include_last_days":<null>,"weekdays":["Sunday"],"weeks":["Last"]},"weekly":{"count":5,"weekdays":["Saturday"]},"yearly":<null>},"tiering_policy":<null>,"timezone":"UTC"},{"frequency":{"daily":{"time":"23:00"},"hourly":<null>,"weekly":<null>},"name":"weekly","policy_type":{"v1":<null>,"v2":{"instant_restore_retention_days":7}},"retention":{"daily":{"count":33},"monthly":<null>,"weekly":{"count":5,"weekdays":["Saturday"]},"yearly":<null>},"tiering_policy":<null>,"timezone":"UTC"},{"frequency":{"daily":{"time":"23:00"},"hourly":<null>,"weekly":<null>},"name":"yearly","policy_type":{"v1":<null>,"v2":{"instant_restore_retention_days":7}},"retention":{"daily":{"count":33},"monthly":{"count":13,"days":<null>,"include_last_days":<null>,"weekdays":["Sunday"],"weeks":["Last"]},"weekly":{"count":5,"weekdays":["Saturday"]},"yearly":{"count":7,"days":<null>,"include_last_days":<null>,"months":["January"],"weekdays":["Monday"],"weeks":["First"]}},"tiering_policy":<null>,"timezone":"UTC"}]},"encryption":{"enabled":true,"infrastructure_encryption":false},"immutability":<null>,"monitoring":{"alerts_for_all_job_failures":true},"sku":"Standard","soft_delete":true,"storage_mode_type":"GeoRedundant","tags":<null>}. (see below for nested schema)
Nested Schema for configuration.subscriptions.connectivity.backups.recovery_services_vault
Optional:
backup_policies(Attributes) Backup policies to be created in this Recovery Services Vault. Defaults to{"file_share":[{"frequency":{"daily":{"time":"23:00"},"hourly":<null>},"name":"daily","retention":{"daily":{"count":33},"monthly":<null>,"weekly":<null>,"yearly":<null>},"timezone":"UTC"},{"frequency":{"daily":{"time":"23:00"},"hourly":<null>},"name":"monthly","retention":{"daily":{"count":33},"monthly":{"count":13,"days":<null>,"include_last_days":<null>,"weekdays":["Sunday"],"weeks":["Last"]},"weekly":{"count":13,"weekdays":["Saturday"]},"yearly":<null>},"timezone":"UTC"},{"frequency":{"daily":{"time":"23:00"},"hourly":<null>},"name":"weekly","retention":{"daily":{"count":33},"monthly":<null>,"weekly":{"count":13,"weekdays":["Saturday"]},"yearly":<null>},"timezone":"UTC"},{"frequency":{"daily":{"time":"23:00"},"hourly":<null>},"name":"yearly","retention":{"daily":{"count":33},"monthly":{"count":13,"days":<null>,"include_last_days":<null>,"weekdays":["Sunday"],"weeks":["Last"]},"weekly":{"count":13,"weekdays":["Saturday"]},"yearly":{"count":7,"days":<null>,"include_last_days":<null>,"months":["January"],"weekdays":["Monday"],"weeks":["First"]}},"timezone":"UTC"}],"vm":[{"frequency":{"daily":{"time":"23:00"},"hourly":<null>,"weekly":<null>},"name":"daily","policy_type":{"v1":<null>,"v2":{"instant_restore_retention_days":7}},"retention":{"daily":{"count":33},"monthly":<null>,"weekly":<null>,"yearly":<null>},"tiering_policy":<null>,"timezone":"UTC"},{"frequency":{"daily":{"time":"23:00"},"hourly":<null>,"weekly":<null>},"name":"monthly","policy_type":{"v1":<null>,"v2":{"instant_restore_retention_days":7}},"retention":{"daily":{"count":33},"monthly":{"count":13,"days":<null>,"include_last_days":<null>,"weekdays":["Sunday"],"weeks":["Last"]},"weekly":{"count":5,"weekdays":["Saturday"]},"yearly":<null>},"tiering_policy":<null>,"timezone":"UTC"},{"frequency":{"daily":{"time":"23:00"},"hourly":<null>,"weekly":<null>},"name":"weekly","policy_type":{"v1":<null>,"v2":{"instant_restore_retention_days":7}},"retention":{"daily":{"count":33},"monthly":<null>,"weekly":{"count":5,"weekdays":["Saturday"]},"yearly":<null>},"tiering_policy":<null>,"timezone":"UTC"},{"frequency":{"daily":{"time":"23:00"},"hourly":<null>,"weekly":<null>},"name":"yearly","policy_type":{"v1":<null>,"v2":{"instant_restore_retention_days":7}},"retention":{"daily":{"count":33},"monthly":{"count":13,"days":<null>,"include_last_days":<null>,"weekdays":["Sunday"],"weeks":["Last"]},"weekly":{"count":5,"weekdays":["Saturday"]},"yearly":{"count":7,"days":<null>,"include_last_days":<null>,"months":["January"],"weekdays":["Monday"],"weeks":["First"]}},"tiering_policy":<null>,"timezone":"UTC"}]}. (see below for nested schema)encryption(Attributes) Encryption configuration for the Recovery Services Vault. Defaults to `` (see below for nested schema)immutability(String) Immutability settings of vault. Possible values areLocked,UnlockedorDisabled.
Warning
Once immutability is set to Locked, changing it to other values forces a new Recovery Services Vault to be created.
monitoring(Attributes) Monitoring configuration for the Recovery Services Vault. Defaults to `` (see below for nested schema)sku(String) Sets the vault's SKU. Possible values areStandardorRS0. Defaults toStandardsoft_delete(Boolean) Is soft delete enable for this Vault? Defaults totrue.storage_mode_type(String) The storage type of the Recovery Services Vault. Possible values areGeoRedundant,LocallyRedundantorZoneRedundant. Defaults toGeoRedundant.
Note
If storage_mode_type is GeoRedundant and there are multiple regions defined in this subscription, cross region restore will be enabled by default, otherwise it will be disabled. Once cross region restore is enabled, changing it back to false forces a new Recovery Service Vault to be created.
- tags (Map of String) Key-value map of resource tags.
Nested Schema for configuration.subscriptions.connectivity.backups.recovery_services_vault.backup_policies
Optional:
file_share(Attributes List) A list of file share backup policies to create. (see below for nested schema)vm(Attributes List) A list of VM backup policies to create. (see below for nested schema)
Nested Schema for configuration.subscriptions.connectivity.backups.recovery_services_vault.backup_policies.file_share
Required:
name(String) Backup policy name MUST be lowercase alphanumeric and dash, between 1 and 80 characters.retention(Attributes) Configures the policy retention. (see below for nested schema)
Optional:
frequency(Attributes) Sets the backup frequency. Exactly one ofdailyorhourlyMUST be specified. (see below for nested schema)timezone(String) Specifies the Time Zone which should be used by the host pool and its associated resources for time based events, the possible values are defined here. Defaults toUTC.
Nested Schema for configuration.subscriptions.connectivity.backups.recovery_services_vault.backup_policies.file_share.retention
Optional:
daily(Attributes) Configures the policy daily retention. (see below for nested schema)monthly(Attributes) Configures the policy monthly retention. Eitherweekdaysandweeksordaysandinclude_last_daysmust be specified. (see below for nested schema)weekly(Attributes) Configures the policy weekly retention. (see below for nested schema)yearly(Attributes) Configures the policy yearly retention. (see below for nested schema)
Nested Schema for configuration.subscriptions.connectivity.backups.recovery_services_vault.backup_policies.file_share.retention.daily
Optional:
count(Number) The number of backups to keep. Must be between1and200. Defaults to33.
Nested Schema for configuration.subscriptions.connectivity.backups.recovery_services_vault.backup_policies.file_share.retention.monthly
Optional:
count(Number) The number of backups to keep. Must be between1and120. Defaults to13.days(Number) The days of the month to retain backups of. Must be between1and31. If specified,include_last_daysMUST be specified as well and conflicts withweekdaysandweeks.include_last_days(Boolean) Including the last day of the month. If specified,daysMUST be specified as well and conflicts withweekdaysandweeks.weekdays(List of String) The weekday backups to retain. Possible values areSunday,Monday,Tuesday,Wednesday,Thursday,FridayorSaturday. If specified,weeksMUST be specified as well and conflicts withdaysandinclude_last_days.weeks(List of String) The weeks of the month to retain backups of. Possible values areFirst,Second,Third,FourthorLast. If specified,weekdaysMUST be specified as well and conflicts withdaysandinclude_last_days.
Nested Schema for configuration.subscriptions.connectivity.backups.recovery_services_vault.backup_policies.file_share.retention.weekly
Optional:
count(Number) The number of backups to keep. Must be between1and200. Defaults to5.weekdays(List of String) The weekday backups to retain. Possible values areSunday,Monday,Tuesday,Wednesday,Thursday,FridayorSaturday.
Nested Schema for configuration.subscriptions.connectivity.backups.recovery_services_vault.backup_policies.file_share.retention.yearly
Optional:
count(Number) The number of backups to keep. Must be between1and10. Defaults to7.days(Number) The days of the month to retain backups of. Must be between1and31. If specified,include_last_daysMUST be specified as well and conflicts withweekdaysandweeks.include_last_days(Boolean) Including the last day of the month. If specified,daysMUST be specified as well and conflicts withweekdaysandweeks.months(List of String) The months of the year to retain backups of. Possible values areJanuary,February,March,April,May,June,July,August,September,October,NovemberandDecember. Defaults to["January"].weekdays(List of String) The weekday backups to retain. Possible values areSunday,Monday,Tuesday,Wednesday,Thursday,FridayorSaturday. If specified,weeksMUST be specified as well and conflicts withdaysandinclude_last_days.weeks(List of String) The weeks of the month to retain backups of. Possible values areFirst,Second,Third,FourthorLast. If specified,weekdaysMUST be specified as well and conflicts withdaysandinclude_last_days.
Nested Schema for configuration.subscriptions.connectivity.backups.recovery_services_vault.backup_policies.file_share.frequency
Optional:
daily(Attributes) Sets the backup frequency to daily. Conflicts withhourly. (see below for nested schema)hourly(Attributes) Sets the backup frequency to hourly. Conflicts withdaily. (see below for nested schema)
Nested Schema for configuration.subscriptions.connectivity.backups.recovery_services_vault.backup_policies.file_share.frequency.daily
Required:
time(String) The time of day to perform the backup in 24-hour format. Times must be either on the hour or half hour (e.g. 12:00, 12:30, 13:00, etc.).
Nested Schema for configuration.subscriptions.connectivity.backups.recovery_services_vault.backup_policies.file_share.frequency.hourly
Required:
duration(Number) Species the duration of the backup window in hours. MUST be a number between4and24. Details could be found here.
Note
duration must be multiplier of interval
interval(Number) Specifies the interval at which backup needs to be triggered. Possible values are4,6,8and12.time(String) Specifies the start time of the hourly backup. The time format should be in 24-hour format. Times must be either on the hour or half hour (e.g. 12:00, 12:30, 13:00, etc.).
Nested Schema for configuration.subscriptions.connectivity.backups.recovery_services_vault.backup_policies.vm
Required:
name(String) Backup policy name MUST be lowercase alphanumeric and dash, between 1 and 80 characters.retention(Attributes) Configures the policy retention. (see below for nested schema)
Optional:
frequency(Attributes) Sets the backup frequency. Exactly one ofdaily,hourlyorweeklyMUST be specified. (see below for nested schema)policy_type(Attributes) Type of the Backup Policy. Possible values arev1orv2. Defaults to{"v1":<null>,"v2":{"instant_restore_retention_days":7}}.
Warning
Changing this forces a new resource to be created.
(see below for nested schema)
- tiering_policy (Attributes) Tiering policy configuration. (see below for nested schema)
- timezone (String) Specifies the Time Zone which should be used by the host pool and its associated resources for time based events, the possible values are defined here. Defaults to UTC.
Nested Schema for configuration.subscriptions.connectivity.backups.recovery_services_vault.backup_policies.vm.retention
Optional:
daily(Attributes) Configures the policy daily retention. (see below for nested schema)monthly(Attributes) Configures the policy monthly retention. Eitherweekdaysandweeksordaysandinclude_last_daysmust be specified. (see below for nested schema)weekly(Attributes) Configures the policy weekly retention. (see below for nested schema)yearly(Attributes) Configures the policy yearly retention. (see below for nested schema)
Nested Schema for configuration.subscriptions.connectivity.backups.recovery_services_vault.backup_policies.vm.retention.daily
Optional:
count(Number) The number of backups to keep. Must be between7and9999. Defaults to33.
Nested Schema for configuration.subscriptions.connectivity.backups.recovery_services_vault.backup_policies.vm.retention.monthly
Optional:
count(Number) The number of backups to keep. Must be between1and9999. Defaults to13.days(Number) The days of the month to retain backups of. Must be between1and31. If specified,include_last_daysMUST be specified as well and conflicts withweekdaysandweeks.include_last_days(Boolean) Including the last day of the month. If specified,daysMUST be specified as well and conflicts withweekdaysandweeks.weekdays(List of String) The weekday backups to retain. Possible values areSunday,Monday,Tuesday,Wednesday,Thursday,FridayorSaturday. If specified,weeksMUST be specified as well and conflicts withdaysandinclude_last_days.weeks(List of String) The weeks of the month to retain backups of. Possible values areFirst,Second,Third,FourthorLast. If specified,weekdaysMUST be specified as well and conflicts withdaysandinclude_last_days.
Nested Schema for configuration.subscriptions.connectivity.backups.recovery_services_vault.backup_policies.vm.retention.weekly
Optional:
count(Number) The number of backups to keep. Must be between1and9999. Defaults to5.weekdays(List of String) The weekday backups to retain. Possible values areSunday,Monday,Tuesday,Wednesday,Thursday,FridayorSaturday.
Nested Schema for configuration.subscriptions.connectivity.backups.recovery_services_vault.backup_policies.vm.retention.yearly
Optional:
count(Number) The number of backups to keep. Must be between1and9999. Defaults to7.days(Number) The days of the month to retain backups of. Must be between1and31. If specified,include_last_daysMUST be specified as well and conflicts withweekdaysandweeks.include_last_days(Boolean) Including the last day of the month. If specified,daysMUST be specified as well and conflicts withweekdaysandweeks.months(List of String) The months of the year to retain backups of. Possible values areJanuary,February,March,April,May,June,July,August,September,October,NovemberandDecember. Defaults to["January"].weekdays(List of String) The weekday backups to retain. Possible values areSunday,Monday,Tuesday,Wednesday,Thursday,FridayorSaturday. If specified,weeksMUST be specified as well and conflicts withdaysandinclude_last_days.weeks(List of String) The weeks of the month to retain backups of. Possible values areFirst,Second,Third,FourthorLast. If specified,weekdaysMUST be specified as well and conflicts withdaysandinclude_last_days.
Nested Schema for configuration.subscriptions.connectivity.backups.recovery_services_vault.backup_policies.vm.frequency
Optional:
daily(Attributes) Sets the backup frequency to daily. Conflicts withhourlyandweekly. (see below for nested schema)hourly(Attributes) Sets the backup frequency to hourly. Conflicts withdailyandweekly. (see below for nested schema)weekly(Attributes) Sets the backup frequency to daily. Conflicts withdailyandhourly. (see below for nested schema)
Nested Schema for configuration.subscriptions.connectivity.backups.recovery_services_vault.backup_policies.vm.frequency.daily
Required:
time(String) The time of day to perform the backup in 24-hour format. Times must be either on the hour or half hour (e.g. 12:00, 12:30, 13:00, etc.).
Nested Schema for configuration.subscriptions.connectivity.backups.recovery_services_vault.backup_policies.vm.frequency.hourly
Required:
duration(Number) Species the duration of the backup window in hours. MUST be a number between4and24. Details could be found here.
Note
duration must be multiplier of interval
interval(Number) Specifies the interval at which backup needs to be triggered. Possible values are4,6,8and12.time(String) Specifies the start time of the hourly backup. The time format should be in 24-hour format. Times must be either on the hour or half hour (e.g. 12:00, 12:30, 13:00, etc.).
Nested Schema for configuration.subscriptions.connectivity.backups.recovery_services_vault.backup_policies.vm.frequency.weekly
Required:
time(String) The time of day to perform the backup in 24-hour format. Times must be either on the hour or half hour (e.g. 12:00, 12:30, 13:00, etc.weekdays(List of String) The weekday backups to retain. Possible values areSunday,Monday,Tuesday,Wednesday,Thursday,FridayorSaturday.
Nested Schema for configuration.subscriptions.connectivity.backups.recovery_services_vault.backup_policies.vm.policy_type
Optional:
v1(Attributes) Backup Policy V1 configuration. Conflicts with V2. (see below for nested schema)v2(Attributes) Backup Policy V2 (Enhanced Policy) configuration. Conflicts with V1. (see below for nested schema)
Nested Schema for configuration.subscriptions.connectivity.backups.recovery_services_vault.backup_policies.vm.policy_type.v1
Optional:
instant_restore_retention_days(Number) Specifies the instant restore retention range in days. Possible values are between 1 and 5. Defaults to5.!!! noteinstant_restore_retention_daysMUST be set to5if the backup frequency is set toweekly.
Nested Schema for configuration.subscriptions.connectivity.backups.recovery_services_vault.backup_policies.vm.policy_type.v2
Optional:
instant_restore_retention_days(Number) Specifies the instant restore retention range in days. Possible values are between 1 and 30. Defaults to7.!!! noteinstant_restore_retention_daysMUST be set to5if the backup frequency is set toweekly.
Nested Schema for configuration.subscriptions.connectivity.backups.recovery_services_vault.backup_policies.vm.tiering_policy
Required:
archived_restore_point(Attributes) Archived restore point configuration. (see below for nested schema)
Nested Schema for configuration.subscriptions.connectivity.backups.recovery_services_vault.backup_policies.vm.tiering_policy.archived_restore_point
Required:
mode(String) The tiering mode to control automatic tiering of recovery points. Possible values areTierAfterorTierRecommended.
Optional:
duration(Number) The number of days/weeks/months/years to retain backups in current tier before tiering.duration_type(String) The retention duration type. Possible values areDays,Weeks,MonthsorYears.
Nested Schema for configuration.subscriptions.connectivity.backups.recovery_services_vault.encryption
Optional:
enabled(Boolean) Enabling/Disabling encryption state using the Key Vault key id created part of volocloud resource. Defaults totrue.!!! warning Once Encryption with your own key has been Enabled it's not possible to Disable it.infrastructure_encryption(Boolean) Enabling/Disabling the Double Encryption state. Defaults tofalse.!!! warning Onceinfrastructure_encryptionhas been set it's not possible to change it.
Nested Schema for configuration.subscriptions.connectivity.backups.recovery_services_vault.monitoring
Optional:
alerts_for_all_job_failures(Boolean) Enabling/Disabling built-in Azure Monitor alerts for security scenarios and job failure scenarios. Defaults totrue.
Nested Schema for configuration.subscriptions.connectivity.budgets
Required:
amount(Number) The total amount of cost to track with the budget.notifications(Attributes List) One or more notification objects. (see below for nested schema)
Optional:
time_grain(String) The time covered by a budget. Tracking of the amount will be reset based on the time grain. Possible values areBillingAnnual,BillingMonth,BillingQuarter,Annually,MonthlyandQuarterly. Defaults toMonthly. Changing this forces a new resource to be created.
Nested Schema for configuration.subscriptions.connectivity.budgets.notifications
Required:
contact_emails(List of String) Specifies a list of email addresses to send the budget notification to when the threshold is exceeded.threshold(Number) Threshold value associated with a notification. Notification is sent when the cost exceeded the threshold. It is always percent and has to be between 0 and 1000.
Optional:
operator(String) The comparison operator for the notification. Possible values areEqualTo,GreaterThan, orGreaterThanOrEqualTo. Defaults toEqualTo.threshold_type(String) The type of threshold for the notification. This determines whether the notification is triggered by forecasted costs or actual costs. The allowed values are Actual and Forecasted. Default is Actual. Changing this forces a new resource to be created.
Nested Schema for configuration.subscriptions.connectivity.ddos_protection_plan
Required:
enabled(Boolean) Is Azure DDOS Protection Plan enabled?
Optional:
existing_ddos_protection_plan_resource_id(String) Existing Azure DDOS Protection Plan resource ID to be used.
Nested Schema for configuration.subscriptions.connectivity.dns_resolver
Optional:
inbound(Attributes) Azure Private DNS Resolver Inbound Endpoint configuration. (see below for nested schema)outbound(Attributes) Azure Private DNS Resolver Outbound Endpoint configuration. (see below for nested schema)
Nested Schema for configuration.subscriptions.connectivity.dns_resolver.inbound
Optional:
enabled(Boolean) Is Azure Private DNS Resolver Inbound enpoint enabled?
Nested Schema for configuration.subscriptions.connectivity.dns_resolver.outbound
Optional:
enabled(Boolean) Is Azure Private Resolver DNS Outbound enpoint enabled?forwarding_domains(Attributes List) Provides a list of objects to configure outbound conditional forwarding. (see below for nested schema)
Nested Schema for configuration.subscriptions.connectivity.dns_resolver.outbound.forwarding_domains
Required:
dns_domain(String) DNS domain for conditional forwarding.dns_servers(List of String) List of DNS servers that are authoritative for the domain.
Nested Schema for configuration.subscriptions.connectivity.dns_zones
Optional:
private_subdomains(Attributes) Map contains the private DNS domain for each environment. (see below for nested schema)public_domains(List of String) List contains the public DNS domains.
Nested Schema for configuration.subscriptions.connectivity.dns_zones.private_subdomains
Optional:
dev(String) The subdomain name for creating the DEV environment private dns zone.prod(String) The subdomain name for creating the PROD environment private dns zone.qa(String) The subdomain name for creating the QA environment private dns zone.test(String) The subdomain name for creating the TEST environment private dns zone.
Nested Schema for configuration.subscriptions.connectivity.hub_networks
Required:
enabled(Boolean) If true, deploys a Hub and Spoke setup.
Optional:
azure_firewall(Attributes) Provides details for configuring Azure Firewall service. (see below for nested schema)azure_route_server(Attributes) Creates an Azure Route Server in the HUB VNET. (see below for nested schema)virtual_network_gateway(Attributes) Provides the details to create a new virtual network gateway. (see below for nested schema)
Nested Schema for configuration.subscriptions.connectivity.hub_networks.azure_firewall
Optional:
availability_zones(Boolean) Is Azure Firewall deployed across the 3 AZs? Defaults to true.dns_proxy(Boolean) Is Azure Firewall going to act as a DNS Proxy? Defaults to true.dns_servers(List of String) A list of DNS servers to configure on the Azure Firewall to use instead of Azure provided servers.enabled(Boolean) Is Azure Firewall enabled? Defaults to true.policy(Attributes) Configures Azure Firewall Policy. (see below for nested schema)sku(String) SKU tier of the Firewall. Possible values are Premium, Standard and Basic. Defaults to Standard.threat_intelligence_mode(String) The operation mode for threat intelligence-based filtering. Possible values are: Off, Alert and Deny. Defaults to Alert.
Nested Schema for configuration.subscriptions.connectivity.hub_networks.azure_firewall.policy
Optional:
auto_learn_private_ranges_enabled(Boolean) If true, configures the Azure Firewalll to auto-learn SNAT IP prefixes. Defaults to true.
Nested Schema for configuration.subscriptions.connectivity.hub_networks.azure_route_server
Required:
enabled(Boolean) If true, deploys an Azure Route Server in Hub VNET.
Optional:
attach_to_azure_firewall(Boolean) If true, configures the deployed Azure Firewall(deployed part of Hub network) to use this Route Server. Defaults to false.bgp_connections(Attributes List) Provides a list of BGP Peer settings object. (see below for nested schema)branch_to_branch_traffic_enabled(Boolean) Whether to enable route exchange between Azure Route Server and the gateway(s). Defaults to false.sku(String) The SKU of the Route Server. The only possible value is Standard. Changing this forces a new resource to be created. Defaults to Standard.
Nested Schema for configuration.subscriptions.connectivity.hub_networks.azure_route_server.bgp_connections
Required:
peer_asn(Number) The BGP ASN number of the peer.peer_geo(String) The Geography Key (as defined in the geographies object under tenancy resource) where the peer needs to be configured.peer_ip(String) The IP address of the peer.peer_name(String) The name of the peer.peer_region(String) The Region Key (primary/secondary) where the peer needs to be configured.
Nested Schema for configuration.subscriptions.connectivity.hub_networks.virtual_network_gateway
Required:
enabled(Boolean) Is Azure Virtual Network Gateway enabled?
Optional:
active_active(Boolean) Iftrue, an active-active Virtual Network Gateway will be created. An active-active gateway requires aHighPerformanceor anUltraPerformanceSKU. Iffalse, an active-standby gateway will be created. Defaults tofalse.bgp_settings(Attributes) BGP settings for this Virtual Network Gateway. (see below for nested schema)s2s_vpns(Attributes List) Provides a list of objects, each object has configuration for a site-to-site VPN with a remote gateway. (see below for nested schema)sku(String) Configuration of the size and capacity of the virtual network gateway. Valid options are Basic, Standard, HighPerformance, UltraPerformance, ErGw1AZ, ErGw2AZ, ErGw3AZ, VpnGw1, VpnGw2, VpnGw3, VpnGw4,VpnGw5, VpnGw1AZ, VpnGw2AZ, VpnGw3AZ,VpnGw4AZ and VpnGw5AZ and depend on the type, vpn_type and generation arguments. A PolicyBased gateway only supports the Basic SKU. Further, the UltraPerformance SKU is only supported by an ExpressRoute gateway. Defaults to Basic.type(String) The type of the Virtual Network Gateway. Valid options are Vpn or ExpressRoute. Defaults to Vpn. Changing the type forces a new resource to be created.vpn_type(String) The routing type of the Virtual Network Gateway. Valid options are RouteBased or PolicyBased. Defaults to RouteBased. Changing this forces a new resource to be created.
Nested Schema for configuration.subscriptions.connectivity.hub_networks.virtual_network_gateway.bgp_settings
Optional:
active_active(Attributes) BGP settings for this active-active Virtual Network Gateway. (see below for nested schema)active_standby(Attributes) BGP settings for this active-standby Virtual Network Gateway. (see below for nested schema)
Nested Schema for configuration.subscriptions.connectivity.hub_networks.virtual_network_gateway.bgp_settings.active_active
Required:
asn(Number) The BGP ASN of this Virtual Network Gateway.
Optional:
peer_weight(Number) The weight added to routes which have been learned through BGP peering. Valid values can be between0and100.peering_apipa_addresses(Attributes) An object with apipa addresses for this active-active Virtual Network Gateway. (see below for nested schema)
Nested Schema for configuration.subscriptions.connectivity.hub_networks.virtual_network_gateway.bgp_settings.active_active.peering_apipa_addresses
Required:
instance_0(Attributes) Azure primary/secondary custom APIPA addresses assigned to the instance 0 BGP peer of this active-active Virtual Network Gateway. The valid range for the reserved APIPA address in Azure Public is from169.254.21.0to169.254.22.255. (see below for nested schema)instance_1(Attributes) Azure primary/secondary custom APIPA addresses assigned to the instance 1 BGP peer of this active-active Virtual Network Gateway. The valid range for the reserved APIPA address in Azure Public is from169.254.21.0to169.254.22.255. (see below for nested schema)
Nested Schema for configuration.subscriptions.connectivity.hub_networks.virtual_network_gateway.bgp_settings.active_active.peering_apipa_addresses.instance_0
Required:
primary(String) Azure primary custom APIPA address assigned to the instance 0 BGP peer of this active-active Virtual Network Gateway. The valid range for the reserved APIPA address in Azure Public is from169.254.21.0to169.254.22.255.
Optional:
secondary(String) Azure secondary custom APIPA address assigned to the instance 0 BGP peer of this active-active Virtual Network Gateway. The valid range for the reserved APIPA address in Azure Public is from169.254.21.0to169.254.22.255.
Nested Schema for configuration.subscriptions.connectivity.hub_networks.virtual_network_gateway.bgp_settings.active_active.peering_apipa_addresses.instance_1
Required:
primary(String) Azure primary custom APIPA address assigned to the instance 1 BGP peer of this active-active Virtual Network Gateway. The valid range for the reserved APIPA address in Azure Public is from169.254.21.0to169.254.22.255.
Optional:
secondary(String) Azure secondary custom APIPA address assigned to the instance 1 BGP peer of this active-active Virtual Network Gateway. The valid range for the reserved APIPA address in Azure Public is from169.254.21.0to169.254.22.255.
Nested Schema for configuration.subscriptions.connectivity.hub_networks.virtual_network_gateway.bgp_settings.active_standby
Required:
asn(Number) The BGP ASN of this Virtual Network Gateway.peering_apipa_addresses(Attributes) Azure primary/secondary custom APIPA addresses assigned to the BGP peer of this active-standby Virtual Network Gateway. The valid range for the reserved APIPA address in Azure Public is from169.254.21.0to169.254.22.255. (see below for nested schema)
Optional:
peer_weight(Number) The weight added to routes which have been learned through BGP peering. Valid values can be between0and100.
Nested Schema for configuration.subscriptions.connectivity.hub_networks.virtual_network_gateway.bgp_settings.active_standby.peering_apipa_addresses
Required:
primary(String) Azure primary custom APIPA address assigned to the BGP peer of this active-standby Virtual Network Gateway. The valid range for the reserved APIPA address in Azure Public is from169.254.21.0to169.254.22.255.
Optional:
secondary(String) Azure secondary custom APIPA address assigned to the BGP peer of this active-standby Virtual Network Gateway. The valid range for the reserved APIPA address in Azure Public is from169.254.21.0to169.254.22.255.
Nested Schema for configuration.subscriptions.connectivity.hub_networks.virtual_network_gateway.s2s_vpns
Required:
gateway_name(String) The name of the local network gateway. Changing this forces a new resource to be created.
Optional:
connection_dpd_timeout_seconds(Number) The dead peer detection timeout of this connection in seconds. Changing this forces a new resource to be created. Defaults to45connection_egress_nat_rule_ids(List of String) A list of the egress NAT Rule Ids.connection_ingress_nat_rule_ids(List of String) A list of the ingress NAT Rule Ids.connection_instance(String) Specifies the instance of this active-active Virtual Network Gateway for the connection. Valid values areinstance_0 | instance_1.connection_ipsec_policy(Attributes) A ipsec_policy object. Only a single policy can be defined for a connection. For details on custom policies refer to the relevant section in the Azure documentation. (see below for nested schema)connection_local_azure_ip_address_enabled(Boolean) Use private local Azure IP for the connection. Changing this forces a new resource to be created.connection_mode(String) Connection mode to use. Possible values are Default, InitiatorOnly and ResponderOnly. Defaults to Default. Changing this value will force a resource to be created.connection_protocol(String) The IKE protocol version to use. Possible values are IKEv1 and IKEv2. Defaults to IKEv2. Changing this forces a new resource to be created. -> Note: Only valid for IPSec connections on virtual network gateways with SKU VpnGw1, VpnGw2, VpnGw3, VpnGw1AZ, VpnGw2AZ or VpnGw3AZ.connection_psk_kv_secret_name(String) The name of a KeyVault secret that has the PSK for the connection. If not provided, the code will generate a new PSK and store it in a KeyVault secret.connection_type(String) The type of connection. Valid options are IPsec (Site-to-Site), ExpressRoute (ExpressRoute), and Vnet2Vnet (VNet-to-VNet). Each connection type requires different mandatory arguments (refer to the examples above). Defaults to IPSec. Changing this forces a new resource to be created.gateway_address(String) The gateway IP address to connect with.gateway_address_space(List of String) The list of string CIDRs representing the address spaces the gateway exposes.gateway_bpg_settings(Attributes) A bgp_settings containing the Local Network Gateway's BGP speaker settings. (see below for nested schema)gateway_fqdn(String) The gateway FQDN to connect with.
Nested Schema for configuration.subscriptions.connectivity.hub_networks.virtual_network_gateway.s2s_vpns.connection_ipsec_policy
Optional:
dh_group(String) The DH group used in IKE phase 1 for initial SA. Valid options are DHGroup1, DHGroup14, DHGroup2, DHGroup2048, DHGroup24, ECP256, ECP384, or None. Defaults to DHGroup2.ike_encryption(String) The IKE encryption algorithm. Valid options are AES128, AES192, AES256, DES, DES3, GCMAES128, or GCMAES256. Defaults to AES256.ike_integrity(String) The IKE integrity algorithm. Valid options are GCMAES128, GCMAES256, MD5, SHA1, SHA256, or SHA384. Defaults to SHA256.ipsec_encryption(String) The IPSec encryption algorithm. Valid options are AES128, AES192, AES256, DES, DES3, GCMAES128, GCMAES192, GCMAES256, or None. Defaults to AES256.ipsec_integrity(String) The IPSec integrity algorithm. Valid options are GCMAES128, GCMAES192, GCMAES256, MD5, SHA1, or SHA256. Defaults to SHA256.pfs_group(String) The DH group used in IKE phase 2 for new child SA. Valid options are ECP256, ECP384, PFS1, PFS14, PFS2, PFS2048, PFS24, PFSMM, or None. Defaults to PFS2.sa_datasize(Number) The IPSec SA payload size in KB. Must be at least 1024 KB. Defaults to102400000.sa_lifetime(Number) The IPSec SA lifetime in seconds. Must be at least 300 seconds. Defaults to28800seconds.
Nested Schema for configuration.subscriptions.connectivity.hub_networks.virtual_network_gateway.s2s_vpns.gateway_bpg_settings
Required:
asn(String) The BGP speaker's ASN.peering_address(String) The BGP peering address and BGP identifier of this BGP speaker.
Optional:
peer_weight(String) The weight added to routes learned from this BGP speaker.
Nested Schema for configuration.subscriptions.connectivity.keyvault
Optional:
purge_protection_enabled(Boolean) Is Purge Protection enabled for this Key Vault? Defaults to true.sku(String) The Name of the SKU used for this Key Vault. Possible values are standard and premium. Defaults to standard.soft_delete_retention_days(Number) The number of days that items should be retained for once soft-deleted. This field can only be configured one time and cannot be updated. This value can be between 7 and 90 days. Defaults to 90.
Nested Schema for configuration.subscriptions.connectivity.resource_groups_lock
Optional:
baseline(Boolean) Boolean flag to enable/disable RG lock. Defaults to true.ddos(Boolean) Boolean flag to enable/disable RG lock. Defaults to false.dns(Boolean) Boolean flag to enable/disable RG lock. Defaults to false.rsv(Boolean) Boolean flag to enable/disable RG lock. Defaults to false.
Nested Schema for configuration.subscriptions.connectivity.vwan_hub_networks
Required:
enabled(Boolean) If true, deploys a VWAN setup.
Optional:
azure_firewall(Attributes) Provides details for configuring Azure Firewall service. (see below for nested schema)existing_virtual_wan_resource_id(String) Existing Virtual WAN resource ID to be used.expressroute_gateway(Attributes) Manages an ExpressRoute gateway within a Virtual WAN. (see below for nested schema)routes(Attributes List) One or more route objects as defined below. (see below for nested schema)vpn_gateway(Attributes) Manages a VPN Gateway within a Virtual Hub, which enables Site-to-Site communication. (see below for nested schema)
Nested Schema for configuration.subscriptions.connectivity.vwan_hub_networks.azure_firewall
Optional:
availability_zones(Boolean) Is Azure Firewall deployed across the 3 AZs? Defaults to true.dns_proxy(Boolean) Is Azure Firewall going to act as a DNS Proxy? Defaults to true.dns_servers(List of String) A list of DNS servers to configure on the Azure Firewall to use instead of Azure provided servers.enabled(Boolean) Is Azure Firewall enabled? Defaults to true.sku(String) SKU tier of the Firewall. Possible values are Premium, Standard and Basic. Defaults to Standard.threat_intelligence_mode(String) The operation mode for threat intelligence-based filtering. Possible values are: Off, Alert and Deny. Defaults to Alert.
Nested Schema for configuration.subscriptions.connectivity.vwan_hub_networks.expressroute_gateway
Required:
enabled(Boolean) If true, deploys Expressroute Gateway.
Optional:
scale_unit(Number) The number of scale units with which to provision the ExpressRoute gateway. Each scale unit is equal to 2Gbps, with support for up to 10 scale units (20Gbps). Defaults to1
Nested Schema for configuration.subscriptions.connectivity.vwan_hub_networks.routes
Required:
address_prefixes(List of String) A list of Address Prefixes.next_hop_ip_address(String) The IP Address that Packets should be forwarded to as the Next Hop.
Nested Schema for configuration.subscriptions.connectivity.vwan_hub_networks.vpn_gateway
Required:
enabled(Boolean) If true, deploys VPN Gateway.
Optional:
bgp_settings(Attributes) A bgp_settings object. (see below for nested schema)routing_preference(String) Azure routing preference lets you to choose how your traffic routes between Azure and the internet. You can choose to route traffic either via theMicrosoft Networkor via the ISP network,Internet. Defaults toMicrosoft Network.scale_unit(Number) The number of scale units with which to provision the VPN gateway. Each scale unit is equal to 2Gbps, with support for up to 10 scale units (20Gbps). Defaults to1
Nested Schema for configuration.subscriptions.connectivity.vwan_hub_networks.vpn_gateway.bgp_settings
Required:
asn(Number) The ASN of the BGP Speaker. Changing this forces a new resource to be created.peer_weight(Number) The weight added to Routes learned from this BGP Speaker. Changing this forces a new resource to be created.
Optional:
instance_0_bgp_peering_address(Attributes List) An instance_bgp_peering_address object. (see below for nested schema)instance_1_bgp_peering_address(Attributes List) An instance_bgp_peering_address object. (see below for nested schema)
Nested Schema for configuration.subscriptions.connectivity.vwan_hub_networks.vpn_gateway.bgp_settings.instance_0_bgp_peering_address
Required:
custom_ips(List of String) A list of custom BGP peering addresses to assign to this instance.
Nested Schema for configuration.subscriptions.connectivity.vwan_hub_networks.vpn_gateway.bgp_settings.instance_1_bgp_peering_address
Required:
custom_ips(List of String) A list of custom BGP peering addresses to assign to this instance.
Nested Schema for configuration.subscriptions.identity
Required:
abbreviation(String) This abbreviation will be used to uniquily identify resources created in this subscription. Only applies to resources that require Azure global uniqueness.
Optional:
backups(Attributes) Configuration settings for backups in this subscription. Defaults to {"recovery_services_vault":{"backup_policies":{"file_share":[{"frequency":{"daily":{"time":"23:00"},"hourly":},"name":"daily","retention":{"daily":{"count":33},"monthly": ,"weekly": ,"yearly": },"timezone":"UTC"},{"frequency":{"daily":{"time":"23:00"},"hourly": },"name":"monthly","retention":{"daily":{"count":33},"monthly":{"count":13,"days": ,"include_last_days": ,"weekdays":["Sunday"],"weeks":["Last"]},"weekly":{"count":13,"weekdays":["Saturday"]},"yearly": },"timezone":"UTC"},{"frequency":{"daily":{"time":"23:00"},"hourly": },"name":"weekly","retention":{"daily":{"count":33},"monthly": ,"weekly":{"count":13,"weekdays":["Saturday"]},"yearly": },"timezone":"UTC"},{"frequency":{"daily":{"time":"23:00"},"hourly": },"name":"yearly","retention":{"daily":{"count":33},"monthly":{"count":13,"days": ,"include_last_days": ,"weekdays":["Sunday"],"weeks":["Last"]},"weekly":{"count":13,"weekdays":["Saturday"]},"yearly":{"count":7,"days": ,"include_last_days": ,"months":["January"],"weekdays":["Monday"],"weeks":["First"]}},"timezone":"UTC"}],"vm":[{"frequency":{"daily":{"time":"23:00"},"hourly": ,"weekly": },"name":"daily","policy_type":{"v1": ,"v2":{"instant_restore_retention_days":7}},"retention":{"daily":{"count":33},"monthly": ,"weekly": ,"yearly": },"tiering_policy": ,"timezone":"UTC"},{"frequency":{"daily":{"time":"23:00"},"hourly": ,"weekly": },"name":"monthly","policy_type":{"v1": ,"v2":{"instant_restore_retention_days":7}},"retention":{"daily":{"count":33},"monthly":{"count":13,"days": ,"include_last_days": ,"weekdays":["Sunday"],"weeks":["Last"]},"weekly":{"count":5,"weekdays":["Saturday"]},"yearly": },"tiering_policy": ,"timezone":"UTC"},{"frequency":{"daily":{"time":"23:00"},"hourly": ,"weekly": },"name":"weekly","policy_type":{"v1": ,"v2":{"instant_restore_retention_days":7}},"retention":{"daily":{"count":33},"monthly": ,"weekly":{"count":5,"weekdays":["Saturday"]},"yearly": },"tiering_policy": ,"timezone":"UTC"},{"frequency":{"daily":{"time":"23:00"},"hourly": ,"weekly": },"name":"yearly","policy_type":{"v1": ,"v2":{"instant_restore_retention_days":7}},"retention":{"daily":{"count":33},"monthly":{"count":13,"days": ,"include_last_days": ,"weekdays":["Sunday"],"weeks":["Last"]},"weekly":{"count":5,"weekdays":["Saturday"]},"yearly":{"count":7,"days": ,"include_last_days": ,"months":["January"],"weekdays":["Monday"],"weeks":["First"]}},"tiering_policy": ,"timezone":"UTC"}]},"encryption":{"enabled":true,"infrastructure_encryption":false},"immutability": ,"monitoring":{"alerts_for_all_job_failures":true},"sku":"Standard","soft_delete":true,"storage_mode_type":"GeoRedundant","tags": }} (see below for nested schema) budgets(Attributes List) Provides a list of budget objects. (see below for nested schema)keyvault(Attributes) Azure KeyVault configuration details. (see below for nested schema)microsoft_entra_domain_services(Attributes) Microsoft Entra Domain Services configuration details. (see below for nested schema)resource_groups_lock(Attributes) Configures Azure Delete Lock at Resource Groups level. (see below for nested schema)vnet(Attributes) Settings for customizing standard subnets and adding PaaS subnets. (see below for nested schema)
Nested Schema for configuration.subscriptions.identity.backups
Optional:
recovery_services_vault(Attributes) Configuration settings for Recovery Services Vault in this subscription. Defaults to{"backup_policies":{"file_share":[{"frequency":{"daily":{"time":"23:00"},"hourly":<null>},"name":"daily","retention":{"daily":{"count":33},"monthly":<null>,"weekly":<null>,"yearly":<null>},"timezone":"UTC"},{"frequency":{"daily":{"time":"23:00"},"hourly":<null>},"name":"monthly","retention":{"daily":{"count":33},"monthly":{"count":13,"days":<null>,"include_last_days":<null>,"weekdays":["Sunday"],"weeks":["Last"]},"weekly":{"count":13,"weekdays":["Saturday"]},"yearly":<null>},"timezone":"UTC"},{"frequency":{"daily":{"time":"23:00"},"hourly":<null>},"name":"weekly","retention":{"daily":{"count":33},"monthly":<null>,"weekly":{"count":13,"weekdays":["Saturday"]},"yearly":<null>},"timezone":"UTC"},{"frequency":{"daily":{"time":"23:00"},"hourly":<null>},"name":"yearly","retention":{"daily":{"count":33},"monthly":{"count":13,"days":<null>,"include_last_days":<null>,"weekdays":["Sunday"],"weeks":["Last"]},"weekly":{"count":13,"weekdays":["Saturday"]},"yearly":{"count":7,"days":<null>,"include_last_days":<null>,"months":["January"],"weekdays":["Monday"],"weeks":["First"]}},"timezone":"UTC"}],"vm":[{"frequency":{"daily":{"time":"23:00"},"hourly":<null>,"weekly":<null>},"name":"daily","policy_type":{"v1":<null>,"v2":{"instant_restore_retention_days":7}},"retention":{"daily":{"count":33},"monthly":<null>,"weekly":<null>,"yearly":<null>},"tiering_policy":<null>,"timezone":"UTC"},{"frequency":{"daily":{"time":"23:00"},"hourly":<null>,"weekly":<null>},"name":"monthly","policy_type":{"v1":<null>,"v2":{"instant_restore_retention_days":7}},"retention":{"daily":{"count":33},"monthly":{"count":13,"days":<null>,"include_last_days":<null>,"weekdays":["Sunday"],"weeks":["Last"]},"weekly":{"count":5,"weekdays":["Saturday"]},"yearly":<null>},"tiering_policy":<null>,"timezone":"UTC"},{"frequency":{"daily":{"time":"23:00"},"hourly":<null>,"weekly":<null>},"name":"weekly","policy_type":{"v1":<null>,"v2":{"instant_restore_retention_days":7}},"retention":{"daily":{"count":33},"monthly":<null>,"weekly":{"count":5,"weekdays":["Saturday"]},"yearly":<null>},"tiering_policy":<null>,"timezone":"UTC"},{"frequency":{"daily":{"time":"23:00"},"hourly":<null>,"weekly":<null>},"name":"yearly","policy_type":{"v1":<null>,"v2":{"instant_restore_retention_days":7}},"retention":{"daily":{"count":33},"monthly":{"count":13,"days":<null>,"include_last_days":<null>,"weekdays":["Sunday"],"weeks":["Last"]},"weekly":{"count":5,"weekdays":["Saturday"]},"yearly":{"count":7,"days":<null>,"include_last_days":<null>,"months":["January"],"weekdays":["Monday"],"weeks":["First"]}},"tiering_policy":<null>,"timezone":"UTC"}]},"encryption":{"enabled":true,"infrastructure_encryption":false},"immutability":<null>,"monitoring":{"alerts_for_all_job_failures":true},"sku":"Standard","soft_delete":true,"storage_mode_type":"GeoRedundant","tags":<null>}. (see below for nested schema)
Nested Schema for configuration.subscriptions.identity.backups.recovery_services_vault
Optional:
backup_policies(Attributes) Backup policies to be created in this Recovery Services Vault. Defaults to{"file_share":[{"frequency":{"daily":{"time":"23:00"},"hourly":<null>},"name":"daily","retention":{"daily":{"count":33},"monthly":<null>,"weekly":<null>,"yearly":<null>},"timezone":"UTC"},{"frequency":{"daily":{"time":"23:00"},"hourly":<null>},"name":"monthly","retention":{"daily":{"count":33},"monthly":{"count":13,"days":<null>,"include_last_days":<null>,"weekdays":["Sunday"],"weeks":["Last"]},"weekly":{"count":13,"weekdays":["Saturday"]},"yearly":<null>},"timezone":"UTC"},{"frequency":{"daily":{"time":"23:00"},"hourly":<null>},"name":"weekly","retention":{"daily":{"count":33},"monthly":<null>,"weekly":{"count":13,"weekdays":["Saturday"]},"yearly":<null>},"timezone":"UTC"},{"frequency":{"daily":{"time":"23:00"},"hourly":<null>},"name":"yearly","retention":{"daily":{"count":33},"monthly":{"count":13,"days":<null>,"include_last_days":<null>,"weekdays":["Sunday"],"weeks":["Last"]},"weekly":{"count":13,"weekdays":["Saturday"]},"yearly":{"count":7,"days":<null>,"include_last_days":<null>,"months":["January"],"weekdays":["Monday"],"weeks":["First"]}},"timezone":"UTC"}],"vm":[{"frequency":{"daily":{"time":"23:00"},"hourly":<null>,"weekly":<null>},"name":"daily","policy_type":{"v1":<null>,"v2":{"instant_restore_retention_days":7}},"retention":{"daily":{"count":33},"monthly":<null>,"weekly":<null>,"yearly":<null>},"tiering_policy":<null>,"timezone":"UTC"},{"frequency":{"daily":{"time":"23:00"},"hourly":<null>,"weekly":<null>},"name":"monthly","policy_type":{"v1":<null>,"v2":{"instant_restore_retention_days":7}},"retention":{"daily":{"count":33},"monthly":{"count":13,"days":<null>,"include_last_days":<null>,"weekdays":["Sunday"],"weeks":["Last"]},"weekly":{"count":5,"weekdays":["Saturday"]},"yearly":<null>},"tiering_policy":<null>,"timezone":"UTC"},{"frequency":{"daily":{"time":"23:00"},"hourly":<null>,"weekly":<null>},"name":"weekly","policy_type":{"v1":<null>,"v2":{"instant_restore_retention_days":7}},"retention":{"daily":{"count":33},"monthly":<null>,"weekly":{"count":5,"weekdays":["Saturday"]},"yearly":<null>},"tiering_policy":<null>,"timezone":"UTC"},{"frequency":{"daily":{"time":"23:00"},"hourly":<null>,"weekly":<null>},"name":"yearly","policy_type":{"v1":<null>,"v2":{"instant_restore_retention_days":7}},"retention":{"daily":{"count":33},"monthly":{"count":13,"days":<null>,"include_last_days":<null>,"weekdays":["Sunday"],"weeks":["Last"]},"weekly":{"count":5,"weekdays":["Saturday"]},"yearly":{"count":7,"days":<null>,"include_last_days":<null>,"months":["January"],"weekdays":["Monday"],"weeks":["First"]}},"tiering_policy":<null>,"timezone":"UTC"}]}. (see below for nested schema)encryption(Attributes) Encryption configuration for the Recovery Services Vault. Defaults to `` (see below for nested schema)immutability(String) Immutability settings of vault. Possible values areLocked,UnlockedorDisabled.
Warning
Once immutability is set to Locked, changing it to other values forces a new Recovery Services Vault to be created.
monitoring(Attributes) Monitoring configuration for the Recovery Services Vault. Defaults to `` (see below for nested schema)sku(String) Sets the vault's SKU. Possible values areStandardorRS0. Defaults toStandardsoft_delete(Boolean) Is soft delete enable for this Vault? Defaults totrue.storage_mode_type(String) The storage type of the Recovery Services Vault. Possible values areGeoRedundant,LocallyRedundantorZoneRedundant. Defaults toGeoRedundant.
Note
If storage_mode_type is GeoRedundant and there are multiple regions defined in this subscription, cross region restore will be enabled by default, otherwise it will be disabled. Once cross region restore is enabled, changing it back to false forces a new Recovery Service Vault to be created.
- tags (Map of String) Key-value map of resource tags.
Nested Schema for configuration.subscriptions.identity.backups.recovery_services_vault.backup_policies
Optional:
file_share(Attributes List) A list of file share backup policies to create. (see below for nested schema)vm(Attributes List) A list of VM backup policies to create. (see below for nested schema)
Nested Schema for configuration.subscriptions.identity.backups.recovery_services_vault.backup_policies.file_share
Required:
name(String) Backup policy name MUST be lowercase alphanumeric and dash, between 1 and 80 characters.retention(Attributes) Configures the policy retention. (see below for nested schema)
Optional:
frequency(Attributes) Sets the backup frequency. Exactly one ofdailyorhourlyMUST be specified. (see below for nested schema)timezone(String) Specifies the Time Zone which should be used by the host pool and its associated resources for time based events, the possible values are defined here. Defaults toUTC.
Nested Schema for configuration.subscriptions.identity.backups.recovery_services_vault.backup_policies.file_share.retention
Optional:
daily(Attributes) Configures the policy daily retention. (see below for nested schema)monthly(Attributes) Configures the policy monthly retention. Eitherweekdaysandweeksordaysandinclude_last_daysmust be specified. (see below for nested schema)weekly(Attributes) Configures the policy weekly retention. (see below for nested schema)yearly(Attributes) Configures the policy yearly retention. (see below for nested schema)
Nested Schema for configuration.subscriptions.identity.backups.recovery_services_vault.backup_policies.file_share.retention.daily
Optional:
count(Number) The number of backups to keep. Must be between1and200. Defaults to33.
Nested Schema for configuration.subscriptions.identity.backups.recovery_services_vault.backup_policies.file_share.retention.monthly
Optional:
count(Number) The number of backups to keep. Must be between1and120. Defaults to13.days(Number) The days of the month to retain backups of. Must be between1and31. If specified,include_last_daysMUST be specified as well and conflicts withweekdaysandweeks.include_last_days(Boolean) Including the last day of the month. If specified,daysMUST be specified as well and conflicts withweekdaysandweeks.weekdays(List of String) The weekday backups to retain. Possible values areSunday,Monday,Tuesday,Wednesday,Thursday,FridayorSaturday. If specified,weeksMUST be specified as well and conflicts withdaysandinclude_last_days.weeks(List of String) The weeks of the month to retain backups of. Possible values areFirst,Second,Third,FourthorLast. If specified,weekdaysMUST be specified as well and conflicts withdaysandinclude_last_days.
Nested Schema for configuration.subscriptions.identity.backups.recovery_services_vault.backup_policies.file_share.retention.weekly
Optional:
count(Number) The number of backups to keep. Must be between1and200. Defaults to5.weekdays(List of String) The weekday backups to retain. Possible values areSunday,Monday,Tuesday,Wednesday,Thursday,FridayorSaturday.
Nested Schema for configuration.subscriptions.identity.backups.recovery_services_vault.backup_policies.file_share.retention.yearly
Optional:
count(Number) The number of backups to keep. Must be between1and10. Defaults to7.days(Number) The days of the month to retain backups of. Must be between1and31. If specified,include_last_daysMUST be specified as well and conflicts withweekdaysandweeks.include_last_days(Boolean) Including the last day of the month. If specified,daysMUST be specified as well and conflicts withweekdaysandweeks.months(List of String) The months of the year to retain backups of. Possible values areJanuary,February,March,April,May,June,July,August,September,October,NovemberandDecember. Defaults to["January"].weekdays(List of String) The weekday backups to retain. Possible values areSunday,Monday,Tuesday,Wednesday,Thursday,FridayorSaturday. If specified,weeksMUST be specified as well and conflicts withdaysandinclude_last_days.weeks(List of String) The weeks of the month to retain backups of. Possible values areFirst,Second,Third,FourthorLast. If specified,weekdaysMUST be specified as well and conflicts withdaysandinclude_last_days.
Nested Schema for configuration.subscriptions.identity.backups.recovery_services_vault.backup_policies.file_share.frequency
Optional:
daily(Attributes) Sets the backup frequency to daily. Conflicts withhourly. (see below for nested schema)hourly(Attributes) Sets the backup frequency to hourly. Conflicts withdaily. (see below for nested schema)
Nested Schema for configuration.subscriptions.identity.backups.recovery_services_vault.backup_policies.file_share.frequency.daily
Required:
time(String) The time of day to perform the backup in 24-hour format. Times must be either on the hour or half hour (e.g. 12:00, 12:30, 13:00, etc.).
Nested Schema for configuration.subscriptions.identity.backups.recovery_services_vault.backup_policies.file_share.frequency.hourly
Required:
duration(Number) Species the duration of the backup window in hours. MUST be a number between4and24. Details could be found here.
Note
duration must be multiplier of interval
interval(Number) Specifies the interval at which backup needs to be triggered. Possible values are4,6,8and12.time(String) Specifies the start time of the hourly backup. The time format should be in 24-hour format. Times must be either on the hour or half hour (e.g. 12:00, 12:30, 13:00, etc.).
Nested Schema for configuration.subscriptions.identity.backups.recovery_services_vault.backup_policies.vm
Required:
name(String) Backup policy name MUST be lowercase alphanumeric and dash, between 1 and 80 characters.retention(Attributes) Configures the policy retention. (see below for nested schema)
Optional:
frequency(Attributes) Sets the backup frequency. Exactly one ofdaily,hourlyorweeklyMUST be specified. (see below for nested schema)policy_type(Attributes) Type of the Backup Policy. Possible values arev1orv2. Defaults to{"v1":<null>,"v2":{"instant_restore_retention_days":7}}.
Warning
Changing this forces a new resource to be created.
(see below for nested schema)
- tiering_policy (Attributes) Tiering policy configuration. (see below for nested schema)
- timezone (String) Specifies the Time Zone which should be used by the host pool and its associated resources for time based events, the possible values are defined here. Defaults to UTC.
Nested Schema for configuration.subscriptions.identity.backups.recovery_services_vault.backup_policies.vm.retention
Optional:
daily(Attributes) Configures the policy daily retention. (see below for nested schema)monthly(Attributes) Configures the policy monthly retention. Eitherweekdaysandweeksordaysandinclude_last_daysmust be specified. (see below for nested schema)weekly(Attributes) Configures the policy weekly retention. (see below for nested schema)yearly(Attributes) Configures the policy yearly retention. (see below for nested schema)
Nested Schema for configuration.subscriptions.identity.backups.recovery_services_vault.backup_policies.vm.retention.daily
Optional:
count(Number) The number of backups to keep. Must be between7and9999. Defaults to33.
Nested Schema for configuration.subscriptions.identity.backups.recovery_services_vault.backup_policies.vm.retention.monthly
Optional:
count(Number) The number of backups to keep. Must be between1and9999. Defaults to13.days(Number) The days of the month to retain backups of. Must be between1and31. If specified,include_last_daysMUST be specified as well and conflicts withweekdaysandweeks.include_last_days(Boolean) Including the last day of the month. If specified,daysMUST be specified as well and conflicts withweekdaysandweeks.weekdays(List of String) The weekday backups to retain. Possible values areSunday,Monday,Tuesday,Wednesday,Thursday,FridayorSaturday. If specified,weeksMUST be specified as well and conflicts withdaysandinclude_last_days.weeks(List of String) The weeks of the month to retain backups of. Possible values areFirst,Second,Third,FourthorLast. If specified,weekdaysMUST be specified as well and conflicts withdaysandinclude_last_days.
Nested Schema for configuration.subscriptions.identity.backups.recovery_services_vault.backup_policies.vm.retention.weekly
Optional:
count(Number) The number of backups to keep. Must be between1and9999. Defaults to5.weekdays(List of String) The weekday backups to retain. Possible values areSunday,Monday,Tuesday,Wednesday,Thursday,FridayorSaturday.
Nested Schema for configuration.subscriptions.identity.backups.recovery_services_vault.backup_policies.vm.retention.yearly
Optional:
count(Number) The number of backups to keep. Must be between1and9999. Defaults to7.days(Number) The days of the month to retain backups of. Must be between1and31. If specified,include_last_daysMUST be specified as well and conflicts withweekdaysandweeks.include_last_days(Boolean) Including the last day of the month. If specified,daysMUST be specified as well and conflicts withweekdaysandweeks.months(List of String) The months of the year to retain backups of. Possible values areJanuary,February,March,April,May,June,July,August,September,October,NovemberandDecember. Defaults to["January"].weekdays(List of String) The weekday backups to retain. Possible values areSunday,Monday,Tuesday,Wednesday,Thursday,FridayorSaturday. If specified,weeksMUST be specified as well and conflicts withdaysandinclude_last_days.weeks(List of String) The weeks of the month to retain backups of. Possible values areFirst,Second,Third,FourthorLast. If specified,weekdaysMUST be specified as well and conflicts withdaysandinclude_last_days.
Nested Schema for configuration.subscriptions.identity.backups.recovery_services_vault.backup_policies.vm.frequency
Optional:
daily(Attributes) Sets the backup frequency to daily. Conflicts withhourlyandweekly. (see below for nested schema)hourly(Attributes) Sets the backup frequency to hourly. Conflicts withdailyandweekly. (see below for nested schema)weekly(Attributes) Sets the backup frequency to daily. Conflicts withdailyandhourly. (see below for nested schema)
Nested Schema for configuration.subscriptions.identity.backups.recovery_services_vault.backup_policies.vm.frequency.daily
Required:
time(String) The time of day to perform the backup in 24-hour format. Times must be either on the hour or half hour (e.g. 12:00, 12:30, 13:00, etc.).
Nested Schema for configuration.subscriptions.identity.backups.recovery_services_vault.backup_policies.vm.frequency.hourly
Required:
duration(Number) Species the duration of the backup window in hours. MUST be a number between4and24. Details could be found here.
Note
duration must be multiplier of interval
interval(Number) Specifies the interval at which backup needs to be triggered. Possible values are4,6,8and12.time(String) Specifies the start time of the hourly backup. The time format should be in 24-hour format. Times must be either on the hour or half hour (e.g. 12:00, 12:30, 13:00, etc.).
Nested Schema for configuration.subscriptions.identity.backups.recovery_services_vault.backup_policies.vm.frequency.weekly
Required:
time(String) The time of day to perform the backup in 24-hour format. Times must be either on the hour or half hour (e.g. 12:00, 12:30, 13:00, etc.weekdays(List of String) The weekday backups to retain. Possible values areSunday,Monday,Tuesday,Wednesday,Thursday,FridayorSaturday.
Nested Schema for configuration.subscriptions.identity.backups.recovery_services_vault.backup_policies.vm.policy_type
Optional:
v1(Attributes) Backup Policy V1 configuration. Conflicts with V2. (see below for nested schema)v2(Attributes) Backup Policy V2 (Enhanced Policy) configuration. Conflicts with V1. (see below for nested schema)
Nested Schema for configuration.subscriptions.identity.backups.recovery_services_vault.backup_policies.vm.policy_type.v1
Optional:
instant_restore_retention_days(Number) Specifies the instant restore retention range in days. Possible values are between 1 and 5. Defaults to5.!!! noteinstant_restore_retention_daysMUST be set to5if the backup frequency is set toweekly.
Nested Schema for configuration.subscriptions.identity.backups.recovery_services_vault.backup_policies.vm.policy_type.v2
Optional:
instant_restore_retention_days(Number) Specifies the instant restore retention range in days. Possible values are between 1 and 30. Defaults to7.!!! noteinstant_restore_retention_daysMUST be set to5if the backup frequency is set toweekly.
Nested Schema for configuration.subscriptions.identity.backups.recovery_services_vault.backup_policies.vm.tiering_policy
Required:
archived_restore_point(Attributes) Archived restore point configuration. (see below for nested schema)
Nested Schema for configuration.subscriptions.identity.backups.recovery_services_vault.backup_policies.vm.tiering_policy.archived_restore_point
Required:
mode(String) The tiering mode to control automatic tiering of recovery points. Possible values areTierAfterorTierRecommended.
Optional:
duration(Number) The number of days/weeks/months/years to retain backups in current tier before tiering.duration_type(String) The retention duration type. Possible values areDays,Weeks,MonthsorYears.
Nested Schema for configuration.subscriptions.identity.backups.recovery_services_vault.encryption
Optional:
enabled(Boolean) Enabling/Disabling encryption state using the Key Vault key id created part of volocloud resource. Defaults totrue.!!! warning Once Encryption with your own key has been Enabled it's not possible to Disable it.infrastructure_encryption(Boolean) Enabling/Disabling the Double Encryption state. Defaults tofalse.!!! warning Onceinfrastructure_encryptionhas been set it's not possible to change it.
Nested Schema for configuration.subscriptions.identity.backups.recovery_services_vault.monitoring
Optional:
alerts_for_all_job_failures(Boolean) Enabling/Disabling built-in Azure Monitor alerts for security scenarios and job failure scenarios. Defaults totrue.
Nested Schema for configuration.subscriptions.identity.budgets
Required:
amount(Number) The total amount of cost to track with the budget.notifications(Attributes List) One or more notification objects. (see below for nested schema)
Optional:
time_grain(String) The time covered by a budget. Tracking of the amount will be reset based on the time grain. Possible values areBillingAnnual,BillingMonth,BillingQuarter,Annually,MonthlyandQuarterly. Defaults toMonthly. Changing this forces a new resource to be created.
Nested Schema for configuration.subscriptions.identity.budgets.notifications
Required:
contact_emails(List of String) Specifies a list of email addresses to send the budget notification to when the threshold is exceeded.threshold(Number) Threshold value associated with a notification. Notification is sent when the cost exceeded the threshold. It is always percent and has to be between 0 and 1000.
Optional:
operator(String) The comparison operator for the notification. Possible values areEqualTo,GreaterThan, orGreaterThanOrEqualTo. Defaults toEqualTo.threshold_type(String) The type of threshold for the notification. This determines whether the notification is triggered by forecasted costs or actual costs. The allowed values are Actual and Forecasted. Default is Actual. Changing this forces a new resource to be created.
Nested Schema for configuration.subscriptions.identity.keyvault
Optional:
purge_protection_enabled(Boolean) Is Purge Protection enabled for this Key Vault? Defaults to true.sku(String) The Name of the SKU used for this Key Vault. Possible values are standard and premium. Defaults to standard.soft_delete_retention_days(Number) The number of days that items should be retained for once soft-deleted. This field can only be configured one time and cannot be updated. This value can be between 7 and 90 days. Defaults to 90.
Nested Schema for configuration.subscriptions.identity.microsoft_entra_domain_services
Optional:
admin_vm(Attributes) Provides configuration details for AAD DS Admin VM. (see below for nested schema)enabled(Boolean) (Oprional) Boolean flag to enable/disable Microsoft Entra Domain Services. Defaults to false.notification_recipients(List of String) Provides a list of email addresses to receive notifications from Azure AD Domain Services.sku(String) The SKU to use when provisioning the Domain Service resource. One of Standard, Enterprise or Premium. Defaults to Standard.
Nested Schema for configuration.subscriptions.identity.microsoft_entra_domain_services.admin_vm
Optional:
admin_username(String) Provides a username for the local admin of the Admin VM. Defaults tolocal.admin.computer_name(String) Provides a computer name for the Admin VM. Defaults tomedsadmin.enabled(Boolean) If true, it will create an Admin VM based on Windows 11 Enterprise for Microsoft Entra Domain Services and join it into the AD domain. Defaults tofalse.shutdown_schedule(Attributes) Configures auto-shutdown. For more details see Azure Documentation. (see below for nested schema)spot(Attributes) Use Azure Spot pricing for the Microsoft Entra Domain Services Admin VM. (see below for nested schema)vm_size(String) The VM Size to use for Admin VM. Must be a valid Azure VM size and available in the home region.Defaults toStandard_B2s`.
Nested Schema for configuration.subscriptions.identity.microsoft_entra_domain_services.admin_vm.shutdown_schedule
Optional:
enabled(Boolean) If true, it will configure auto-shutdown for the Microsoft Entra Domain Services Admin VM. Defaults tofalse.notification_email(String) Email address to receive notification of shutdown 30 min before a shutdown event.recurrence_time(String) The time each day when the shutdown schedule takes effect. Must match the format HHmm where HH is 00-23 and mm is 00-59 (e.g. 0930, 2300, etc.). Defaults to0000.recurrence_timezone(String) Specifies the time zone in which the shutdown schedule takes effect. The possible values are defined here. Default isUTC.
Nested Schema for configuration.subscriptions.identity.microsoft_entra_domain_services.admin_vm.spot
Optional:
enabled(Boolean) If true, enables Azure Spot princing for the Admin VM. Defaults tofalse. The SKU provided MUST be supported for Spot pricing, otherwise the creation of the VM will fail. Please double check Azure Region and Spot princing before selecting the SKU.eviction_policy(String) Specifies what should happen when this VM is evicted for price reasons when using a Spot instance. Possible values areDeallocateandDelete. Changing this forces a new resource to be created. Defaults toDeallocate.max_bid_price(Number) The maximum price you're willing to pay for this VM, in US Dollars; which must be greater than the current spot price. If this bid price falls below the current spot price the Virtual Machine will be evicted using the eviction_policy. Defaults to -1, which means that the Virtual Machine should not be evicted for price reasons.
Nested Schema for configuration.subscriptions.identity.resource_groups_lock
Optional:
baseline(Boolean) Boolean flag to enable/disable RG lock. Defaults to true.rsv(Boolean) Boolean flag to enable/disable RG lock. Defaults to false.
Nested Schema for configuration.subscriptions.identity.vnet
Optional:
iaas_subnets(Attributes) Configure IaaS subnets. (see below for nested schema)vnet_link_to_private_dns_zones(List of String) Provides a list of Azure Private DNS Zones to link to this VNET. The zones must be zones created by the volocloud provider: either PaaS private zones or custom private zones.
Nested Schema for configuration.subscriptions.identity.vnet.iaas_subnets
Optional:
app_tier(Attributes) Enables 1 IaaS subnet for app tier services. (see below for nested schema)entrads(Attributes) Enables 1 IaaS subnet for Microsoft Entra Domain Services. (see below for nested schema)
Nested Schema for configuration.subscriptions.identity.vnet.iaas_subnets.app_tier
Required:
ip_address_netnum(Number) Netnum is a whole number that represent the order of the resulting subnet after increasing the bits withnewbits. For example, if given a /24 and a newbits value of 2, the resulting subnet address will have length /26. There are 4 x /26 possible resulting subnets and netnum can choose which one by provinding0,1,2or3.ip_address_newbits(Number) Newbits is the number of additional bits with which to extend the Region'sip_address_mask. For example, if given a /24 and a newbits value of 2, the resulting subnet address will have length /26.
Optional:
delegation(Attributes) Provides details to deleted the subnet to a supported Azure service. (see below for nested schema)service_endpoints(List of String) The list of Service endpoints to associate with the subnet.
Nested Schema for configuration.subscriptions.identity.vnet.iaas_subnets.app_tier.delegation
Required:
name(String) A name for this delegation.service(String) The name of service to delegate to.
Optional:
actions(List of String) A list of Actions which should be delegated. This list is specific to the service to delegate to.
Nested Schema for configuration.subscriptions.identity.vnet.iaas_subnets.entrads
Required:
ip_address_netnum(Number) Netnum is a whole number that represent the order of the resulting subnet after increasing the bits withnewbits. For example, if given a /24 and a newbits value of 2, the resulting subnet address will have length /26. There are 4 x /26 possible resulting subnets and netnum can choose which one by provinding0,1,2or3.ip_address_newbits(Number) Newbits is the number of additional bits with which to extend the Region'sip_address_mask. For example, if given a /24 and a newbits value of 2, the resulting subnet address will have length /26.
Optional:
delegation(Attributes) Provides details to deleted the subnet to a supported Azure service. (see below for nested schema)service_endpoints(List of String) The list of Service endpoints to associate with the subnet.
Nested Schema for configuration.subscriptions.identity.vnet.iaas_subnets.entrads.delegation
Required:
name(String) A name for this delegation.service(String) The name of service to delegate to.
Optional:
actions(List of String) A list of Actions which should be delegated. This list is specific to the service to delegate to.
Nested Schema for configuration.subscriptions.management
Required:
abbreviation(String) This abbreviation will be used to uniquily identify resources created in this subscription. Only applies to resources that require Azure global uniqueness.mdfc(Attributes) Configures Microsoft Defender for Cloud service. (see below for nested schema)
Optional:
automation_account(Attributes) Automation Account configuration details. (see below for nested schema)backups(Attributes) Configuration settings for backups in this subscription. Defaults to {"recovery_services_vault":{"backup_policies":{"file_share":[{"frequency":{"daily":{"time":"23:00"},"hourly":},"name":"daily","retention":{"daily":{"count":33},"monthly": ,"weekly": ,"yearly": },"timezone":"UTC"},{"frequency":{"daily":{"time":"23:00"},"hourly": },"name":"monthly","retention":{"daily":{"count":33},"monthly":{"count":13,"days": ,"include_last_days": ,"weekdays":["Sunday"],"weeks":["Last"]},"weekly":{"count":13,"weekdays":["Saturday"]},"yearly": },"timezone":"UTC"},{"frequency":{"daily":{"time":"23:00"},"hourly": },"name":"weekly","retention":{"daily":{"count":33},"monthly": ,"weekly":{"count":13,"weekdays":["Saturday"]},"yearly": },"timezone":"UTC"},{"frequency":{"daily":{"time":"23:00"},"hourly": },"name":"yearly","retention":{"daily":{"count":33},"monthly":{"count":13,"days": ,"include_last_days": ,"weekdays":["Sunday"],"weeks":["Last"]},"weekly":{"count":13,"weekdays":["Saturday"]},"yearly":{"count":7,"days": ,"include_last_days": ,"months":["January"],"weekdays":["Monday"],"weeks":["First"]}},"timezone":"UTC"}],"vm":[{"frequency":{"daily":{"time":"23:00"},"hourly": ,"weekly": },"name":"daily","policy_type":{"v1": ,"v2":{"instant_restore_retention_days":7}},"retention":{"daily":{"count":33},"monthly": ,"weekly": ,"yearly": },"tiering_policy": ,"timezone":"UTC"},{"frequency":{"daily":{"time":"23:00"},"hourly": ,"weekly": },"name":"monthly","policy_type":{"v1": ,"v2":{"instant_restore_retention_days":7}},"retention":{"daily":{"count":33},"monthly":{"count":13,"days": ,"include_last_days": ,"weekdays":["Sunday"],"weeks":["Last"]},"weekly":{"count":5,"weekdays":["Saturday"]},"yearly": },"tiering_policy": ,"timezone":"UTC"},{"frequency":{"daily":{"time":"23:00"},"hourly": ,"weekly": },"name":"weekly","policy_type":{"v1": ,"v2":{"instant_restore_retention_days":7}},"retention":{"daily":{"count":33},"monthly": ,"weekly":{"count":5,"weekdays":["Saturday"]},"yearly": },"tiering_policy": ,"timezone":"UTC"},{"frequency":{"daily":{"time":"23:00"},"hourly": ,"weekly": },"name":"yearly","policy_type":{"v1": ,"v2":{"instant_restore_retention_days":7}},"retention":{"daily":{"count":33},"monthly":{"count":13,"days": ,"include_last_days": ,"weekdays":["Sunday"],"weeks":["Last"]},"weekly":{"count":5,"weekdays":["Saturday"]},"yearly":{"count":7,"days": ,"include_last_days": ,"months":["January"],"weekdays":["Monday"],"weeks":["First"]}},"tiering_policy": ,"timezone":"UTC"}]},"encryption":{"enabled":true,"infrastructure_encryption":false},"immutability": ,"monitoring":{"alerts_for_all_job_failures":true},"sku":"Standard","soft_delete":true,"storage_mode_type":"GeoRedundant","tags": }} (see below for nested schema) budgets(Attributes List) Provides a list of budget objects. (see below for nested schema)keyvault(Attributes) Azure KeyVault configuration details. (see below for nested schema)log_analytics(Attributes) Log Analytics Workspace configuration. (see below for nested schema)monitoring_agent(List of String) Provides a list of Azure Monitoring Agent services to enable. To disable all services, provide an empty list. Defaults to["uami", "vminsights_dcr", "change_tracking_dcr"]network_watcher_flow_logs(Attributes) Network Watcher Flow Logs configuration details. (see below for nested schema)resource_groups_lock(Attributes) Configures Azure Delete Lock at Resource Groups level. (see below for nested schema)vnet(Attributes) Settings for customizing standard subnets and adding PaaS subnets. (see below for nested schema)
Nested Schema for configuration.subscriptions.management.mdfc
Required:
email(String) Email address to receive alerts from MDFC.
Optional:
enabled(Boolean) Boolean flag to enable/disable Microsoft Defender for Cloud. Defaults totrue.services(List of String) Provides a list of MDFC services to enable. If not provided, all services are enabled by default. To disable all services, provide an empty list.
Nested Schema for configuration.subscriptions.management.automation_account
Optional:
sku(String) The SKU of the account. Possible values are Basic and Free. Defaults to Basic.
Nested Schema for configuration.subscriptions.management.backups
Optional:
recovery_services_vault(Attributes) Configuration settings for Recovery Services Vault in this subscription. Defaults to{"backup_policies":{"file_share":[{"frequency":{"daily":{"time":"23:00"},"hourly":<null>},"name":"daily","retention":{"daily":{"count":33},"monthly":<null>,"weekly":<null>,"yearly":<null>},"timezone":"UTC"},{"frequency":{"daily":{"time":"23:00"},"hourly":<null>},"name":"monthly","retention":{"daily":{"count":33},"monthly":{"count":13,"days":<null>,"include_last_days":<null>,"weekdays":["Sunday"],"weeks":["Last"]},"weekly":{"count":13,"weekdays":["Saturday"]},"yearly":<null>},"timezone":"UTC"},{"frequency":{"daily":{"time":"23:00"},"hourly":<null>},"name":"weekly","retention":{"daily":{"count":33},"monthly":<null>,"weekly":{"count":13,"weekdays":["Saturday"]},"yearly":<null>},"timezone":"UTC"},{"frequency":{"daily":{"time":"23:00"},"hourly":<null>},"name":"yearly","retention":{"daily":{"count":33},"monthly":{"count":13,"days":<null>,"include_last_days":<null>,"weekdays":["Sunday"],"weeks":["Last"]},"weekly":{"count":13,"weekdays":["Saturday"]},"yearly":{"count":7,"days":<null>,"include_last_days":<null>,"months":["January"],"weekdays":["Monday"],"weeks":["First"]}},"timezone":"UTC"}],"vm":[{"frequency":{"daily":{"time":"23:00"},"hourly":<null>,"weekly":<null>},"name":"daily","policy_type":{"v1":<null>,"v2":{"instant_restore_retention_days":7}},"retention":{"daily":{"count":33},"monthly":<null>,"weekly":<null>,"yearly":<null>},"tiering_policy":<null>,"timezone":"UTC"},{"frequency":{"daily":{"time":"23:00"},"hourly":<null>,"weekly":<null>},"name":"monthly","policy_type":{"v1":<null>,"v2":{"instant_restore_retention_days":7}},"retention":{"daily":{"count":33},"monthly":{"count":13,"days":<null>,"include_last_days":<null>,"weekdays":["Sunday"],"weeks":["Last"]},"weekly":{"count":5,"weekdays":["Saturday"]},"yearly":<null>},"tiering_policy":<null>,"timezone":"UTC"},{"frequency":{"daily":{"time":"23:00"},"hourly":<null>,"weekly":<null>},"name":"weekly","policy_type":{"v1":<null>,"v2":{"instant_restore_retention_days":7}},"retention":{"daily":{"count":33},"monthly":<null>,"weekly":{"count":5,"weekdays":["Saturday"]},"yearly":<null>},"tiering_policy":<null>,"timezone":"UTC"},{"frequency":{"daily":{"time":"23:00"},"hourly":<null>,"weekly":<null>},"name":"yearly","policy_type":{"v1":<null>,"v2":{"instant_restore_retention_days":7}},"retention":{"daily":{"count":33},"monthly":{"count":13,"days":<null>,"include_last_days":<null>,"weekdays":["Sunday"],"weeks":["Last"]},"weekly":{"count":5,"weekdays":["Saturday"]},"yearly":{"count":7,"days":<null>,"include_last_days":<null>,"months":["January"],"weekdays":["Monday"],"weeks":["First"]}},"tiering_policy":<null>,"timezone":"UTC"}]},"encryption":{"enabled":true,"infrastructure_encryption":false},"immutability":<null>,"monitoring":{"alerts_for_all_job_failures":true},"sku":"Standard","soft_delete":true,"storage_mode_type":"GeoRedundant","tags":<null>}. (see below for nested schema)
Nested Schema for configuration.subscriptions.management.backups.recovery_services_vault
Optional:
backup_policies(Attributes) Backup policies to be created in this Recovery Services Vault. Defaults to{"file_share":[{"frequency":{"daily":{"time":"23:00"},"hourly":<null>},"name":"daily","retention":{"daily":{"count":33},"monthly":<null>,"weekly":<null>,"yearly":<null>},"timezone":"UTC"},{"frequency":{"daily":{"time":"23:00"},"hourly":<null>},"name":"monthly","retention":{"daily":{"count":33},"monthly":{"count":13,"days":<null>,"include_last_days":<null>,"weekdays":["Sunday"],"weeks":["Last"]},"weekly":{"count":13,"weekdays":["Saturday"]},"yearly":<null>},"timezone":"UTC"},{"frequency":{"daily":{"time":"23:00"},"hourly":<null>},"name":"weekly","retention":{"daily":{"count":33},"monthly":<null>,"weekly":{"count":13,"weekdays":["Saturday"]},"yearly":<null>},"timezone":"UTC"},{"frequency":{"daily":{"time":"23:00"},"hourly":<null>},"name":"yearly","retention":{"daily":{"count":33},"monthly":{"count":13,"days":<null>,"include_last_days":<null>,"weekdays":["Sunday"],"weeks":["Last"]},"weekly":{"count":13,"weekdays":["Saturday"]},"yearly":{"count":7,"days":<null>,"include_last_days":<null>,"months":["January"],"weekdays":["Monday"],"weeks":["First"]}},"timezone":"UTC"}],"vm":[{"frequency":{"daily":{"time":"23:00"},"hourly":<null>,"weekly":<null>},"name":"daily","policy_type":{"v1":<null>,"v2":{"instant_restore_retention_days":7}},"retention":{"daily":{"count":33},"monthly":<null>,"weekly":<null>,"yearly":<null>},"tiering_policy":<null>,"timezone":"UTC"},{"frequency":{"daily":{"time":"23:00"},"hourly":<null>,"weekly":<null>},"name":"monthly","policy_type":{"v1":<null>,"v2":{"instant_restore_retention_days":7}},"retention":{"daily":{"count":33},"monthly":{"count":13,"days":<null>,"include_last_days":<null>,"weekdays":["Sunday"],"weeks":["Last"]},"weekly":{"count":5,"weekdays":["Saturday"]},"yearly":<null>},"tiering_policy":<null>,"timezone":"UTC"},{"frequency":{"daily":{"time":"23:00"},"hourly":<null>,"weekly":<null>},"name":"weekly","policy_type":{"v1":<null>,"v2":{"instant_restore_retention_days":7}},"retention":{"daily":{"count":33},"monthly":<null>,"weekly":{"count":5,"weekdays":["Saturday"]},"yearly":<null>},"tiering_policy":<null>,"timezone":"UTC"},{"frequency":{"daily":{"time":"23:00"},"hourly":<null>,"weekly":<null>},"name":"yearly","policy_type":{"v1":<null>,"v2":{"instant_restore_retention_days":7}},"retention":{"daily":{"count":33},"monthly":{"count":13,"days":<null>,"include_last_days":<null>,"weekdays":["Sunday"],"weeks":["Last"]},"weekly":{"count":5,"weekdays":["Saturday"]},"yearly":{"count":7,"days":<null>,"include_last_days":<null>,"months":["January"],"weekdays":["Monday"],"weeks":["First"]}},"tiering_policy":<null>,"timezone":"UTC"}]}. (see below for nested schema)encryption(Attributes) Encryption configuration for the Recovery Services Vault. Defaults to `` (see below for nested schema)immutability(String) Immutability settings of vault. Possible values areLocked,UnlockedorDisabled.
Warning
Once immutability is set to Locked, changing it to other values forces a new Recovery Services Vault to be created.
monitoring(Attributes) Monitoring configuration for the Recovery Services Vault. Defaults to `` (see below for nested schema)sku(String) Sets the vault's SKU. Possible values areStandardorRS0. Defaults toStandardsoft_delete(Boolean) Is soft delete enable for this Vault? Defaults totrue.storage_mode_type(String) The storage type of the Recovery Services Vault. Possible values areGeoRedundant,LocallyRedundantorZoneRedundant. Defaults toGeoRedundant.
Note
If storage_mode_type is GeoRedundant and there are multiple regions defined in this subscription, cross region restore will be enabled by default, otherwise it will be disabled. Once cross region restore is enabled, changing it back to false forces a new Recovery Service Vault to be created.
- tags (Map of String) Key-value map of resource tags.
Nested Schema for configuration.subscriptions.management.backups.recovery_services_vault.backup_policies
Optional:
file_share(Attributes List) A list of file share backup policies to create. (see below for nested schema)vm(Attributes List) A list of VM backup policies to create. (see below for nested schema)
Nested Schema for configuration.subscriptions.management.backups.recovery_services_vault.backup_policies.file_share
Required:
name(String) Backup policy name MUST be lowercase alphanumeric and dash, between 1 and 80 characters.retention(Attributes) Configures the policy retention. (see below for nested schema)
Optional:
frequency(Attributes) Sets the backup frequency. Exactly one ofdailyorhourlyMUST be specified. (see below for nested schema)timezone(String) Specifies the Time Zone which should be used by the host pool and its associated resources for time based events, the possible values are defined here. Defaults toUTC.
Nested Schema for configuration.subscriptions.management.backups.recovery_services_vault.backup_policies.file_share.retention
Optional:
daily(Attributes) Configures the policy daily retention. (see below for nested schema)monthly(Attributes) Configures the policy monthly retention. Eitherweekdaysandweeksordaysandinclude_last_daysmust be specified. (see below for nested schema)weekly(Attributes) Configures the policy weekly retention. (see below for nested schema)yearly(Attributes) Configures the policy yearly retention. (see below for nested schema)
Nested Schema for configuration.subscriptions.management.backups.recovery_services_vault.backup_policies.file_share.retention.daily
Optional:
count(Number) The number of backups to keep. Must be between1and200. Defaults to33.
Nested Schema for configuration.subscriptions.management.backups.recovery_services_vault.backup_policies.file_share.retention.monthly
Optional:
count(Number) The number of backups to keep. Must be between1and120. Defaults to13.days(Number) The days of the month to retain backups of. Must be between1and31. If specified,include_last_daysMUST be specified as well and conflicts withweekdaysandweeks.include_last_days(Boolean) Including the last day of the month. If specified,daysMUST be specified as well and conflicts withweekdaysandweeks.weekdays(List of String) The weekday backups to retain. Possible values areSunday,Monday,Tuesday,Wednesday,Thursday,FridayorSaturday. If specified,weeksMUST be specified as well and conflicts withdaysandinclude_last_days.weeks(List of String) The weeks of the month to retain backups of. Possible values areFirst,Second,Third,FourthorLast. If specified,weekdaysMUST be specified as well and conflicts withdaysandinclude_last_days.
Nested Schema for configuration.subscriptions.management.backups.recovery_services_vault.backup_policies.file_share.retention.weekly
Optional:
count(Number) The number of backups to keep. Must be between1and200. Defaults to5.weekdays(List of String) The weekday backups to retain. Possible values areSunday,Monday,Tuesday,Wednesday,Thursday,FridayorSaturday.
Nested Schema for configuration.subscriptions.management.backups.recovery_services_vault.backup_policies.file_share.retention.yearly
Optional:
count(Number) The number of backups to keep. Must be between1and10. Defaults to7.days(Number) The days of the month to retain backups of. Must be between1and31. If specified,include_last_daysMUST be specified as well and conflicts withweekdaysandweeks.include_last_days(Boolean) Including the last day of the month. If specified,daysMUST be specified as well and conflicts withweekdaysandweeks.months(List of String) The months of the year to retain backups of. Possible values areJanuary,February,March,April,May,June,July,August,September,October,NovemberandDecember. Defaults to["January"].weekdays(List of String) The weekday backups to retain. Possible values areSunday,Monday,Tuesday,Wednesday,Thursday,FridayorSaturday. If specified,weeksMUST be specified as well and conflicts withdaysandinclude_last_days.weeks(List of String) The weeks of the month to retain backups of. Possible values areFirst,Second,Third,FourthorLast. If specified,weekdaysMUST be specified as well and conflicts withdaysandinclude_last_days.
Nested Schema for configuration.subscriptions.management.backups.recovery_services_vault.backup_policies.file_share.frequency
Optional:
daily(Attributes) Sets the backup frequency to daily. Conflicts withhourly. (see below for nested schema)hourly(Attributes) Sets the backup frequency to hourly. Conflicts withdaily. (see below for nested schema)
Nested Schema for configuration.subscriptions.management.backups.recovery_services_vault.backup_policies.file_share.frequency.daily
Required:
time(String) The time of day to perform the backup in 24-hour format. Times must be either on the hour or half hour (e.g. 12:00, 12:30, 13:00, etc.).
Nested Schema for configuration.subscriptions.management.backups.recovery_services_vault.backup_policies.file_share.frequency.hourly
Required:
duration(Number) Species the duration of the backup window in hours. MUST be a number between4and24. Details could be found here.
Note
duration must be multiplier of interval
interval(Number) Specifies the interval at which backup needs to be triggered. Possible values are4,6,8and12.time(String) Specifies the start time of the hourly backup. The time format should be in 24-hour format. Times must be either on the hour or half hour (e.g. 12:00, 12:30, 13:00, etc.).
Nested Schema for configuration.subscriptions.management.backups.recovery_services_vault.backup_policies.vm
Required:
name(String) Backup policy name MUST be lowercase alphanumeric and dash, between 1 and 80 characters.retention(Attributes) Configures the policy retention. (see below for nested schema)
Optional:
frequency(Attributes) Sets the backup frequency. Exactly one ofdaily,hourlyorweeklyMUST be specified. (see below for nested schema)policy_type(Attributes) Type of the Backup Policy. Possible values arev1orv2. Defaults to{"v1":<null>,"v2":{"instant_restore_retention_days":7}}.
Warning
Changing this forces a new resource to be created.
(see below for nested schema)
- tiering_policy (Attributes) Tiering policy configuration. (see below for nested schema)
- timezone (String) Specifies the Time Zone which should be used by the host pool and its associated resources for time based events, the possible values are defined here. Defaults to UTC.
Nested Schema for configuration.subscriptions.management.backups.recovery_services_vault.backup_policies.vm.retention
Optional:
daily(Attributes) Configures the policy daily retention. (see below for nested schema)monthly(Attributes) Configures the policy monthly retention. Eitherweekdaysandweeksordaysandinclude_last_daysmust be specified. (see below for nested schema)weekly(Attributes) Configures the policy weekly retention. (see below for nested schema)yearly(Attributes) Configures the policy yearly retention. (see below for nested schema)
Nested Schema for configuration.subscriptions.management.backups.recovery_services_vault.backup_policies.vm.retention.daily
Optional:
count(Number) The number of backups to keep. Must be between7and9999. Defaults to33.
Nested Schema for configuration.subscriptions.management.backups.recovery_services_vault.backup_policies.vm.retention.monthly
Optional:
count(Number) The number of backups to keep. Must be between1and9999. Defaults to13.days(Number) The days of the month to retain backups of. Must be between1and31. If specified,include_last_daysMUST be specified as well and conflicts withweekdaysandweeks.include_last_days(Boolean) Including the last day of the month. If specified,daysMUST be specified as well and conflicts withweekdaysandweeks.weekdays(List of String) The weekday backups to retain. Possible values areSunday,Monday,Tuesday,Wednesday,Thursday,FridayorSaturday. If specified,weeksMUST be specified as well and conflicts withdaysandinclude_last_days.weeks(List of String) The weeks of the month to retain backups of. Possible values areFirst,Second,Third,FourthorLast. If specified,weekdaysMUST be specified as well and conflicts withdaysandinclude_last_days.
Nested Schema for configuration.subscriptions.management.backups.recovery_services_vault.backup_policies.vm.retention.weekly
Optional:
count(Number) The number of backups to keep. Must be between1and9999. Defaults to5.weekdays(List of String) The weekday backups to retain. Possible values areSunday,Monday,Tuesday,Wednesday,Thursday,FridayorSaturday.
Nested Schema for configuration.subscriptions.management.backups.recovery_services_vault.backup_policies.vm.retention.yearly
Optional:
count(Number) The number of backups to keep. Must be between1and9999. Defaults to7.days(Number) The days of the month to retain backups of. Must be between1and31. If specified,include_last_daysMUST be specified as well and conflicts withweekdaysandweeks.include_last_days(Boolean) Including the last day of the month. If specified,daysMUST be specified as well and conflicts withweekdaysandweeks.months(List of String) The months of the year to retain backups of. Possible values areJanuary,February,March,April,May,June,July,August,September,October,NovemberandDecember. Defaults to["January"].weekdays(List of String) The weekday backups to retain. Possible values areSunday,Monday,Tuesday,Wednesday,Thursday,FridayorSaturday. If specified,weeksMUST be specified as well and conflicts withdaysandinclude_last_days.weeks(List of String) The weeks of the month to retain backups of. Possible values areFirst,Second,Third,FourthorLast. If specified,weekdaysMUST be specified as well and conflicts withdaysandinclude_last_days.
Nested Schema for configuration.subscriptions.management.backups.recovery_services_vault.backup_policies.vm.frequency
Optional:
daily(Attributes) Sets the backup frequency to daily. Conflicts withhourlyandweekly. (see below for nested schema)hourly(Attributes) Sets the backup frequency to hourly. Conflicts withdailyandweekly. (see below for nested schema)weekly(Attributes) Sets the backup frequency to daily. Conflicts withdailyandhourly. (see below for nested schema)
Nested Schema for configuration.subscriptions.management.backups.recovery_services_vault.backup_policies.vm.frequency.daily
Required:
time(String) The time of day to perform the backup in 24-hour format. Times must be either on the hour or half hour (e.g. 12:00, 12:30, 13:00, etc.).
Nested Schema for configuration.subscriptions.management.backups.recovery_services_vault.backup_policies.vm.frequency.hourly
Required:
duration(Number) Species the duration of the backup window in hours. MUST be a number between4and24. Details could be found here.
Note
duration must be multiplier of interval
interval(Number) Specifies the interval at which backup needs to be triggered. Possible values are4,6,8and12.time(String) Specifies the start time of the hourly backup. The time format should be in 24-hour format. Times must be either on the hour or half hour (e.g. 12:00, 12:30, 13:00, etc.).
Nested Schema for configuration.subscriptions.management.backups.recovery_services_vault.backup_policies.vm.frequency.weekly
Required:
time(String) The time of day to perform the backup in 24-hour format. Times must be either on the hour or half hour (e.g. 12:00, 12:30, 13:00, etc.weekdays(List of String) The weekday backups to retain. Possible values areSunday,Monday,Tuesday,Wednesday,Thursday,FridayorSaturday.
Nested Schema for configuration.subscriptions.management.backups.recovery_services_vault.backup_policies.vm.policy_type
Optional:
v1(Attributes) Backup Policy V1 configuration. Conflicts with V2. (see below for nested schema)v2(Attributes) Backup Policy V2 (Enhanced Policy) configuration. Conflicts with V1. (see below for nested schema)
Nested Schema for configuration.subscriptions.management.backups.recovery_services_vault.backup_policies.vm.policy_type.v1
Optional:
instant_restore_retention_days(Number) Specifies the instant restore retention range in days. Possible values are between 1 and 5. Defaults to5.!!! noteinstant_restore_retention_daysMUST be set to5if the backup frequency is set toweekly.
Nested Schema for configuration.subscriptions.management.backups.recovery_services_vault.backup_policies.vm.policy_type.v2
Optional:
instant_restore_retention_days(Number) Specifies the instant restore retention range in days. Possible values are between 1 and 30. Defaults to7.!!! noteinstant_restore_retention_daysMUST be set to5if the backup frequency is set toweekly.
Nested Schema for configuration.subscriptions.management.backups.recovery_services_vault.backup_policies.vm.tiering_policy
Required:
archived_restore_point(Attributes) Archived restore point configuration. (see below for nested schema)
Nested Schema for configuration.subscriptions.management.backups.recovery_services_vault.backup_policies.vm.tiering_policy.archived_restore_point
Required:
mode(String) The tiering mode to control automatic tiering of recovery points. Possible values areTierAfterorTierRecommended.
Optional:
duration(Number) The number of days/weeks/months/years to retain backups in current tier before tiering.duration_type(String) The retention duration type. Possible values areDays,Weeks,MonthsorYears.
Nested Schema for configuration.subscriptions.management.backups.recovery_services_vault.encryption
Optional:
enabled(Boolean) Enabling/Disabling encryption state using the Key Vault key id created part of volocloud resource. Defaults totrue.!!! warning Once Encryption with your own key has been Enabled it's not possible to Disable it.infrastructure_encryption(Boolean) Enabling/Disabling the Double Encryption state. Defaults tofalse.!!! warning Onceinfrastructure_encryptionhas been set it's not possible to change it.
Nested Schema for configuration.subscriptions.management.backups.recovery_services_vault.monitoring
Optional:
alerts_for_all_job_failures(Boolean) Enabling/Disabling built-in Azure Monitor alerts for security scenarios and job failure scenarios. Defaults totrue.
Nested Schema for configuration.subscriptions.management.budgets
Required:
amount(Number) The total amount of cost to track with the budget.notifications(Attributes List) One or more notification objects. (see below for nested schema)
Optional:
time_grain(String) The time covered by a budget. Tracking of the amount will be reset based on the time grain. Possible values areBillingAnnual,BillingMonth,BillingQuarter,Annually,MonthlyandQuarterly. Defaults toMonthly. Changing this forces a new resource to be created.
Nested Schema for configuration.subscriptions.management.budgets.notifications
Required:
contact_emails(List of String) Specifies a list of email addresses to send the budget notification to when the threshold is exceeded.threshold(Number) Threshold value associated with a notification. Notification is sent when the cost exceeded the threshold. It is always percent and has to be between 0 and 1000.
Optional:
operator(String) The comparison operator for the notification. Possible values areEqualTo,GreaterThan, orGreaterThanOrEqualTo. Defaults toEqualTo.threshold_type(String) The type of threshold for the notification. This determines whether the notification is triggered by forecasted costs or actual costs. The allowed values are Actual and Forecasted. Default is Actual. Changing this forces a new resource to be created.
Nested Schema for configuration.subscriptions.management.keyvault
Optional:
purge_protection_enabled(Boolean) Is Purge Protection enabled for this Key Vault? Defaults to true.sku(String) The Name of the SKU used for this Key Vault. Possible values are standard and premium. Defaults to standard.soft_delete_retention_days(Number) The number of days that items should be retained for once soft-deleted. This field can only be configured one time and cannot be updated. This value can be between 7 and 90 days. Defaults to 90.
Nested Schema for configuration.subscriptions.management.log_analytics
Optional:
daily_quota_gb(Number) The workspace daily quota for ingestion in GB. Defaults to -1 (unlimited).internet_ingestion_enabled(Boolean) Should the Log Analytics Workspace support ingestion over the Public Internet? Defaults to true.internet_query_enabled(Boolean) Should the Log Analytics Workspace support querying over the Public Internet? Defaults to true.reservation_capacity_in_gb_per_day(Number) The capacity reservation level in GB for this workspace. Must be in increments of 100 between 100 and 5000.retention_in_days(Number) The workspace data retention in days. Possible values are either 7 (Free Tier only) or range between 30 and 730. Defaults to 30.sku(String) Specifies the SKU of the Log Analytics Workspace. Possible values are Free, PerNode, Premium, Standard, Standalone, Unlimited, CapacityReservation, and PerGB2018 (new SKU as of 2018-04-03). Defaults to PerGB2018.solutions(List of String) List of solutions to deploy to the Log Analytics Workspace. Defaults to ["monitoring_for_vm", "monitoring_for_vmss", "solution_for_change_tracking"]
Nested Schema for configuration.subscriptions.management.network_watcher_flow_logs
Optional:
retention_policy(Attributes) A retention_policy object. (see below for nested schema)traffic_analytics(Attributes) A traffic_analytics object. (see below for nested schema)
Nested Schema for configuration.subscriptions.management.network_watcher_flow_logs.retention_policy
Optional:
days(Number) The number of days to retain flow log records. Defaults to 30 days.enabled(Boolean) Boolean flag to enable/disable retention. Defaults to true.
Nested Schema for configuration.subscriptions.management.network_watcher_flow_logs.traffic_analytics
Optional:
enabled(Boolean) Boolean flag to enable/disable traffic analytics. Defaults to false.interval_in_minutes(Number) How frequently service should do flow analytics in minutes. Defaults to 60.
Nested Schema for configuration.subscriptions.management.resource_groups_lock
Optional:
baseline(Boolean) Boolean flag to enable/disable RG lock. Defaults to true.rsv(Boolean) Boolean flag to enable/disable RG lock. Defaults to false.
Nested Schema for configuration.subscriptions.management.vnet
Optional:
iaas_subnets(Attributes) Configure IaaS subnets. (see below for nested schema)paas_subnets(Attributes) Configure PaaS subnets. (see below for nested schema)vnet_link_to_private_dns_zones(List of String) Provides a list of Azure Private DNS Zones to link to this VNET. The zones must be zones created by the volocloud provider: either PaaS private zones or custom private zones.
Nested Schema for configuration.subscriptions.management.vnet.iaas_subnets
Optional:
app_tier(Attributes) Enables 1 IaaS subnet for app tier services. (see below for nested schema)data_tier(Attributes) Enables 1 IaaS subnet for data tier services. (see below for nested schema)web_tier(Attributes) Enables 1 IaaS subnet for web tier (internet facing) services. (see below for nested schema)
Nested Schema for configuration.subscriptions.management.vnet.iaas_subnets.app_tier
Required:
ip_address_netnum(Number) Netnum is a whole number that represent the order of the resulting subnet after increasing the bits withnewbits. For example, if given a /24 and a newbits value of 2, the resulting subnet address will have length /26. There are 4 x /26 possible resulting subnets and netnum can choose which one by provinding0,1,2or3.ip_address_newbits(Number) Newbits is the number of additional bits with which to extend the Region'sip_address_mask. For example, if given a /24 and a newbits value of 2, the resulting subnet address will have length /26.
Optional:
delegation(Attributes) Provides details to deleted the subnet to a supported Azure service. (see below for nested schema)service_endpoints(List of String) The list of Service endpoints to associate with the subnet.
Nested Schema for configuration.subscriptions.management.vnet.iaas_subnets.app_tier.delegation
Required:
name(String) A name for this delegation.service(String) The name of service to delegate to.
Optional:
actions(List of String) A list of Actions which should be delegated. This list is specific to the service to delegate to.
Nested Schema for configuration.subscriptions.management.vnet.iaas_subnets.data_tier
Required:
ip_address_netnum(Number) Netnum is a whole number that represent the order of the resulting subnet after increasing the bits withnewbits. For example, if given a /24 and a newbits value of 2, the resulting subnet address will have length /26. There are 4 x /26 possible resulting subnets and netnum can choose which one by provinding0,1,2or3.ip_address_newbits(Number) Newbits is the number of additional bits with which to extend the Region'sip_address_mask. For example, if given a /24 and a newbits value of 2, the resulting subnet address will have length /26.
Optional:
delegation(Attributes) Provides details to deleted the subnet to a supported Azure service. (see below for nested schema)service_endpoints(List of String) The list of Service endpoints to associate with the subnet.
Nested Schema for configuration.subscriptions.management.vnet.iaas_subnets.data_tier.delegation
Required:
name(String) A name for this delegation.service(String) The name of service to delegate to.
Optional:
actions(List of String) A list of Actions which should be delegated. This list is specific to the service to delegate to.
Nested Schema for configuration.subscriptions.management.vnet.iaas_subnets.web_tier
Required:
ip_address_netnum(Number) Netnum is a whole number that represent the order of the resulting subnet after increasing the bits withnewbits. For example, if given a /24 and a newbits value of 2, the resulting subnet address will have length /26. There are 4 x /26 possible resulting subnets and netnum can choose which one by provinding0,1,2or3.ip_address_newbits(Number) Newbits is the number of additional bits with which to extend the Region'sip_address_mask. For example, if given a /24 and a newbits value of 2, the resulting subnet address will have length /26.
Optional:
delegation(Attributes) Provides details to deleted the subnet to a supported Azure service. (see below for nested schema)service_endpoints(List of String) The list of Service endpoints to associate with the subnet.
Nested Schema for configuration.subscriptions.management.vnet.iaas_subnets.web_tier.delegation
Required:
name(String) A name for this delegation.service(String) The name of service to delegate to.
Optional:
actions(List of String) A list of Actions which should be delegated. This list is specific to the service to delegate to.
Nested Schema for configuration.subscriptions.management.vnet.paas_subnets
Optional:
app_tier(Attributes Map) Enables PaaS subnets for app tier services. The map keys CAN be on of:aci,etc. (see below for nested schema)data_tier(Attributes Map) Enables 1 PaaS subnet for data tier services. The map keys CAN be on of:pgsqlandsqlmi. (see below for nested schema)web_tier(Attributes Map) Enables 1 PaaS subnet for web tier (internet facing) services. The map keys CAN be on of:agw. (see below for nested schema)
Nested Schema for configuration.subscriptions.management.vnet.paas_subnets.app_tier
Required:
delegation(Attributes) Provides details to deleted the subnet to a supported Azure service. (see below for nested schema)ip_address_netnum(Number) Netnum is a whole number that represent the order of the resulting subnet after increasing the bits withnewbits. For example, if given a /24 and a newbits value of 2, the resulting subnet address will have length /26. There are 4 x /26 possible resulting subnets and netnum can choose which one by provinding0,1,2or3.ip_address_newbits(Number) Newbits is the number of additional bits with which to extend the Region'sip_address_mask. For example, if given a /24 and a newbits value of 2, the resulting subnet address will have length /26.
Optional:
service_endpoints(List of String) The list of Service endpoints to associate with the subnet.
Nested Schema for configuration.subscriptions.management.vnet.paas_subnets.app_tier.delegation
Required:
name(String) A name for this delegation.service(String) The name of service to delegate to.
Optional:
actions(List of String) A list of Actions which should be delegated. This list is specific to the service to delegate to.
Nested Schema for configuration.subscriptions.management.vnet.paas_subnets.data_tier
Required:
delegation(Attributes) Provides details to deleted the subnet to a supported Azure service. (see below for nested schema)ip_address_netnum(Number) Netnum is a whole number that represent the order of the resulting subnet after increasing the bits withnewbits. For example, if given a /24 and a newbits value of 2, the resulting subnet address will have length /26. There are 4 x /26 possible resulting subnets and netnum can choose which one by provinding0,1,2or3.ip_address_newbits(Number) Newbits is the number of additional bits with which to extend the Region'sip_address_mask. For example, if given a /24 and a newbits value of 2, the resulting subnet address will have length /26.
Optional:
service_endpoints(List of String) The list of Service endpoints to associate with the subnet.
Nested Schema for configuration.subscriptions.management.vnet.paas_subnets.data_tier.delegation
Required:
name(String) A name for this delegation.service(String) The name of service to delegate to.
Optional:
actions(List of String) A list of Actions which should be delegated. This list is specific to the service to delegate to.
Nested Schema for configuration.subscriptions.management.vnet.paas_subnets.web_tier
Required:
delegation(Attributes) Provides details to deleted the subnet to a supported Azure service. (see below for nested schema)ip_address_netnum(Number) Netnum is a whole number that represent the order of the resulting subnet after increasing the bits withnewbits. For example, if given a /24 and a newbits value of 2, the resulting subnet address will have length /26. There are 4 x /26 possible resulting subnets and netnum can choose which one by provinding0,1,2or3.ip_address_newbits(Number) Newbits is the number of additional bits with which to extend the Region'sip_address_mask. For example, if given a /24 and a newbits value of 2, the resulting subnet address will have length /26.
Optional:
service_endpoints(List of String) The list of Service endpoints to associate with the subnet.
Nested Schema for configuration.subscriptions.management.vnet.paas_subnets.web_tier.delegation
Required:
name(String) A name for this delegation.service(String) The name of service to delegate to.
Optional:
actions(List of String) A list of Actions which should be delegated. This list is specific to the service to delegate to.
Nested Schema for credentials
Read-Only:
client_id(String, Sensitive) Service Principal client ID configured in the target Azure tenant.client_secret(String, Sensitive) Service Principal client secret configured in the target Azure tenant.subscription_id(String, Sensitive) Target Azure Subscription ID.tenant_id(String, Sensitive) Target Azure tenant ID.