3.1.5.17.1.2.2 Response Body
The format for the VirtualGateways GET response body is as follows.
-
{ "resourceRef": "/VirtualGateways/VirtualGateway_1", "resourceId": "VirtualGateway_1", "etag": "W/\"681f2608-6588-49d2-ba50-85db700a4300\"", "instanceId": "cc7de412-f5d0-4f0c-83f2-1cabb2e6a3a9", "properties": { "provisioningState": "Succeeded", "networkConnections": [ { "resourceRef": "/VirtualGateways/VirtualGateway_1/NetworkConnections/VirtualGateway_1_IPSEC_1", "resourceId": "VirtualGateway_1_IPSEC_1", "etag": "W/\"681f2608-6588-49d2-ba50-85db700a4300\"", "instanceId": "21974569-b8b3-4bde-a517-c8f5bb7ae13e", "properties": { "provisioningState": "Succeeded", "connectionType": "IPSec", "outboundKiloBitsPerSecond": 307200, "inboundKiloBitsPerSecond": 307200, "ipSecConfiguration": { "authenticationMethod": "PSK", "quickMode": { "perfectForwardSecrecy": "None", "cipherTransformationConstant": "AES128", "authenticationTransformationConstant": "SHA196", "idleDisconnectSeconds": 500, "saLifeTimeSeconds": 3600, "saLifeTimeKiloBytes": 33552408 }, "mainMode": { "diffieHellmanGroup": "Group2", "encryptionAlgorithm": "DES3", "integrityAlgorithm": "SHA1", "saLifeTimeSeconds": 28800, "saLifeTimeKiloBytes": 33552408 }, "localVpnTrafficSelector": [], "remoteVpnTrafficSelector": [] }, "l3Configuration": {}, "ipAddresses": [], "peerIPAddresses": [], "routes": [ { "destinationPrefix": "50.1.1.0/24", "nextHop": "0.0.0.0", "metric": 10, "protocol": "Static" }, { "destinationPrefix": "40.1.1.4/32", "nextHop": "0.0.0.0", "metric": 10, "protocol": "Static" } ], "connectionStatus": "Enabled", "connectionState": "Disconnected", "connectionUpTime": "00:00:00", "connectionErrorReason": "809", "unreachabilityReason": "ConnectionFailure", "statistics": { "outboundBytes": 7608457281, "inboundBytes": 91940776693, "rxTotalPacketsDropped": 0, "txTotalPacketsDropped": 0, "txRateKbps": 0, "rxRateKbps": 0, "txRateLimitedPacketsDropped": 0, "rxRateLimitedPacketsDropped": 0, "lastUpdated": "2016-06-16T06:17:26.5237938Z" }, "configurationState": { "status": "Success", "lastUpdatedTime": "2016-06-15T23:13:41.1459839-07:00" }, "sourceIPAddress": "91.1.1.4", "destinationIPAddress": "11.1.0.1", "gateway": { "resourceRef": "/Gateways/CloudGw1" } } }, { "resourceRef": "/VirtualGateways/VirtualGateway_1/NetworkConnections/VirtualGateway_1_Gre_1", "resourceId": "VirtualGateway_1_Gre_1", "etag": "W/\"681f2608-6588-49d2-ba50-85db700a4300\"", "instanceId": "b8102aff-71ae-40ef-a8f6-4d1d2aad7521", "properties": { "provisioningState": "Succeeded", "connectionType": "GRE", "outboundKiloBitsPerSecond": 307200, "inboundKiloBitsPerSecond": 307200, "greConfiguration": { "greKey": "101" }, "l3Configuration": {}, "ipAddresses": [], "peerIPAddresses": [], "routes": [ { "destinationPrefix": "50.2.1.0/24", "nextHop": "0.0.0.0", "metric": 10, "protocol": "Static" }, { "destinationPrefix": "40.1.2.4/32", "nextHop": "0.0.0.0", "metric": 10, "protocol": "Static" } ], "connectionStatus": "Enabled", "connectionState": "Connected", "connectionUpTime": "01:43:04", "connectionErrorReason": "", "unreachabilityReason": "", "statistics": { "outboundBytes": 29356, "inboundBytes": 0, "rxTotalPacketsDropped": 0, "txTotalPacketsDropped": 0, "txRateKbps": 0, "rxRateKbps": 0, "txRateLimitedPacketsDropped": 0, "rxRateLimitedPacketsDropped": 0, "lastUpdated": "2016-06-16T06:17:26.5237938Z" }, "configurationState": { "status": "Success", "lastUpdatedTime": "2016-06-15T23:13:41.1459839-07:00" }, "sourceIPAddress": "22.1.1.2", "destinationIPAddress": "11.1.0.2", "gateway": { "resourceRef": "/Gateways/CloudGw1" } } }, { "resourceRef": "/VirtualGateways/VirtualGateway_1/NetworkConnections/VirtualGateway_1_L3_1", "resourceId": "VirtualGateway_1_L3_1", "etag": "W/\"681f2608-6588-49d2-ba50-85db700a4300\"", "instanceId": "92db503f-fa02-445e-96ec-eaefb02bb459", "properties": { "provisioningState": "Succeeded", "connectionType": "L3", "outboundKiloBitsPerSecond": 307200, "inboundKiloBitsPerSecond": 307200, "l3Configuration": { "vlanSubnet": { "resourceRef": "/logicalNetworks/LogicalNetwork_VG_1/subnets/LogicalNetwork_VG_1_Subnet_1" } }, "ipAddresses": [ { "ipAddress": "31.1.1.4", "prefixLength": 24 } ], "peerIPAddresses": [ "31.1.1.5" ], "routes": [ { "destinationPrefix": "50.3.1.0/24", "nextHop": "0.0.0.0", "metric": 10, "protocol": "Static" }, { "destinationPrefix": "40.1.3.4/32", "nextHop": "0.0.0.0", "metric": 10, "protocol": "Static" } ], "connectionStatus": "Enabled", "connectionState": "Connected", "connectionUpTime": "00:00:00", "statistics": { "outboundBytes": 0, "inboundBytes": 0, "rxTotalPacketsDropped": 0, "txTotalPacketsDropped": 0, "txRateKbps": 0, "rxRateKbps": 0, "txRateLimitedPacketsDropped": 0, "rxRateLimitedPacketsDropped": 0, "lastUpdated": "0001-01-01T00:00:00" }, "configurationState": { "status": "Success", "lastUpdatedTime": "2016-06-15T23:13:41.1459839-07:00" }, "gateway": { "resourceRef": "/Gateways/CloudGw1" } } } ], "bgpRouters": [ { "resourceRef": "/VirtualGateways/VirtualGateway_1/BgpRouters/router1", "resourceId": "router1", "etag": "W/\"681f2608-6588-49d2-ba50-85db700a4300\"", "instanceId": "be8fe6b1-302f-4bbc-97f7-e727b2f533df", "properties": { "provisioningState": "Succeeded", "isEnabled": true, "requireIgpSync": true, "extAsNumber": "0.3458", "routerId": "10.2.2.2", "routerIP": [ "10.2.2.2" ], "isGenerated": false, "bgpPeers": [ { "resourceRef": "/VirtualGateways/VirtualGateway_1/BgpRouters/router1/BgpPeers/Peer2", "resourceId": "Peer2", "etag": "W/\"681f2608-6588-49d2-ba50-85db700a4300\"", "instanceId": "6dfc12fb-484a-4771-98f9-6c1d4ffbaa1a", "properties": { "provisioningState": "Succeeded", "asNumber": "1236", "extAsNumber": "0.1236", "peerIpAddress": "40.1.2.4", "connectionState": "Disconnected", "statistics": { "tcpConnectionClosed": "2016-06-15T23:17:02.419-07:00", "openMessageStats": { "sentCount": 0, "receivedCount": 0 }, "notificationMessageStats": { "sentCount": 0, "receivedCount": 0 }, "keepAliveMessageStats": { "sentCount": 0, "receivedCount": 0 }, "routeRefreshMessageStats": { "sentCount": 0, "receivedCount": 0 }, "updateMessageStats": { "sentCount": 0, "receivedCount": 0 }, "ipv4Route": { "updateSentCount": 0, "updateReceivedCount": 0, "withdrawlSentCount": 0, "withdrawlReceivedCount": 0 }, "ipv6Route": { "updateSentCount": 0, "updateReceivedCount": 0, "withdrawlSentCount": 0, "withdrawlReceivedCount": 0 }, "lastUpdated": "2016-06-16T06:17:26.4229961Z" }, "isGenerated": false } }, { "resourceRef": "/VirtualGateways/VirtualGateway_1/BgpRouters/router1/BgpPeers/Peer3", "resourceId": "Peer3", "etag": "W/\"681f2608-6588-49d2-ba50-85db700a4300\"", "instanceId": "d6bc7e33-4ac9-4f74-a3f2-81c39eb2a85d", "properties": { "provisioningState": "Succeeded", "asNumber": "1236", "extAsNumber": "0.1236", "peerIpAddress": "40.1.3.4", "connectionState": "Disconnected", "statistics": { "tcpConnectionClosed": "2016-06-15T23:17:07.293-07:00", "openMessageStats": { "sentCount": 0, "receivedCount": 0 }, "notificationMessageStats": { "sentCount": 0, "receivedCount": 0 }, "keepAliveMessageStats": { "sentCount": 0, "receivedCount": 0 }, "routeRefreshMessageStats": { "sentCount": 0, "receivedCount": 0 }, "updateMessageStats": { "sentCount": 0, "receivedCount": 0 }, "ipv4Route": { "updateSentCount": 0, "updateReceivedCount": 0, "withdrawlSentCount": 0, "withdrawlReceivedCount": 0 }, "ipv6Route": { "updateSentCount": 0, "updateReceivedCount": 0, "withdrawlSentCount": 0, "withdrawlReceivedCount": 0 }, "lastUpdated": "2016-06-16T06:17:26.4229961Z" }, "isGenerated": false } }, { "resourceRef": "/VirtualGateways/VirtualGateway_1/BgpRouters/router1/BgpPeers/Peer1", "resourceId": "Peer1", "etag": "W/\"681f2608-6588-49d2-ba50-85db700a4300\"", "instanceId": "b9e57199-f352-4121-9842-24c0ba23f3f1", "properties": { "provisioningState": "Succeeded", "asNumber": "1236", "extAsNumber": "0.1236", "peerIpAddress": "40.1.1.4", "connectionState": "Disconnected", "statistics": { "tcpConnectionClosed": "2016-06-15T23:17:22.498-07:00", "openMessageStats": { "sentCount": 0, "receivedCount": 0 }, "notificationMessageStats": { "sentCount": 0, "receivedCount": 0 }, "keepAliveMessageStats": { "sentCount": 0, "receivedCount": 0 }, "routeRefreshMessageStats": { "sentCount": 0, "receivedCount": 0 }, "updateMessageStats": { "sentCount": 0, "receivedCount": 0 }, "ipv4Route": { "updateSentCount": 0, "updateReceivedCount": 0, "withdrawlSentCount": 0, "withdrawlReceivedCount": 0 }, "ipv6Route": { "updateSentCount": 0, "updateReceivedCount": 0, "withdrawlSentCount": 0, "withdrawlReceivedCount": 0 }, "lastUpdated": "2016-06-16T06:17:26.4229961Z" }, "isGenerated": false } } ], "configurationState": { "status": "Success", "lastUpdatedTime": "2016-06-15T23:13:41.1459839-07:00" } } } ], "policyMaps": [ { "resourceRef": "/VirtualGateways/VirtualGateway_1/PolicyMaps/MAP1", "resourceId": "MAP1", "etag": "W/\"681f2608-6588-49d2-ba50-85db700a4300\"", "instanceId": "b52840f9-91a9-4a3e-91b3-0383ae1ea607", "properties": { "provisioningState": "Succeeded", "bgpPeersWithPolicyMapIn": [], "bgpPeersWithPolicyMapOut": [], "policyMapEntryList": [ { "action": "Deny", "matchCriteria": [ { "property": "MatchPrefix", "value": [ "5.4.3.2/32", "5.4.3.1/32" ] }, { "property": "NextHop", "value": [ "4.3.2.1", "6.4.3.1" ] } ], "setActions": [] } ] } } ], "routingType": "Dynamic", "GatewayPools": [ { "resourceRef": "/GatewayPools/default" } ], "configurationState": { "status": "Success", "lastUpdatedTime": "2016-06-15T23:13:41.1459839-07:00" }, "gatewaySubnets": [ { "resourceRef": "/virtualNetworks/00000000-1111-0000-0001-000000000000/subnets/00000000-1111-1111-0001-000000000002" } ] } }
The JSON schema for the VirtualGateways GET method is located in section 6.15.2.