fixed incorrect parameter description

Azure · Nov 26, 2024 · 6e01675 · 6e01675
1 parent e2a7339
commit 6e01675
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 37 deletions.
diff --git a/avm/res/recovery-services/vault/README.md b/avm/res/recovery-services/vault/README.md
@@ -2703,6 +2703,7 @@ param tags = {
 | Parameter | Type | Description |
 | :-- | :-- | :-- |
 | [`name`](#parameter-name) | string | Name of the Azure Recovery Service Vault. |
+| [`restoreSettings`](#parameter-restoresettings) | object | The restore settings of the vault. |
 
 **Optional parameters**
 
@@ -2725,7 +2726,6 @@ param tags = {
 | [`replicationAlertSettings`](#parameter-replicationalertsettings) | object | Replication alert settings. |
 | [`replicationFabrics`](#parameter-replicationfabrics) | array | List of all replication fabrics. |
 | [`replicationPolicies`](#parameter-replicationpolicies) | array | List of all replication policies. |
-| [`restoreSettings`](#parameter-restoresettings) | object | The restore settings of the vault. |
 | [`roleAssignments`](#parameter-roleassignments) | array | Array of role assignments to create. |
 | [`securitySettings`](#parameter-securitysettings) | object | Security Settings of the vault. |
 | [`tags`](#parameter-tags) | object | Tags of the Recovery Service Vault resource. |
@@ -2737,6 +2737,39 @@ Name of the Azure Recovery Service Vault.
 - Required: Yes
 - Type: string
 
+### Parameter: `restoreSettings`
+
+The restore settings of the vault.
+
+- Required: No
+- Type: object
+
+**Optional parameters**
+
+| Parameter | Type | Description |
+| :-- | :-- | :-- |
+| [`crossSubscriptionRestoreSettings`](#parameter-restoresettingscrosssubscriptionrestoresettings) | object | The restore settings of the vault. |
+
+### Parameter: `restoreSettings.crossSubscriptionRestoreSettings`
+
+The restore settings of the vault.
+
+- Required: Yes
+- Type: object
+
+**Optional parameters**
+
+| Parameter | Type | Description |
+| :-- | :-- | :-- |
+| [`crossSubscriptionRestoreState`](#parameter-restoresettingscrosssubscriptionrestoresettingscrosssubscriptionrestorestate) | string | The restore settings of the vault. |
+
+### Parameter: `restoreSettings.crossSubscriptionRestoreSettings.crossSubscriptionRestoreState`
+
+The restore settings of the vault.
+
+- Required: No
+- Type: string
+
 ### Parameter: `backupConfig`
 
 The backup configuration.
@@ -3538,39 +3571,6 @@ List of all replication policies.
 - Type: array
 - Default: `[]`
 
-### Parameter: `restoreSettings`
-
-The restore settings of the vault.
-
-- Required: No
-- Type: object
-
-**Optional parameters**
-
-| Parameter | Type | Description |
-| :-- | :-- | :-- |
-| [`crossSubscriptionRestoreSettings`](#parameter-restoresettingscrosssubscriptionrestoresettings) | object | The restore settings of the vault. |
-
-### Parameter: `restoreSettings.crossSubscriptionRestoreSettings`
-
-The restore settings of the vault.
-
-- Required: Yes
-- Type: object
-
-**Optional parameters**
-
-| Parameter | Type | Description |
-| :-- | :-- | :-- |
-| [`crossSubscriptionRestoreState`](#parameter-restoresettingscrosssubscriptionrestoresettingscrosssubscriptionrestorestate) | string | The restore settings of the vault. |
-
-### Parameter: `restoreSettings.crossSubscriptionRestoreSettings.crossSubscriptionRestoreState`
-
-The restore settings of the vault.
-
-- Required: No
-- Type: string
-
 ### Parameter: `roleAssignments`
 
 Array of role assignments to create.

diff --git a/avm/res/recovery-services/vault/main.bicep b/avm/res/recovery-services/vault/main.bicep
@@ -66,7 +66,7 @@ param publicNetworkAccess string = 'Disabled'
 @description('Optional. The redundancy settings of the vault.')
 param redundancySettings redundancySettingsType?
 
-@description('Optional. The restore settings of the vault.')
+@description('Required. The restore settings of the vault.')
 param restoreSettings restoreSettingsType?
 
 import { customerManagedKeyWithAutoRotateType } from 'br/public:avm/utl/types/avm-common-types:0.4.0'

diff --git a/avm/res/recovery-services/vault/main.json b/avm/res/recovery-services/vault/main.json
@@ -6,7 +6,7 @@
     "_generator": {
       "name": "bicep",
       "version": "0.31.92.45157",
-      "templateHash": "5096948249327950906"
+      "templateHash": "1712426944669593956"
     },
     "name": "Recovery Services Vaults",
     "description": "This module deploys a Recovery Services Vault.",
@@ -733,7 +733,7 @@
       "$ref": "#/definitions/restoreSettingsType",
       "nullable": true,
       "metadata": {
-        "description": "Optional. The restore settings of the vault."
+        "description": "Required. The restore settings of the vault."
       }
     },
     "customerManagedKey": {