Supported metrics for microsoft.network/vpngateways

The following table lists the metrics available for the microsoft.network/vpngateways 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.
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, PT1M indicates that the metric is sampled every minute, PT30M every 30 minutes, PT1H every hour, and so on.
DS Export- Whether the metric is exportable to Azure Monitor Logs via Diagnostic Settings. For information on exporting metrics, see 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/vpngateways

Category	Metric	Name in REST API	Unit	Aggregation	Dimensions	Time Grains	DS Export
Traffic	Gateway S2S Bandwidth Site-to-site bandwidth of a gateway in bytes per second	AverageBandwidth	BytesPerSecond	Average	Instance	PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D	Yes
Routing	BGP Peer Status Status of BGP peer	BgpPeerStatus	Count	Average	BgpPeerAddress, Instance	PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D	No
Routing	BGP Routes Advertised Count of Bgp Routes Advertised through tunnel	BgpRoutesAdvertised	Count	Total	BgpPeerAddress, Instance	PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D	Yes
Routing	BGP Routes Learned Count of Bgp Routes Learned through tunnel	BgpRoutesLearned	Count	Total	BgpPeerAddress, Instance	PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D	Yes
Traffic	Gateway Inbound Flows Number of 5-tuple flows entering into a VPN gateway	InboundFlowsCount	Count	Maximum, Minimum	Instance	PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D	Yes
Ipsec	Tunnel MMSA Count MMSA Count	MmsaCount	Count	Total	ConnectionName, RemoteIP, Instance	PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D	Yes
Traffic	Gateway Outbound Flows Number of 5-tuple flows exiting a VPN gateway	OutboundFlowsCount	Count	Maximum, Minimum	Instance	PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D	Yes
Ipsec	Tunnel QMSA Count QMSA Count	QmsaCount	Count	Total	ConnectionName, RemoteIP, Instance	PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D	Yes
Traffic	Tunnel Bandwidth Average bandwidth of a tunnel in bytes per second	TunnelAverageBandwidth	BytesPerSecond	Average	ConnectionName, RemoteIP, Instance	PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D	Yes
Traffic	Tunnel Egress Bytes Outgoing bytes of a tunnel	TunnelEgressBytes	Bytes	Total	ConnectionName, RemoteIP, Instance	PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D	Yes
Errors	Tunnel Egress Packet Drop Count Count of outgoing packets dropped by tunnel	TunnelEgressPacketDropCount	Count	Total	ConnectionName, RemoteIP, Instance	PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D	Yes
Errors	Tunnel Egress TS Mismatch Packet Drop Outgoing packet drop count from traffic selector mismatch of a tunnel	TunnelEgressPacketDropTSMismatch	Count	Total	ConnectionName, RemoteIP, Instance	PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D	Yes
Traffic	Tunnel Egress Packets Outgoing packet count of a tunnel	TunnelEgressPackets	Count	Total	ConnectionName, RemoteIP, Instance	PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D	Yes
Traffic	Tunnel Ingress Bytes Incoming bytes of a tunnel	TunnelIngressBytes	Bytes	Total	ConnectionName, RemoteIP, Instance	PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D	Yes
Errors	Tunnel Ingress Packet Drop Count Count of incoming packets dropped by tunnel	TunnelIngressPacketDropCount	Count	Total	ConnectionName, RemoteIP, Instance	PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D	Yes
Errors	Tunnel Ingress TS Mismatch Packet Drop Incoming packet drop count from traffic selector mismatch of a tunnel	TunnelIngressPacketDropTSMismatch	Count	Total	ConnectionName, RemoteIP, Instance	PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D	Yes
Traffic	Tunnel Ingress Packets Incoming packet count of a tunnel	TunnelIngressPackets	Count	Total	ConnectionName, RemoteIP, Instance	PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D	Yes
Traffic	Tunnel NAT Allocations Count of allocations for a NAT rule on a tunnel	TunnelNatAllocations	Count	Total	NatRule, ConnectionName, RemoteIP, Instance	PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D	No
Traffic	Tunnel NATed Bytes Number of bytes that were NATed on a tunnel by a NAT rule	TunnelNatedBytes	Bytes	Total	NatRule, ConnectionName, RemoteIP, Instance	PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D	No
Traffic	Tunnel NATed Packets Number of packets that were NATed on a tunnel by a NAT rule	TunnelNatedPackets	Count	Total	NatRule, ConnectionName, RemoteIP, Instance	PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D	No
Traffic	Tunnel NAT Flows Number of NAT flows on a tunnel by flow type and NAT rule	TunnelNatFlowCount	Count	Total	NatRule, FlowType, ConnectionName, RemoteIP, Instance	PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D	No
Errors	Tunnel NAT Packet Drops Number of NATed packets on a tunnel that dropped by drop type and NAT rule	TunnelNatPacketDrop	Count	Total	NatRule, DropType, ConnectionName, RemoteIP, Instance	PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D	No
Traffic	Tunnel Peak PPS Tunnel Peak Packets Per Second	TunnelPeakPackets	Count	Maximum	ConnectionName, RemoteIP, Instance	PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D	Yes
Traffic	Tunnel Reverse NATed Bytes Number of bytes that were reverse NATed on a tunnel by a NAT rule	TunnelReverseNatedBytes	Bytes	Total	NatRule, ConnectionName, RemoteIP, Instance	PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D	No
Traffic	Tunnel Reverse NATed Packets Number of packets on a tunnel that were reverse NATed by a NAT rule	TunnelReverseNatedPackets	Count	Total	NatRule, ConnectionName, RemoteIP, Instance	PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D	No
Traffic	Tunnel Total Flow Count Total flow count on a tunnel	TunnelTotalFlowCount	Count	Total	ConnectionName, RemoteIP, Instance	PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D	Yes
Routing	VNet Address Prefix Count Count of Vnet address prefixes behind gateway	VnetAddressPrefixCount	Count	Total	Instance	PT5M, PT15M, PT30M, PT1H, PT6H, PT12H, P1D	Yes