Update documentation for VirtualNetworkGateway and VirtualWan VpnServ… (#37026)

Nilambari · web-flow · commit 8070fb8eba4e · 2025-08-30T09:42:18.000Z
diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-10-01/examples/VirtualNetworkGatewayConnectionCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-10-01/examples/VirtualNetworkGatewayConnectionCreate.json
@@ -131,7 +131,6 @@
           "connectionProtocol": "IKEv2",
           "routingWeight": 0,
           "dpdTimeoutSeconds": 30,
-          "sharedKey": "Abc123",
           "enableBgp": false,
           "useLocalAzureIpAddress": false,
           "usePolicyBasedTrafficSelectors": false,
@@ -184,7 +183,6 @@
           "connectionProtocol": "IKEv2",
           "routingWeight": 0,
           "dpdTimeoutSeconds": 30,
-          "sharedKey": "Abc123",
           "enableBgp": false,
           "gatewayCustomBgpIpAddresses": [
             {
diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-10-01/examples/VirtualNetworkGatewayConnectionGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-10-01/examples/VirtualNetworkGatewayConnectionGet.json
@@ -38,7 +38,6 @@
           "connectionProtocol": "IKEv2",
           "routingWeight": 0,
           "dpdTimeoutSeconds": 30,
-          "sharedKey": "Abc123",
           "enableBgp": false,
           "gatewayCustomBgpIpAddresses": [
             {
diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-10-01/examples/VirtualNetworkGatewayConnectionUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-10-01/examples/VirtualNetworkGatewayConnectionUpdateTags.json
@@ -50,7 +50,6 @@
           ],
           "connectionType": "IPsec",
           "routingWeight": 0,
-          "sharedKey": "temp1234",
           "enableBgp": false,
           "gatewayCustomBgpIpAddresses": [
             {
diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-10-01/examples/VpnConnectionGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-10-01/examples/VpnConnectionGet.json
@@ -35,7 +35,6 @@
                 "connectionBandwidth": 200,
                 "ipsecPolicies": [],
                 "vpnConnectionProtocolType": "IKEv2",
-                "sharedKey": "key",
                 "ingressBytesTransferred": 0,
                 "egressBytesTransferred": 0,
                 "enableBgp": false,
@@ -59,7 +58,6 @@
                 "connectionBandwidth": 200,
                 "ipsecPolicies": [],
                 "vpnConnectionProtocolType": "IKEv2",
-                "sharedKey": "key",
                 "ingressBytesTransferred": 0,
                 "egressBytesTransferred": 0,
                 "enableBgp": false,
diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-10-01/examples/VpnConnectionList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-10-01/examples/VpnConnectionList.json
@@ -35,7 +35,6 @@
                   "connectionBandwidth": 200,
                   "ipsecPolicies": [],
                   "vpnConnectionProtocolType": "IKEv2",
-                  "sharedKey": "key",
                   "ingressBytesTransferred": 0,
                   "egressBytesTransferred": 0,
                   "enableBgp": false,
@@ -59,7 +58,6 @@
                   "connectionBandwidth": 200,
                   "ipsecPolicies": [],
                   "vpnConnectionProtocolType": "IKEv2",
-                  "sharedKey": "key",
                   "ingressBytesTransferred": 0,
                   "egressBytesTransferred": 0,
                   "enableBgp": false,
diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-10-01/examples/VpnConnectionPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-10-01/examples/VpnConnectionPut.json
@@ -85,7 +85,6 @@
                 "connectionBandwidth": 200,
                 "ipsecPolicies": [],
                 "vpnConnectionProtocolType": "IKEv2",
-                "sharedKey": "key",
                 "ingressBytesTransferred": 0,
                 "egressBytesTransferred": 0,
                 "enableBgp": false,
@@ -155,7 +154,6 @@
                 "connectionBandwidth": 200,
                 "ipsecPolicies": [],
                 "vpnConnectionProtocolType": "IKEv2",
-                "sharedKey": "key",
                 "ingressBytesTransferred": 0,
                 "egressBytesTransferred": 0,
                 "enableBgp": false,
diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-10-01/examples/VpnGatewayGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-10-01/examples/VpnGatewayGet.json
@@ -45,7 +45,6 @@
                       "connectionBandwidth": 200,
                       "ipsecPolicies": [],
                       "vpnConnectionProtocolType": "IKEv2",
-                      "sharedKey": "key",
                       "ingressBytesTransferred": 0,
                       "egressBytesTransferred": 0,
                       "enableBgp": false,
@@ -73,7 +72,6 @@
                       "connectionBandwidth": 200,
                       "ipsecPolicies": [],
                       "vpnConnectionProtocolType": "IKEv2",
-                      "sharedKey": "key",
                       "ingressBytesTransferred": 0,
                       "egressBytesTransferred": 0,
                       "enableBgp": false,
diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-10-01/examples/VpnGatewayList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-10-01/examples/VpnGatewayList.json
@@ -46,7 +46,6 @@
                           "connectionBandwidth": 200,
                           "ipsecPolicies": [],
                           "vpnConnectionProtocolType": "IKEv2",
-                          "sharedKey": "key",
                           "ingressBytesTransferred": 0,
                           "egressBytesTransferred": 0,
                           "enableBgp": false,
@@ -74,7 +73,6 @@
                           "connectionBandwidth": 200,
                           "ipsecPolicies": [],
                           "vpnConnectionProtocolType": "IKEv2",
-                          "sharedKey": "key",
                           "ingressBytesTransferred": 0,
                           "egressBytesTransferred": 0,
                           "enableBgp": false,
@@ -229,7 +227,6 @@
                     "egressBytesTransferred": 0,
                     "routingWeight": 0,
                     "connectionBandwidth": 100,
-                    "sharedKey": "key",
                     "enableBgp": false,
                     "useLocalAzureIpAddress": false,
                     "ipsecPolicies": [],
diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-10-01/examples/VpnGatewayListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-10-01/examples/VpnGatewayListByResourceGroup.json
@@ -46,7 +46,6 @@
                           "connectionBandwidth": 200,
                           "ipsecPolicies": [],
                           "vpnConnectionProtocolType": "IKEv2",
-                          "sharedKey": "key",
                           "ingressBytesTransferred": 0,
                           "egressBytesTransferred": 0,
                           "enableBgp": false,
@@ -74,7 +73,6 @@
                           "connectionBandwidth": 200,
                           "ipsecPolicies": [],
                           "vpnConnectionProtocolType": "IKEv2",
-                          "sharedKey": "key",
                           "ingressBytesTransferred": 0,
                           "egressBytesTransferred": 0,
                           "enableBgp": false,
@@ -205,7 +203,6 @@
                     "egressBytesTransferred": 0,
                     "routingWeight": 0,
                     "connectionBandwidth": 100,
-                    "sharedKey": "key",
                     "enableBgp": false,
                     "useLocalAzureIpAddress": false,
                     "ipsecPolicies": [],
diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-10-01/examples/VpnGatewayPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-10-01/examples/VpnGatewayPut.json
@@ -124,7 +124,6 @@
                       "connectionBandwidth": 200,
                       "ipsecPolicies": [],
                       "vpnConnectionProtocolType": "IKEv2",
-                      "sharedKey": "key",
                       "ingressBytesTransferred": 0,
                       "egressBytesTransferred": 0,
                       "enableBgp": false,
@@ -268,7 +267,6 @@
                       "connectionBandwidth": 200,
                       "ipsecPolicies": [],
                       "vpnConnectionProtocolType": "IKEv2",
-                      "sharedKey": "key",
                       "ingressBytesTransferred": 0,
                       "egressBytesTransferred": 0,
                       "enableBgp": false,
diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-10-01/examples/VpnGatewayReset.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-10-01/examples/VpnGatewayReset.json
@@ -38,7 +38,6 @@
                 "egressBytesTransferred": 0,
                 "routingWeight": 0,
                 "connectionBandwidth": 100,
-                "sharedKey": "key",
                 "enableBgp": false,
                 "useLocalAzureIpAddress": false,
                 "ipsecPolicies": [],
diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-10-01/examples/VpnGatewayUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-10-01/examples/VpnGatewayUpdateTags.json
@@ -47,7 +47,6 @@
                 "ingressBytesTransferred": 0,
                 "egressBytesTransferred": 0,
                 "routingWeight": 0,
-                "sharedKey": "key",
                 "enableBgp": false,
                 "ipsecPolicies": [],
                 "routingConfiguration": {
diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-10-01/examples/VpnServerConfigurationList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-10-01/examples/VpnServerConfigurationList.json
@@ -90,7 +90,6 @@
                 }
               ],
               "radiusServerAddress": "8.9.9.9",
-              "radiusServerSecret": "<password>",
               "radiusServerRootCertificates": [
                 {
                   "name": "vpnServerConfigRadiusServerRootCer1",
diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-10-01/examples/VpnServerConfigurationListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-10-01/examples/VpnServerConfigurationListByResourceGroup.json
@@ -91,7 +91,6 @@
                 }
               ],
               "radiusServerAddress": "8.9.9.9",
-              "radiusServerSecret": "<password>",
               "radiusServerRootCertificates": [
                 {
                   "name": "vpnServerConfigRadiusServerRootCer1",
@@ -189,7 +188,6 @@
                 }
               ],
               "radiusServerAddress": "8.9.9.9",
-              "radiusServerSecret": "<password>",
               "radiusServerRootCertificates": [
                 {
                   "name": "vpnServerConfigRadiusServerRootCer1",
diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-10-01/examples/VpnServerConfigurationUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-10-01/examples/VpnServerConfigurationUpdateTags.json
@@ -92,7 +92,6 @@
             }
           ],
           "radiusServerAddress": "8.9.9.9",
-          "radiusServerSecret": "<password>",
           "radiusServerRootCertificates": [
             {
               "name": "vpnServerConfigRadiusServerRootCer1",
diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-10-01/examples/VpnSiteLinkConnectionGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-10-01/examples/VpnSiteLinkConnectionGet.json
@@ -22,7 +22,6 @@
           "connectionBandwidth": 200,
           "ipsecPolicies": [],
           "vpnConnectionProtocolType": "IKEv2",
-          "sharedKey": "key",
           "ingressBytesTransferred": 0,
           "egressBytesTransferred": 0,
           "enableBgp": false,
diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-10-01/examples/VpnSiteLinkConnectionList.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-10-01/examples/VpnSiteLinkConnectionList.json
@@ -22,7 +22,6 @@
             "connectionBandwidth": 200,
             "ipsecPolicies": [],
             "vpnConnectionProtocolType": "IKEv2",
-            "sharedKey": "key",
             "ingressBytesTransferred": 0,
             "egressBytesTransferred": 0,
             "enableBgp": false,
diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-10-01/virtualNetworkGateway.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-10-01/virtualNetworkGateway.json
@@ -3768,7 +3768,8 @@
         },
         "radiusServerSecret": {
           "type": "string",
-          "description": "The secret used for this radius server."
+          "x-ms-secret": true,
+          "description": "The secret used for this radius server. We will no longer return radiusServerSecret in VirtualNetworkGateway Create/Update/Get/List/UpdateTags APIs response. Please use VirtualNetworkGateway ListRadiusSecrets API to fetch radius server secrets."
         }
       },
       "required": [
@@ -3843,7 +3844,8 @@
         },
         "radiusServerSecret": {
           "type": "string",
-          "description": "The radius secret property of the VirtualNetworkGateway resource for vpn client connection."
+          "x-ms-secret": true,
+          "description": "The radius secret property of the VirtualNetworkGateway resource for vpn client connection. We will no longer return radiusServerSecret in VirtualNetworkGateway Create/Update/Get/List/UpdateTags APIs response. Please use VirtualNetworkGateway ListRadiusSecrets API to fetch radius server secrets."
         },
         "radiusServers": {
           "type": "array",
@@ -4475,6 +4477,7 @@
         },
         "sharedKey": {
           "type": "string",
+          "x-ms-secret": true,
           "description": "The IPSec shared key."
         },
         "connectionStatus": {
@@ -5034,7 +5037,7 @@
         },
         "sharedKey": {
           "type": "string",
-          "description": "The IPSec shared key."
+          "description": "The IPSec shared key. We will no longer return sharedKey in VirtualNetworkGatewayConnection Create/Update/Get/List/UpdateTags APIs response. Please use VirtualNetworkGatewayConnection GetSharedKey API to fetch connection sharedKey."
         },
         "connectionStatus": {
           "readOnly": true,
diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2024-10-01/virtualWan.json b/specification/network/resource-manager/Microsoft.Network/stable/2024-10-01/virtualWan.json
@@ -7761,7 +7761,7 @@
         },
         "sharedKey": {
           "type": "string",
-          "description": "SharedKey for the vpn connection."
+          "description": "Deprecated: SharedKey for the vpn connection. This is no more used."
         },
         "enableBgp": {
           "type": "boolean",
@@ -7957,7 +7957,8 @@
         },
         "sharedKey": {
           "type": "string",
-          "description": "SharedKey for the vpn connection."
+          "x-ms-secret": true,
+          "description": "SharedKey for the vpn link connection. We will no longer return sharedKey in any Create/Update/Get/List/UpdateTags VpnGateway/VpnConnection/VpnLinkConnection APIs response. Please use 'Vpn Link Connections - List Default Shared Key' API to fetch Vpn link connection sharedKey."
         },
         "enableBgp": {
           "type": "boolean",
@@ -8531,7 +8532,8 @@
         },
         "radiusServerSecret": {
           "type": "string",
-          "description": "The radius secret property of the VpnServerConfiguration resource for point to site client connection."
+          "x-ms-secret": true,
+          "description": "The radius secret property of the VpnServerConfiguration resource for point to site client connection. We will no longer return radiusServerSecret in VpnServerConfiguration Create/Update/Get/List/UpdateTags APIs response. Please use VpnServerConfiguration ListRadiusSecrets API to fetch radius server secrets."
         },
         "radiusServers": {
           "type": "array",

Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,6 @@`
`38`	`38`	`"connectionProtocol": "IKEv2",`
`39`	`39`	`"routingWeight": 0,`
`40`	`40`	`"dpdTimeoutSeconds": 30,`
`41`		`- "sharedKey": "Abc123",`
`42`	`41`	`"enableBgp": false,`
`43`	`42`	`"gatewayCustomBgpIpAddresses": [`
`44`	`43`	`{`
Original file line number	Diff line number	Diff line change
`@@ -50,7 +50,6 @@`
`50`	`50`	`],`
`51`	`51`	`"connectionType": "IPsec",`
`52`	`52`	`"routingWeight": 0,`
`53`		`- "sharedKey": "temp1234",`
`54`	`53`	`"enableBgp": false,`
`55`	`54`	`"gatewayCustomBgpIpAddresses": [`
`56`	`55`	`{`