fix: Corrected optional PE parameter definition (Azure#678)

## Description - Updated RequestMessage parameter to be as optional as it should be | Pipeline | | - | | [![avm.res.network.private-endpoint](https://github.com/AlexanderSehr/bicep-registry-modules/actions/workflows/avm.res.network.private-endpoint.yml/badge.svg?branch=users%2Falsehr%2Fpe_Message_fix&event=workflow_dispatch)](https://github.com/AlexanderSehr/bicep-registry-modules/actions/workflows/avm.res.network.private-endpoint.yml) | --------- Co-authored-by: Erika Gressi <[email protected]>
segraef · Nov 28, 2023 · 10adf7c · 10adf7c
1 parent 0f10b10
commit 10adf7c
Show file tree

Hide file tree

Showing 6 changed files with 10 additions and 15 deletions.
diff --git a/avm/res/network/private-endpoint/README.md b/avm/res/network/private-endpoint/README.md
@@ -67,7 +67,6 @@ module privateEndpoint 'br/public:avm/res/network/private-endpoint:<version>' =
             'vault'
           ]
           privateLinkServiceId: '<privateLinkServiceId>'
-          requestMessage: ''
         }
       }
     ]
@@ -132,8 +131,7 @@ module privateEndpoint 'br/public:avm/res/network/private-endpoint:<version>' =
             "groupIds": [
               "vault"
             ],
-            "privateLinkServiceId": "<privateLinkServiceId>",
-            "requestMessage": ""
+            "privateLinkServiceId": "<privateLinkServiceId>"
           }
         }
       ]
@@ -208,7 +206,7 @@ module privateEndpoint 'br/public:avm/res/network/private-endpoint:<version>' =
             'vault'
           ]
           privateLinkServiceId: '<privateLinkServiceId>'
-          requestMessage: ''
+          requestMessage: 'Hey there'
         }
       }
     ]
@@ -317,7 +315,7 @@ module privateEndpoint 'br/public:avm/res/network/private-endpoint:<version>' =
               "vault"
             ],
             "privateLinkServiceId": "<privateLinkServiceId>",
-            "requestMessage": ""
+            "requestMessage": "Hey there"
           }
         }
       ]
@@ -405,7 +403,6 @@ module privateEndpoint 'br/public:avm/res/network/private-endpoint:<version>' =
             'vault'
           ]
           privateLinkServiceId: '<privateLinkServiceId>'
-          requestMessage: ''
         }
       }
     ]
@@ -489,8 +486,7 @@ module privateEndpoint 'br/public:avm/res/network/private-endpoint:<version>' =
             "groupIds": [
               "vault"
             ],
-            "privateLinkServiceId": "<privateLinkServiceId>",
-            "requestMessage": ""
+            "privateLinkServiceId": "<privateLinkServiceId>"
           }
         }
       ]
@@ -772,7 +768,7 @@ Required. Properties of private link service connection.
 | :-- | :-- | :--| :-- |
 | [`groupIds`](#parameter-privatelinkserviceconnectionspropertiesgroupids) | Yes | array | Required. The ID of a group obtained from the remote resource that this private endpoint should connect to. |
 | [`privateLinkServiceId`](#parameter-privatelinkserviceconnectionspropertiesprivatelinkserviceid) | Yes | string | Required. The resource id of private link service. |
-| [`requestMessage`](#parameter-privatelinkserviceconnectionspropertiesrequestmessage) | Yes | string | Optional. A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. |
+| [`requestMessage`](#parameter-privatelinkserviceconnectionspropertiesrequestmessage) | No | string | Optional. A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. |
 
 ### Parameter: `privateLinkServiceConnections.properties.groupIds`
 
@@ -792,7 +788,7 @@ Required. The resource id of private link service.
 
 Optional. A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars.
 
-- Required: Yes
+- Required: No
 - Type: string
 
 

diff --git a/avm/res/network/private-endpoint/main.bicep b/avm/res/network/private-endpoint/main.bicep
@@ -223,7 +223,7 @@ type privateLinkServiceConnectionsType = {
     privateLinkServiceId: string
 
     @description('Optional. A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars.')
-    requestMessage: string
+    requestMessage: string?
   }
 }[]?
 

diff --git a/avm/res/network/private-endpoint/main.json b/avm/res/network/private-endpoint/main.json
@@ -6,7 +6,7 @@
     "_generator": {
       "name": "bicep",
       "version": "0.23.1.45101",
-      "templateHash": "9677328568170167813"
+      "templateHash": "2821141217598568122"
     },
     "name": "Private Endpoints",
     "description": "This module deploys a Private Endpoint.",
@@ -214,6 +214,7 @@
               },
               "requestMessage": {
                 "type": "string",
+                "nullable": true,
                 "metadata": {
                   "description": "Optional. A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars."
                 }

diff --git a/avm/res/network/private-endpoint/tests/e2e/defaults/main.test.bicep b/avm/res/network/private-endpoint/tests/e2e/defaults/main.test.bicep
@@ -74,7 +74,6 @@ module testDeployment '../../../main.bicep' = [for iteration in [ 'init', 'idem'
           groupIds: [
             'vault'
           ]
-          requestMessage: ''
         }
       }
     ]

diff --git a/avm/res/network/private-endpoint/tests/e2e/max/main.test.bicep b/avm/res/network/private-endpoint/tests/e2e/max/main.test.bicep
@@ -117,7 +117,7 @@ module testDeployment '../../../main.bicep' = [for iteration in [ 'init', 'idem'
           groupIds: [
             'vault'
           ]
-          requestMessage: ''
+          requestMessage: 'Hey there'
         }
       }
     ]

diff --git a/avm/res/network/private-endpoint/tests/e2e/waf-aligned/main.test.bicep b/avm/res/network/private-endpoint/tests/e2e/waf-aligned/main.test.bicep
@@ -93,7 +93,6 @@ module testDeployment '../../../main.bicep' = [for iteration in [ 'init', 'idem'
           groupIds: [
             'vault'
           ]
-          requestMessage: ''
         }
       }
     ]
-Original file line number
+Diff line change
@@ Expand Up @@
               groupIds: [
                 'vault'
               ]
-              requestMessage: ''
             }
           }
         ]
@@ Expand Down @@