Edit

Supported metrics for microsoft.network/expressroutegateways

The following table lists the metrics available for the microsoft.network/expressroutegateways 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, PT1M indicates that the metric is sampled every minute, PT30M every 30 minutes, PT1H every hour, and so on.
  • DS Export - Shows 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.

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

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 <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
Bits In Per Second

Bits per second ingressing Azure via ExpressRoute Gateway which can be further split for specific connections
ErGatewayConnectionBitsInPerSecond No BitsPerSecond Total (Sum), Average, Minimum, Maximum ConnectionName PT1M No
Bits Out Per Second

Bits per second egressing Azure via ExpressRoute Gateway which can be further split for specific connections
ErGatewayConnectionBitsOutPerSecond No BitsPerSecond Total (Sum), Average, Minimum, Maximum ConnectionName PT1M No

Next steps