FHS-5749 module policy and instance names variables-document updated with values

Author: narendra-asadi

docs/usage.md

@@ -60,6 +60,7 @@ module "my_backup" {
   backup_vault_immutability  = "Unlocked"
   log_analytics_workspace_id = azurerm_log_analytics_workspace.my_workspace.id
   use_extended_retention     = true
+  soft_delete                = "Off"
 
   tags = {
     tagOne   = "tagOneValue"
@@ -76,20 +77,13 @@ module "my_backup" {
       storage_account_containers = ["container1", "container2"]
     }
     backup2 = {
-      backup_name                = "storage2"
-      retention_period           = "P30D"
-      backup_intervals           = ["R/2024-01-01T00:00:00+00:00/P2D"]
-      storage_account_id         = azurerm_storage_account.my_storage_account_2.id
-      storage_account_containers = ["container1", "container2"]
-    }
-    backup3 = {
-      backup_name                     = "storage3"
+      backup_name                     = "storage2"
       retention_period                = "P30D"
       backup_intervals                = ["R/2024-01-01T00:00:00+00:00/P2D"]
       storage_account_id              = azurerm_storage_account.my_storage_account_2.id
       storage_account_containers      = ["container1", "container2"]
-      backup_policy_naming_template   = nhsuk-bkpol-blob3-uks
-      backup_instance_naming_template = nhsuk-bkinst-blob3-uks
+      backup_policy_naming_template   = "nhsuk-{resource_abbreviation}-{resource_type}-{backup_name}"
+      backup_instance_naming_template = "nhsuk-{resource_abbreviation}-{resource_type}-{backup_name}"
     }
   }
   managed_disk_backups = {
@@ -104,22 +98,12 @@ module "my_backup" {
       }
     }
     backup2 = {
-      backup_name                 = "disk2"
-      retention_period            = "P30D"
-      backup_intervals            = ["R/2024-01-01T00:00:00+00:00/P2D"]
-      managed_disk_id             = azurerm_managed_disk.my_managed_disk_2.id
-      managed_disk_resource_group = {
-        id   = azurerm_resource_group.my_resource_group.id
-        name = azurerm_resource_group.my_resource_group.name
-      }
-    }
-    backup3 = {
-      backup_name                     = "disk3"
+      backup_name                     = "disk2"
       retention_period                = "P30D"
       backup_intervals                = ["R/2024-01-01T00:00:00+00:00/P2D"]
       managed_disk_id                 = azurerm_managed_disk.my_managed_disk_2.id
-      backup_policy_naming_template   = nhsuk-bkpol-disk3-uks
-      backup_instance_naming_template = nhsuk-bkinst-disk3-uks
+      backup_policy_naming_template   = "nhsuk-{resource_abbreviation}-{resource_type}-{backup_name}"
+      backup_instance_naming_template = "nhsuk-{resource_abbreviation}-{resource_type}-{backup_name}"
       managed_disk_resource_group = {
         id   = azurerm_resource_group.my_resource_group.id
         name = azurerm_resource_group.my_resource_group.name
@@ -135,20 +119,13 @@ module "my_backup" {
       server_resource_group_id = azurerm_resource_group.my_resource_group.id
     }
     backup2 = {
-      backup_name              = "server2"
-      retention_period         = "P30D"
-      backup_intervals         = ["R/2024-01-01T00:00:00+00:00/P2D"]
-      server_id                = azurerm_postgresql_flexible_server.my_server_2.id
-      server_resource_group_id = azurerm_resource_group.my_resource_group.id
-    }
-    backup3 = {
-      backup_name                     = "server3"
+      backup_name                     = "server2"
       retention_period                = "P30D"
       backup_intervals                = ["R/2024-01-01T00:00:00+00:00/P2D"]
       server_id                       = azurerm_postgresql_flexible_server.my_server_2.id
       server_resource_group_id        = azurerm_resource_group.my_resource_group.id
-      backup_policy_naming_template   = nhsuk-bkpol-pgflex3-uks
-      backup_instance_naming_template = nhsuk-bkinst-pgflex3-uks
+      backup_policy_naming_template   = "nhsuk-{resource_abbreviation}-{resource_type}-{backup_name}"
+      backup_instance_naming_template = "nhsuk-{resource_abbreviation}-{resource_type}-{backup_name}"
     }
   }
 }
@@ -174,22 +151,22 @@ module "my_backup" {
 | `blob_storage_backups.backup_name` | The name of the backup, which must be unique across blob storage backups. | Yes | n/a |
 | `blob_storage_backups.retention_period` | How long the backed up data will be retained for, which should be in `ISO 8601` duration format. This must be specified in days, and can be up to 7 days unless `use_extended_retention` is on. [See the following link for more information about the format](https://en.wikipedia.org/wiki/ISO_8601#Durations). | Yes | n/a |
 | `blob_storage_backups.backup_intervals` | A list of intervals at which backups should be taken, which should be in `ISO 8601` duration format. [See the following link for the possible values](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). | Yes | n/a |
-| `blob_storage_backups.backup_policy_naming_template` | Naming template allows existing teams to preserve pre-existing blob policy names while enabling consistent naming. | No | {resource_abbreviation}-blob-{backup_name} |
-| `blob_storage_backups.backup_instance_naming_template` | Naming template allows existing teams to preserve pre-existing blob instance names while enabling consistent naming. | No | {resource_abbreviation}-blob-{backup_name} |
+| `blob_storage_backups.backup_policy_naming_template` | Naming template used to construct the blob backup instance name. The following placeholders are supported and will be replaced by the module: `{resource_abbreviation}` → `bkpol`, `{resource_type}` → `blob`, `{backup_name}` → value of `blob_storage_backups.backup_name` | No | {resource_abbreviation}-{resource_type}-{backup_name} |
+| `blob_storage_backups.backup_instance_naming_template` | Naming template used to construct the blob backup instance name. The following placeholders are supported and will be replaced by the module: `{resource_abbreviation}` → `bkinst`, `{resource_type}` → `blob`, `{backup_name}` → value of `blob_storage_backups.backup_name` | No | {resource_abbreviation}-{resource_type}-{backup_name} |
 | `blob_storage_backups.time_zone` | The time zone to apply to the backup policy schedule (eg. Europe/London). If not specified, Azure’s default time zone behaviour is used. | No | n/a |
 | `blob_storage_backups.enable_daily_retention_rule` | Enables an additional daily retention rule on the backup policy. This is optional and intended for scenarios that require explicit daily retention behaviour beyond the default policy configuration. | No | false |
 | `managed_disk_backups` | A map of managed disk backups that should be created. For each backup the following values should be provided: `managed_disk_id`, `backup_name` and `retention_period`. When no value is provided then no backups are created. | No | n/a |
 | `managed_disk_backups.managed_disk_id` | The id of the managed disk that should be backed up. | Yes | n/a |
 | `managed_disk_backups.backup_name` | The name of the backup, which must be unique across managed disk backups. | Yes | n/a |
 | `managed_disk_backups.retention_period` | How long the backed up data will be retained for, which should be in `ISO 8601` duration format. This must be specified in days, and can be up to 7 days unless `use_extended_retention` is on. [See the following link for more information about the format](https://en.wikipedia.org/wiki/ISO_8601#Durations). | Yes | n/a |
 | `managed_disk_backups.backup_intervals` | A list of intervals at which backups should be taken, which should be in `ISO 8601` duration format. [See the following link for the possible values](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). | Yes | n/a |
-| `managed_disk_backup.backup_policy_naming_template` | Naming template allows existing teams to preserve pre-existing disk policy names while enabling consistent naming. | No | {resource_abbreviation}-disk-{backup_name} |
-| `managed_disk_backup.backup_instance_naming_template` | Naming template allows existing teams to preserve pre-existing disk instance names while enabling consistent naming. | No | {resource_abbreviation}-disk-{backup_name} |
+| `managed_disk_backup.backup_policy_naming_template` | Naming template used to construct the disk backup instance name. The following placeholders are supported and will be replaced by the module: `{resource_abbreviation}` → `bkpol`, `{resource_type}` → `disk`, `{backup_name}` → value of `managed_disk_backup.backup_name` | No | {resource_abbreviation}-{resource_type}-{backup_name} |
+| `managed_disk_backup.backup_instance_naming_template` | Naming template used to construct the disk backup instance name. The following placeholders are supported and will be replaced by the module: `{resource_abbreviation}` → `bkinst`, `{resource_type}` → `disk`, `{backup_name}` → value of `managed_disk_backup.backup_name` | No | {resource_abbreviation}-{resource_type}-{backup_name} |
 | `postgresql_flexible_server_backups` | A map of postgresql flexible server backups that should be created. For each backup the following values should be provided: `backup_name`, `server_id`, `server_resource_group_id`, `retention_period` and `backup_intervals`. When no value is provided then no backups are created. | No | n/a |
 | `postgresql_flexible_server_backups.backup_name` | The name of the backup, which must be unique across postgresql flexible server backups. | Yes | n/a |
 | `postgresql_flexible_server_backups.server_id` | The id of the postgresql flexible server that should be backed up. | Yes | n/a |
 | `postgresql_flexible_server_backups.server_resource_group_id` | The id of the resource group which the postgresql flexible server resides in. | Yes | n/a |
 | `postgresql_flexible_server_backups.retention_period` | How long the backed up data will be retained for, which should be in `ISO 8601` duration format. This must be specified in days, and can be up to 7 days unless `use_extended_retention` is on. [See the following link for more information about the format](https://en.wikipedia.org/wiki/ISO_8601#Durations). | Yes | n/a |
 | `postgresql_flexible_server_backups.backup_intervals` | A list of intervals at which backups should be taken, which should be in `ISO 8601` duration format. [See the following link for the possible values](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals). | Yes | n/a |
-| `postgresql_flexible_server_backup.backup_policy_naming_template` | Naming template allows existing teams to preserve pre-existing pgflex policy names while enabling consistent naming. | No | {resource_abbreviation}-pgflex-{backup_name} |
-| `postgresql_flexible_server_backup.backup_instance_naming_template` | Naming template allows existing teams to preserve pre-existing pgflex instance names while enabling consistent naming. | No | {resource_abbreviation}-pgflex-{backup_name} |
+| `postgresql_flexible_server_backup.backup_policy_naming_template` | Naming template used to construct the pgflex server backup instance name. The following placeholders are supported and will be replaced by the module: `{resource_abbreviation}` → `bkpol`, `{resource_type}` → `pgflex`, `{backup_name}` → value of `postgresql_flexible_server_backup.backup_name` | No | {resource_abbreviation}-{resource_type}-{backup_name} |
+| `postgresql_flexible_server_backup.backup_instance_naming_template` | Naming template used to construct the pgflex server backup instance name. The following placeholders are supported and will be replaced by the module: `{resource_abbreviation}` → `bkinst`, `{resource_type}` → `pgflex`, `{backup_name}` → value of `postgresql_flexible_server_backup.backup_name` | No | {resource_abbreviation}-{resource_type}-{backup_name} |