fix: Update VPN server configuration parameters

Updated the VPN server configuration parameters in the README.md, main.bicep, and main.json files. The `name` field for the lock has been changed to 'myCustomLockName' instead of 'ResourceLock'. Additionally, the descriptions for the `aadIssuer` and `aadTenant` parameters have been clarified. These changes ensure accurate and up-to-date information for configuring Entra ID authentication. Related work items: Azure#3354
ericscheffler · Oct 2, 2024 · b59486d · b59486d
1 parent 4a309aa
commit b59486d
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 12 deletions.
diff --git a/avm/res/network/vpn-server-configuration/README.md b/avm/res/network/vpn-server-configuration/README.md
@@ -435,7 +435,7 @@ module vpnServerConfiguration 'br/public:avm/res/network/vpn-server-configuratio
     location: '<location>'
     lock: {
       kind: 'CanNotDelete'
-      name: 'ResourceLock'
+      name: 'myCustomLockName'
     }
     p2sConfigurationPolicyGroups: [
       {
@@ -493,7 +493,7 @@ module vpnServerConfiguration 'br/public:avm/res/network/vpn-server-configuratio
     "lock": {
       "value": {
         "kind": "CanNotDelete",
-        "name": "ResourceLock"
+        "name": "myCustomLockName"
       }
     },
     "p2sConfigurationPolicyGroups": {
@@ -542,8 +542,8 @@ module vpnServerConfiguration 'br/public:avm/res/network/vpn-server-configuratio
 | Parameter | Type | Description |
 | :-- | :-- | :-- |
 | [`aadAudience`](#parameter-aadaudience) | string | The audience for the AAD/Entra authentication. Required if configuring Entra ID authentication. |
-| [`aadIssuer`](#parameter-aadissuer) | string | The issuer for the AAD/Entra authentication. Required if configuring Entra ID authentication |
-| [`aadTenant`](#parameter-aadtenant) | string | The audience for the AAD/Entra authentication. Required if configuring Entra ID authentication |
+| [`aadIssuer`](#parameter-aadissuer) | string | The issuer for the AAD/Entra authentication. Required if configuring Entra ID authentication. |
+| [`aadTenant`](#parameter-aadtenant) | string | The audience for the AAD/Entra authentication. Required if configuring Entra ID authentication. |
 | [`radiusServerAddress`](#parameter-radiusserveraddress) | string | The address of the RADIUS server. Required if configuring a single RADIUS. |
 | [`radiusServerSecret`](#parameter-radiusserversecret) | securestring | The RADIUS server secret. Required if configuring a single RADIUS server. |
 | [`vpnClientRootCertificates`](#parameter-vpnclientrootcertificates) | array | The VPN Client root certificate public keys for the configuration. Required if using certificate authentication. |
@@ -581,14 +581,14 @@ The audience for the AAD/Entra authentication. Required if configuring Entra ID
 
 ### Parameter: `aadIssuer`
 
-The issuer for the AAD/Entra authentication. Required if configuring Entra ID authentication
+The issuer for the AAD/Entra authentication. Required if configuring Entra ID authentication.
 
 - Required: No
 - Type: string
 
 ### Parameter: `aadTenant`
 
-The audience for the AAD/Entra authentication. Required if configuring Entra ID authentication
+The audience for the AAD/Entra authentication. Required if configuring Entra ID authentication.
 
 - Required: No
 - Type: string

diff --git a/avm/res/network/vpn-server-configuration/main.bicep b/avm/res/network/vpn-server-configuration/main.bicep
@@ -11,10 +11,10 @@ param location string = resourceGroup().location
 @description('Conditional. The audience for the AAD/Entra authentication. Required if configuring Entra ID authentication.')
 param aadAudience string?
 
-@description('Conditional. The issuer for the AAD/Entra authentication. Required if configuring Entra ID authentication')
+@description('Conditional. The issuer for the AAD/Entra authentication. Required if configuring Entra ID authentication.')
 param aadIssuer string?
 
-@description('Conditional. The audience for the AAD/Entra authentication. Required if configuring Entra ID authentication')
+@description('Conditional. The audience for the AAD/Entra authentication. Required if configuring Entra ID authentication.')
 param aadTenant string?
 
 @description('Optional. The P2S configuration policy groups for the configuration.')

diff --git a/avm/res/network/vpn-server-configuration/main.json b/avm/res/network/vpn-server-configuration/main.json
@@ -6,7 +6,7 @@
     "_generator": {
       "name": "bicep",
       "version": "0.30.23.60470",
-      "templateHash": "11742668183850609496"
+      "templateHash": "5103322953711246998"
     },
     "name": "VPN Server Configuration",
     "description": "This module deploys a VPN Server Configuration for a Virtual Hub P2S Gateway.",
@@ -64,14 +64,14 @@
       "type": "string",
       "nullable": true,
       "metadata": {
-        "description": "Conditional. The issuer for the AAD/Entra authentication. Required if configuring Entra ID authentication"
+        "description": "Conditional. The issuer for the AAD/Entra authentication. Required if configuring Entra ID authentication."
       }
     },
     "aadTenant": {
       "type": "string",
       "nullable": true,
       "metadata": {
-        "description": "Conditional. The audience for the AAD/Entra authentication. Required if configuring Entra ID authentication"
+        "description": "Conditional. The audience for the AAD/Entra authentication. Required if configuring Entra ID authentication."
       }
     },
     "p2sConfigurationPolicyGroups": {

diff --git a/avm/res/network/vpn-server-configuration/tests/e2e/waf-aligned/main.test.bicep b/avm/res/network/vpn-server-configuration/tests/e2e/waf-aligned/main.test.bicep
@@ -79,7 +79,7 @@ module testDeployment '../../../main.bicep' = [
         'OpenVPN'
       ]
       lock: {
-        name: 'ResourceLock'
+        name: 'myCustomLockName'
         kind: 'CanNotDelete'
       }
     }