Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
The following table lists the metrics available for the microsoft.network/virtualnetworkgateways resource type.
Table headings
- Metric - The metric display name as it appears in the Azure portal.
- Name in Rest API - Metric name as referred to in the REST API.
- Advanced platform metrics - A premium, paid tier of platform metrics in Azure Monitor that provide more granular observability for Azure resources.
- Unit - Unit of measure.
- Aggregation - The default aggregation type. Valid values: Average, Minimum, Maximum, Total, Count.
- Dimensions - Dimensions available for the metric.
- Time Grains - Intervals at which the metric is sampled. For example,
PT1Mindicates that the metric is sampled every minute,PT30Mevery 30 minutes,PT1Hevery hour, and so on. - DS Export -S Whether the metric is exportable to Azure Monitor Logs via Diagnostic Settings.
For information on exporting metrics, see - Metrics export using data collection rules and Create diagnostic settings in Azure Monitor.
For information on metric retention, see Azure Monitor Metrics overview.
For a list of supported logs, see Supported log categories - microsoft.network/virtualnetworkgateways
Category: Errors
| Metric | Name in REST API | Advanced platform metrics | Unit | Aggregation | Dimensions | Time Grains | DS Export |
|---|---|---|---|---|---|---|---|
| Tunnel Egress Packet Drop Count Count of outgoing packets dropped by tunnel |
TunnelEgressPacketDropCount |
No | Count | Total (Sum) | ConnectionName, RemoteIP, Instance |
PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D | Yes |
| Tunnel Egress TS Mismatch Packet Drop Outgoing packet drop count from traffic selector mismatch of a tunnel |
TunnelEgressPacketDropTSMismatch |
No | Count | Total (Sum) | ConnectionName, RemoteIP, Instance |
PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D | Yes |
| Tunnel Ingress Packet Drop Count Count of incoming packets dropped by tunnel |
TunnelIngressPacketDropCount |
No | Count | Total (Sum) | ConnectionName, RemoteIP, Instance |
PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D | Yes |
| Tunnel Ingress TS Mismatch Packet Drop Incoming packet drop count from traffic selector mismatch of a tunnel |
TunnelIngressPacketDropTSMismatch |
No | Count | Total (Sum) | ConnectionName, RemoteIP, Instance |
PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D | Yes |
| Tunnel NAT Packet Drops Number of NATed packets on a tunnel that dropped by drop type and NAT rule |
TunnelNatPacketDrop |
No | Count | Total (Sum) | NatRule, DropType, ConnectionName, RemoteIP, Instance |
PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D | No |
Category: Ipsec
| Metric | Name in REST API | Advanced platform metrics | Unit | Aggregation | Dimensions | Time Grains | DS Export |
|---|---|---|---|---|---|---|---|
| Tunnel MMSA Count MMSA Count |
MmsaCount |
No | Count | Total (Sum) | ConnectionName, RemoteIP, Instance |
PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D | Yes |
| Tunnel QMSA Count QMSA Count |
QmsaCount |
No | Count | Total (Sum) | ConnectionName, RemoteIP, Instance |
PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D | Yes |
Category: Performance
| Metric | Name in REST API | Advanced platform metrics | Unit | Aggregation | Dimensions | Time Grains | DS Export |
|---|---|---|---|---|---|---|---|
| Bits Received Per second Total Bits received on ExpressRoute Gateway per second |
ExpressRouteGatewayBitsPerSecond |
No | BitsPerSecond | Average, Minimum, Maximum | roleInstance |
PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D | No |
| CPU utilization CPU Utilization of the ExpressRoute Gateway |
ExpressRouteGatewayCpuUtilization |
No | Percent | Average, Minimum, Maximum | roleInstance |
PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D | Yes |
| Packets received per second Total Packets received on ExpressRoute Gateway per second |
ExpressRouteGatewayPacketsPerSecond |
No | CountPerSecond | Average, Minimum, Maximum | roleInstance |
PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D | No |
| Bits Received Per second Total Bits received on ExpressRoute Gateway per second |
ScalableExpressRouteGatewayBitsPerSecond |
No | BitsPerSecond | Average, Minimum, Maximum | <none> | PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D | No |
| CPU utilization CPU Utilization of the ExpressRoute Gateway |
ScalableExpressRouteGatewayCpuUtilization |
No | Percent | Average, Minimum, Maximum | <none> | PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D | No |
| Packets received per second Total Packets received on ExpressRoute Gateway per second |
ScalableExpressRouteGatewayPacketsPerSecond |
No | CountPerSecond | Average, Minimum, Maximum | <none> | PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D | No |
Category: Routing
| Metric | Name in REST API | Advanced platform metrics | Unit | Aggregation | Dimensions | Time Grains | DS Export |
|---|---|---|---|---|---|---|---|
| BGP Peer Status Status of BGP peer |
BgpPeerStatus |
No | Count | Average | BgpPeerAddress, Instance |
PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D | No |
| BGP Routes Advertised Count of Bgp Routes Advertised through tunnel |
BgpRoutesAdvertised |
No | Count | Total (Sum) | BgpPeerAddress, Instance |
PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D | Yes |
| BGP Routes Learned Count of Bgp Routes Learned through tunnel |
BgpRoutesLearned |
No | Count | Total (Sum) | BgpPeerAddress, Instance |
PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D | Yes |
| User Vpn Route Count Count of P2S User Vpn routes learned by gateway |
UserVpnRouteCount |
No | Count | Total (Sum) | RouteType, Instance |
PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D | No |
| VNet Address Prefix Count Count of Vnet address prefixes behind gateway |
VnetAddressPrefixCount |
No | Count | Total (Sum) | Instance |
PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D | Yes |
Category: Scalability
| Metric | Name in REST API | Advanced platform metrics | Unit | Aggregation | Dimensions | Time Grains | DS Export |
|---|---|---|---|---|---|---|---|
| Active Flows Number of Active Flows on ExpressRoute Gateway |
ExpressRouteGatewayActiveFlows |
No | Count | Average, Minimum, Maximum | roleInstance |
PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D | No |
| Count Of Routes Advertised to Peer Count Of Routes Advertised To Peer by ExpressRoute Gateway |
ExpressRouteGatewayCountOfRoutesAdvertisedToPeer |
No | Count | Maximum | roleInstance, BgpPeerAddress |
PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D | Yes |
| Count Of Routes Learned from Peer Count Of Routes Learned From Peer by ExpressRoute Gateway |
ExpressRouteGatewayCountOfRoutesLearnedFromPeer |
No | Count | Maximum | roleInstance, BgpPeerAddress |
PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D | Yes |
| Frequency of Routes change Frequency of Routes change in ExpressRoute Gateway |
ExpressRouteGatewayFrequencyOfRoutesChanged |
No | Count | Total (Sum) | roleInstance |
PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D | No |
| Max Flows Created Per Second Maximum Number of Flows Created Per Second on ExpressRoute Gateway |
ExpressRouteGatewayMaxFlowsCreationRate |
No | CountPerSecond | Maximum | roleInstance, direction |
PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D | No |
| Number of VMs in the Virtual Network Number of VMs in the Virtual Network |
ExpressRouteGatewayNumberOfVmInVnet |
No | Count | Maximum | roleInstance |
PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D | No |
| Active Flows Number of Active Flows on ExpressRoute Gateway |
ScalableExpressRouteGatewayActiveFlows |
No | Count | Average, Minimum, Maximum | <none> | PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D | No |
| Count Of Routes Advertised to Peer Count Of Routes Advertised To Peer by ExpressRoute Gateway |
ScalableExpressRouteGatewayCountOfRoutesAdvertisedToPeer |
No | Count | Maximum | BgpPeerAddress |
PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D | No |
| Count Of Routes Learned from Peer Count Of Routes Learned From Peer by ExpressRoute Gateway |
ScalableExpressRouteGatewayCountOfRoutesLearnedFromPeer |
No | Count | Maximum | BgpPeerAddress |
PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D | No |
| Frequency of Routes change Frequency of Routes change in ExpressRoute Gateway |
ScalableExpressRouteGatewayFrequencyOfRoutesChanged |
No | Count | Total (Sum) | <none> | PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D | No |
| Max Flows Created Per Second Maximum Number of Flows Created Per Second on ExpressRoute Gateway |
ScalableExpressRouteGatewayMaxFlowsCreationRate |
No | CountPerSecond | Maximum | direction |
PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D | No |
| Number of VMs in the Virtual Network Number of VMs in the Virtual Network |
ScalableExpressRouteGatewayNumberOfVmInVnet |
No | Count | Maximum | <none> | PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D | No |
| Scale Units Scale Unit metric for ExpressRouteGateway |
ScalableExpressRouteGatewayScaleUnit |
No | Count | Maximum, Minimum, Average | <none> | PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D | No |
Category: Traffic
| Metric | Name in REST API | Advanced platform metrics | Unit | Aggregation | Dimensions | Time Grains | DS Export |
|---|---|---|---|---|---|---|---|
| Gateway S2S Bandwidth Site-to-site bandwidth of a gateway in bytes per second |
AverageBandwidth |
No | BytesPerSecond | Average | Instance |
PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D | Yes |
| Gateway Inbound Flows Number of 5-tuple flows entering into a VPN gateway |
InboundFlowsCount |
No | Count | Maximum, Minimum | Instance |
PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D | Yes |
| Gateway Outbound Flows Number of 5-tuple flows exiting a VPN gateway |
OutboundFlowsCount |
No | Count | Maximum, Minimum | Instance |
PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D | Yes |
| Gateway P2S Bandwidth Point-to-site bandwidth of a gateway in bytes per second |
P2SBandwidth |
No | BytesPerSecond | Average | Instance |
PT1M, PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D | Yes |
| P2S Connection Count Point-to-site connection count of a gateway |
P2SConnectionCount |
No | Count | Total (Sum) | Protocol, Instance |
PT1M, PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D | Yes |
| Tunnel Bandwidth Average bandwidth of a tunnel in bytes per second |
TunnelAverageBandwidth |
No | BytesPerSecond | Average | ConnectionName, RemoteIP, Instance |
PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D | Yes |
| Tunnel Egress Bytes Outgoing bytes of a tunnel |
TunnelEgressBytes |
No | Bytes | Total (Sum) | ConnectionName, RemoteIP, Instance |
PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D | Yes |
| Tunnel Egress Packets Outgoing packet count of a tunnel |
TunnelEgressPackets |
No | Count | Total (Sum) | ConnectionName, RemoteIP, Instance |
PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D | Yes |
| Tunnel Ingress Bytes Incoming bytes of a tunnel |
TunnelIngressBytes |
No | Bytes | Total (Sum) | ConnectionName, RemoteIP, Instance |
PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D | Yes |
| Tunnel Ingress Packets Incoming packet count of a tunnel |
TunnelIngressPackets |
No | Count | Total (Sum) | ConnectionName, RemoteIP, Instance |
PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D | Yes |
| Tunnel NAT Allocations Count of allocations for a NAT rule on a tunnel |
TunnelNatAllocations |
No | Count | Total (Sum) | NatRule, ConnectionName, RemoteIP, Instance |
PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D | No |
| Tunnel NATed Bytes Number of bytes that were NATed on a tunnel by a NAT rule |
TunnelNatedBytes |
No | Bytes | Total (Sum) | NatRule, ConnectionName, RemoteIP, Instance |
PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D | No |
| Tunnel NATed Packets Number of packets that were NATed on a tunnel by a NAT rule |
TunnelNatedPackets |
No | Count | Total (Sum) | NatRule, ConnectionName, RemoteIP, Instance |
PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D | No |
| Tunnel NAT Flows Number of NAT flows on a tunnel by flow type and NAT rule |
TunnelNatFlowCount |
No | Count | Total (Sum) | NatRule, FlowType, ConnectionName, RemoteIP, Instance |
PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D | No |
| Tunnel Peak PPS Tunnel Peak Packets Per Second |
TunnelPeakPackets |
No | Count | Maximum | ConnectionName, RemoteIP, Instance |
PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D | Yes |
| Tunnel Reverse NATed Bytes Number of bytes that were reverse NATed on a tunnel by a NAT rule |
TunnelReverseNatedBytes |
No | Bytes | Total (Sum) | NatRule, ConnectionName, RemoteIP, Instance |
PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D | No |
| Tunnel Reverse NATed Packets Number of packets on a tunnel that were reverse NATed by a NAT rule |
TunnelReverseNatedPackets |
No | Count | Total (Sum) | NatRule, ConnectionName, RemoteIP, Instance |
PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D | No |
| Tunnel Total Flow Count Total flow count on a tunnel |
TunnelTotalFlowCount |
No | Count | Total (Sum) | ConnectionName, RemoteIP, Instance |
PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D | Yes |