fix: Fixed readme formatting of allowed values specified in UDT & fin…

…alized recursion (#638) ## Description - Fixed bug regarding an incorrect formatting for allowed values in UDTs - Fixed bug of not generating infinite tested UDTs - Finally reworked the Parameter Script to be fully recursive - It will show several changes as both the top-level table and nested tables follow a common syntax (otherwise the recursion wouldn't work) TODO: Regenerate all ReadMes. @eriqua we should probably get the test PRs in first, but it doesn't matter that much. However, I'm not going to regenerate the ReadMe's until we have a window to merge this PR. Otherwise I'll be busier resolving conflicts than anything else. | Pipeline | | - | | | --------- Co-authored-by: Erika Gressi <[email protected]>
Azure · Dec 2, 2023 · bd9ef71 · bd9ef71
1 parent 039f0f7
commit bd9ef71
Show file tree

Hide file tree

Showing 100 changed files with 7,246 additions and 5,092 deletions.
diff --git a/avm/res/batch/batch-account/README.md b/avm/res/batch/batch-account/README.md
diff --git a/avm/res/cognitive-services/account/README.md b/avm/res/cognitive-services/account/README.md
diff --git a/avm/res/compute/ssh-public-key/README.md b/avm/res/compute/ssh-public-key/README.md
@@ -330,130 +330,165 @@ module sshPublicKey 'br/public:avm/res/compute/ssh-public-key:<version>' = {
 | [`roleAssignments`](#parameter-roleassignments) | array | Array of role assignments to create. |
 | [`tags`](#parameter-tags) | object | Tags of the availability set resource. |
 
+### Parameter: `name`
+
+The name of the SSH public Key that is being created.
+
+- Required: Yes
+- Type: string
+
 ### Parameter: `enableTelemetry`
 
 Enable/Disable usage telemetry for module.
+
 - Required: No
 - Type: bool
 - Default: `True`
 
 ### Parameter: `location`
 
 Resource location.
+
 - Required: No
 - Type: string
 - Default: `[resourceGroup().location]`
 
 ### Parameter: `lock`
 
 The lock settings of the service.
+
 - Required: No
 - Type: object
 
+**Optional parameters**
 
-| Name | Required | Type | Description |
-| :-- | :-- | :--| :-- |
-| [`kind`](#parameter-lockkind) | No | string | Optional. Specify the type of lock. |
-| [`name`](#parameter-lockname) | No | string | Optional. Specify the name of lock. |
+| Parameter | Type | Description |
+| :-- | :-- | :-- |
+| [`kind`](#parameter-lockkind) | string | Specify the type of lock. |
+| [`name`](#parameter-lockname) | string | Specify the name of lock. |
 
 ### Parameter: `lock.kind`
 
-Optional. Specify the type of lock.
+Specify the type of lock.
 
 - Required: No
 - Type: string
-- Allowed: `[CanNotDelete, None, ReadOnly]`
+- Allowed:
+  ```Bicep
+  [
+    'CanNotDelete'
+    'None'
+    'ReadOnly'
+  ]
+  ```
 
 ### Parameter: `lock.name`
 
-Optional. Specify the name of lock.
+Specify the name of lock.
 
 - Required: No
 - Type: string
 
-### Parameter: `name`
-
-The name of the SSH public Key that is being created.
-- Required: Yes
-- Type: string
-
 ### Parameter: `publicKey`
 
 SSH public key used to authenticate to a virtual machine through SSH. If this property is not initially provided when the resource is created, the publicKey property will be populated when generateKeyPair is called. If the public key is provided upon resource creation, the provided public key needs to be at least 2048-bit and in ssh-rsa format.
+
 - Required: No
 - Type: string
 
 ### Parameter: `roleAssignments`
 
 Array of role assignments to create.
+
 - Required: No
 - Type: array
 
+**Required parameters**
 
-| Name | Required | Type | Description |
-| :-- | :-- | :--| :-- |
-| [`condition`](#parameter-roleassignmentscondition) | No | string | Optional. The conditions on the role assignment. This limits the resources it can be assigned to. e.g.: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase "foo_storage_container" |
-| [`conditionVersion`](#parameter-roleassignmentsconditionversion) | No | string | Optional. Version of the condition. |
-| [`delegatedManagedIdentityResourceId`](#parameter-roleassignmentsdelegatedmanagedidentityresourceid) | No | string | Optional. The Resource Id of the delegated managed identity resource. |
-| [`description`](#parameter-roleassignmentsdescription) | No | string | Optional. The description of the role assignment. |
-| [`principalId`](#parameter-roleassignmentsprincipalid) | Yes | string | Required. The principal ID of the principal (user/group/identity) to assign the role to. |
-| [`principalType`](#parameter-roleassignmentsprincipaltype) | No | string | Optional. The principal type of the assigned principal ID. |
-| [`roleDefinitionIdOrName`](#parameter-roleassignmentsroledefinitionidorname) | Yes | string | Required. The role to assign. You can provide either the display name of the role definition, the role definition GUID, or its fully qualified ID in the following format: '/providers/Microsoft.Authorization/roleDefinitions/c2f4ef07-c644-48eb-af81-4b1b4947fb11'. |
+| Parameter | Type | Description |
+| :-- | :-- | :-- |
+| [`principalId`](#parameter-roleassignmentsprincipalid) | string | The principal ID of the principal (user/group/identity) to assign the role to. |
+| [`roleDefinitionIdOrName`](#parameter-roleassignmentsroledefinitionidorname) | string | The role to assign. You can provide either the display name of the role definition, the role definition GUID, or its fully qualified ID in the following format: '/providers/Microsoft.Authorization/roleDefinitions/c2f4ef07-c644-48eb-af81-4b1b4947fb11'. |
 
-### Parameter: `roleAssignments.condition`
+**Optional parameters**
 
-Optional. The conditions on the role assignment. This limits the resources it can be assigned to. e.g.: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase "foo_storage_container"
+| Parameter | Type | Description |
+| :-- | :-- | :-- |
+| [`condition`](#parameter-roleassignmentscondition) | string | The conditions on the role assignment. This limits the resources it can be assigned to. e.g.: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase "foo_storage_container" |
+| [`conditionVersion`](#parameter-roleassignmentsconditionversion) | string | Version of the condition. |
+| [`delegatedManagedIdentityResourceId`](#parameter-roleassignmentsdelegatedmanagedidentityresourceid) | string | The Resource Id of the delegated managed identity resource. |
+| [`description`](#parameter-roleassignmentsdescription) | string | The description of the role assignment. |
+| [`principalType`](#parameter-roleassignmentsprincipaltype) | string | The principal type of the assigned principal ID. |
 
-- Required: No
+### Parameter: `roleAssignments.principalId`
+
+The principal ID of the principal (user/group/identity) to assign the role to.
+
+- Required: Yes
 - Type: string
 
-### Parameter: `roleAssignments.conditionVersion`
+### Parameter: `roleAssignments.roleDefinitionIdOrName`
 
-Optional. Version of the condition.
+The role to assign. You can provide either the display name of the role definition, the role definition GUID, or its fully qualified ID in the following format: '/providers/Microsoft.Authorization/roleDefinitions/c2f4ef07-c644-48eb-af81-4b1b4947fb11'.
 
-- Required: No
+- Required: Yes
 - Type: string
-- Allowed: `[2.0]`
 
-### Parameter: `roleAssignments.delegatedManagedIdentityResourceId`
+### Parameter: `roleAssignments.condition`
 
-Optional. The Resource Id of the delegated managed identity resource.
+The conditions on the role assignment. This limits the resources it can be assigned to. e.g.: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase "foo_storage_container"
 
 - Required: No
 - Type: string
 
-### Parameter: `roleAssignments.description`
+### Parameter: `roleAssignments.conditionVersion`
 
-Optional. The description of the role assignment.
+Version of the condition.
 
 - Required: No
 - Type: string
+- Allowed:
+  ```Bicep
+  [
+    '2.0'
+  ]
+  ```
 
-### Parameter: `roleAssignments.principalId`
+### Parameter: `roleAssignments.delegatedManagedIdentityResourceId`
 
-Required. The principal ID of the principal (user/group/identity) to assign the role to.
+The Resource Id of the delegated managed identity resource.
 
-- Required: Yes
+- Required: No
 - Type: string
 
-### Parameter: `roleAssignments.principalType`
+### Parameter: `roleAssignments.description`
 
-Optional. The principal type of the assigned principal ID.
+The description of the role assignment.
 
 - Required: No
 - Type: string
-- Allowed: `[Device, ForeignGroup, Group, ServicePrincipal, User]`
 
-### Parameter: `roleAssignments.roleDefinitionIdOrName`
+### Parameter: `roleAssignments.principalType`
 
-Required. The role to assign. You can provide either the display name of the role definition, the role definition GUID, or its fully qualified ID in the following format: '/providers/Microsoft.Authorization/roleDefinitions/c2f4ef07-c644-48eb-af81-4b1b4947fb11'.
+The principal type of the assigned principal ID.
 
-- Required: Yes
+- Required: No
 - Type: string
+- Allowed:
+  ```Bicep
+  [
+    'Device'
+    'ForeignGroup'
+    'Group'
+    'ServicePrincipal'
+    'User'
+  ]
+  ```
 
 ### Parameter: `tags`
 
 Tags of the availability set resource.
+
 - Required: No
 - Type: object
 

diff --git a/avm/res/db-for-postgre-sql/flexible-server/ORPHANED.md b/avm/res/db-for-postgre-sql/flexible-server/ORPHANED.md
@@ -0,0 +1,4 @@
+⚠️THIS MODULE IS CURRENTLY ORPHANED.⚠️
+
+- Only security and bug fixes are being handled by the AVM core team at present.
+- If interested in becoming the module owner of this orphaned module (must be Microsoft FTE), please look for the related "orphaned module" GitHub issue [here](https://aka.ms/AVM/OrphanedModules)!