Support for Listing IKE Security Associations for Virtual Network Gat…

…eway Connections (#11572) * Support to List IKE SAs on VNG Connection * Updating GetIkeSas * Update virtualNetworkGateway.json * Added location headers * Update virtualNetworkGateway.json * Prettier fix * Update custom-words.txt * Update virtualNetworkGateway.json * Update custom-words.txt * Update virtualNetworkGateway.json * Update virtualNetworkGateway.json * Update virtualNetworkGateway.json Co-authored-by: Abhishek Shah <shabhis@microsoft.com>
Azure · Dec 14, 2020 · eb8d91d · eb8d91d
1 parent 1a252a7
commit eb8d91d
Show file tree

Hide file tree

Showing 3 changed files with 213 additions and 0 deletions.
diff --git a/custom-words.txt b/custom-words.txt
@@ -527,6 +527,7 @@ EDMX
 Einsteinweg
 Ekaterinburg
 ekus
+elapsedTimeInseconds
 Eloqua
 enableautoscale
 enablelog
@@ -656,6 +657,7 @@ getcertificate
 getconsumergroup
 GETCONTENTSUMMARY
 GETFILESTATUS
+getikesas
 getissuers
 getitems
 getjob

diff --git a/...icrosoft.Network/stable/2020-08-01/examples/VirtualNetworkGatewayConnectionGetIkeSas.json b/...icrosoft.Network/stable/2020-08-01/examples/VirtualNetworkGatewayConnectionGetIkeSas.json
@@ -0,0 +1,18 @@
+{
+  "parameters": {
+    "api-version": "2020-08-01",
+    "subscriptionId": "subid",
+    "resourceGroupName": "rg1",
+    "virtualNetworkGatewayConnectionName": "vpngwcn1"
+  },
+  "responses": {
+    "202": {
+      "headers": {
+        "azure-async-operation": "/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/westus/operations/{operationId}?api-version=2020-08-01"
+      }
+    },
+    "200": {
+      "body": "\"{\"Status\":\"Successful\",\"Data\":null}\""
+    }
+  }
+}
diff --git a/...n/network/resource-manager/Microsoft.Network/stable/2020-08-01/virtualNetworkGateway.json b/...n/network/resource-manager/Microsoft.Network/stable/2020-08-01/virtualNetworkGateway.json
@@ -1825,6 +1825,63 @@
         }
       }
     },
+    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/getikesas": {
+      "post": {
+        "tags": [
+          "VirtualNetworkGatewayConnections"
+        ],
+        "operationId": "VirtualNetworkGatewayConnections_GetIkeSas",
+        "description": "Lists IKE Security Associations for the virtual network gateway connection in the specified resource group.",
+        "parameters": [
+          {
+            "name": "resourceGroupName",
+            "in": "path",
+            "required": true,
+            "type": "string",
+            "description": "The name of the resource group."
+          },
+          {
+            "name": "virtualNetworkGatewayConnectionName",
+            "in": "path",
+            "required": true,
+            "type": "string",
+            "description": "The name of the virtual network gateway Connection."
+          },
+          {
+            "$ref": "./network.json#/parameters/ApiVersionParameter"
+          },
+          {
+            "$ref": "./network.json#/parameters/SubscriptionIdParameter"
+          }
+        ],
+        "responses": {
+          "202": {
+            "description": "Accepted and the operation GetIkeSas will complete asynchronously."
+          },
+          "200": {
+            "description": "Request successful. The operation getikesas completed on virtual network gateway connection.",
+            "schema": {
+              "$ref": "#/definitions/IkeSaParameters"
+            }
+          },
+          "default": {
+            "description": "The operation GetIkeSas could not be completed.",
+            "schema": {
+              "$ref": "./networkWatcher.json#/definitions/ErrorResponse"
+            }
+          }
+        },
+        "x-ms-examples": {
+          "List IKE Security Associations for virtual network gateway connection": {
+            "$ref": "./examples/VirtualNetworkGatewayConnectionGetIkeSas.json"
+          }
+        },
+        "x-ms-long-running-operation": true,
+        "x-ms-long-running-operation-options": {
+          "final-state-via": "azure-async-operation"
+        }
+      }
+    },
     "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/localNetworkGateways/{localNetworkGatewayName}": {
       "put": {
         "tags": [
@@ -3212,6 +3269,142 @@
       ],
       "description": "An IPSec parameters for a virtual network gateway P2S connection."
     },
+    "IkeSaParameters": {
+      "properties": {
+        "mainModeSa": {
+          "properties": {
+            "localEndpoint": {
+              "type": "string",
+              "description": "The local endpoint."
+            },
+            "remoteEndpoint": {
+              "type": "string",
+              "description": "The remote endpoint."
+            },
+            "initiatorCookie": {
+              "type": "integer",
+              "format": "int64",
+              "description": "The initiator cookie."
+            },
+            "responderCookie": {
+              "type": "integer",
+              "format": "int64",
+              "description": "The responder cookie."
+            },
+            "localUdpEncapsulationPort": {
+              "type": "integer",
+              "format": "int32",
+              "description": "The local UDP encapsulation port."
+            },
+            "remoteUdpEncapsulationPort": {
+              "type": "integer",
+              "format": "int32",
+              "description": "The remote UDP encapsulation port."
+            },
+            "encryption": {
+              "type": "string",
+              "description": "The IKE encryption algorithm (IKE phase 1)."
+            },
+            "integrity": {
+              "type": "string",
+              "description": "The IKE integrity algorithm (IKE phase 1)."
+            },
+            "dhGroup": {
+              "type": "string",
+              "description": "The DH Group."
+            },
+            "lifeTimeSeconds": {
+              "type": "integer",
+              "format": "int32",
+              "description": "The MM SA Lifetime in seconds."
+            },
+            "isSaInitiator": {
+              "type": "boolean",
+              "description": "Flag to check if SA Initiator or not."
+            },
+            "elapsedTimeInseconds": {
+              "type": "integer",
+              "format": "int32",
+              "description": "The time elapsed in seconds."
+            },
+            "quickModeSa": {
+              "properties": {
+                "localEndpoint": {
+                  "type": "string",
+                  "description": "The local endpoint."
+                },
+                "remoteEndpoint": {
+                  "type": "string",
+                  "description": "The remote endpoint."
+                },
+                "encryption": {
+                  "type": "string",
+                  "description": "The IPSec encryption algorithm (IKE phase 2)."
+                },
+                "integrity": {
+                  "type": "string",
+                  "description": "The IPSec integrity algorithm (IKE phase 2)."
+                },
+                "pfsGroupId": {
+                  "type": "string",
+                  "description": "The PFS Group."
+                },
+                "inboundSPI": {
+                  "type": "integer",
+                  "format": "int32",
+                  "description": "The Inbound SPI SA."
+                },
+                "outboundSPI": {
+                  "type": "integer",
+                  "format": "int32",
+                  "description": "The Outbound SPI SA."
+                },
+                "localTrafficSelectors": {
+                  "type": "array",
+                  "items": {
+                    "type": "string"
+                  },
+                  "description": "The local traffic selectors."
+                },
+                "remoteTrafficSelectors": {
+                  "type": "array",
+                  "items": {
+                    "type": "string"
+                  },
+                  "description": "The remote traffic selectors."
+                },
+                "lifetimeKilobytes": {
+                  "type": "integer",
+                  "format": "int64",
+                  "minimum": 1024,
+                  "maximum": 102400000,
+                  "description": "The QM SA Lifetime KBytes."
+                },
+                "lifeTimeSeconds": {
+                  "type": "integer",
+                  "format": "int64",
+                  "minimum": 300,
+                  "maximum": 27000,
+                  "description": "The QM SA Lifetime Seconds."
+                },
+                "isSaInitiator": {
+                  "type": "boolean",
+                  "description": "Flag to check if SA Initiator or not."
+                },
+                "elapsedTimeInseconds": {
+                  "type": "integer",
+                  "format": "int32",
+                  "description": "The time elapsed in seconds."
+                }
+              },
+              "description": "A list of quick mode security associations."
+            }
+          },
+          "description": "A list of main mode security associations."
+        }
+      },
+      "description": "IKE security association parameters for virtual network gateway connection. Response for GetIkeSas API service call."
+    },
     "LocalNetworkGatewayPropertiesFormat": {
       "properties": {
         "localNetworkAddressSpace": {