Azure Api Management

Available Metrics

Possible metric types that can be tracked on a given resource.

Metric Type Data Type Description
AggregatedMetric
Object
Allows for aggregating existing metrics over a period of time. Useful for running sums or averages; also for extracting single data item from collection-based metrics
AzureAdvisorHealthMetric
AzureAdvisorHealth
AvailabilityState String
Summary String
ReasonType String
ReasonChronicity String
DetailedStatus String
OccuredTime DateTime
ReportedTime DateTime
Tracks Azure health using latest Azure Health API - more info @ https://docs.microsoft.com/en-us/rest/api/resourcehealth/availabilitystatuses/getbyresource/
AzureAdvisorRecommendationMetric
AzureAdvisorRecommendation[]
Category String
Impact String
LastUpdated Nullable`1
Risk String
Problem String
Solution String
Tracks Azure recommendations using latest Azure Advisor API - more info @ https://docs.microsoft.com/en-us/rest/api/advisor/
AzureApiManagementRequests
ApiManagementRequest
IpAddress String
ResponseCode Nullable`1
BackendResponseCode String
ApiTime Nullable`1
ServiceTime Nullable`1
ApiId String
OperationId String
ProductId String
UserId String
Method String
Url String
ResponseSize Nullable`1
RequestSize Nullable`1
Cache String
ApiRegion String
SubscriptionId String
RequestId String
Tracks and visualizes API requests
AzureApiManagementStatisticsByApi
AzureApiManagementStatisticByApi[]
Name String
CallCountSuccess Nullable`1
CallCountBlocked Nullable`1
CallCountFailed Nullable`1
CallCountOther Nullable`1
CallCountTotal Nullable`1
Bandwidth Nullable`1
CacheHitCount Nullable`1
cacheMissCount Nullable`1
apiTimeAvg Nullable`1
apiTimeMin Nullable`1
apiTimeMax Nullable`1
serviceTimeAvg Nullable`1
serviceTimeMin Nullable`1
serviceTimeMax Nullable`1
Tracks and visualizes statistics of using API grouped by API Name
AzureApiManagementStatisticsByGeo
AzureApiManagementStatisticByGeo[]
Country String
Region String
Zip String
CallCountSuccess Nullable`1
CallCountBlocked Nullable`1
CallCountFailed Nullable`1
CallCountOther Nullable`1
CallCountTotal Nullable`1
Bandwidth Nullable`1
CacheHitCount Nullable`1
cacheMissCount Nullable`1
apiTimeAvg Nullable`1
apiTimeMin Nullable`1
apiTimeMax Nullable`1
serviceTimeAvg Nullable`1
serviceTimeMin Nullable`1
serviceTimeMax Nullable`1
Tracks and visualizes statistics of using API grouped by users location
AzureApiManagementStatisticsByOperation
AzureApiManagementStatisticByOperation[]
Name String
CallCountSuccess Nullable`1
CallCountBlocked Nullable`1
CallCountFailed Nullable`1
CallCountOther Nullable`1
CallCountTotal Nullable`1
Bandwidth Nullable`1
CacheHitCount Nullable`1
cacheMissCount Nullable`1
apiTimeAvg Nullable`1
apiTimeMin Nullable`1
apiTimeMax Nullable`1
serviceTimeAvg Nullable`1
serviceTimeMin Nullable`1
serviceTimeMax Nullable`1
Tracks and visualizes statistics of using API grouped by operation
AzureApiManagementStatisticsByProduct
AzureApiManagementStatisticByProduct[]
Name String
CallCountSuccess Nullable`1
CallCountBlocked Nullable`1
CallCountFailed Nullable`1
CallCountOther Nullable`1
CallCountTotal Nullable`1
Bandwidth Nullable`1
CacheHitCount Nullable`1
cacheMissCount Nullable`1
apiTimeAvg Nullable`1
apiTimeMin Nullable`1
apiTimeMax Nullable`1
serviceTimeAvg Nullable`1
serviceTimeMin Nullable`1
serviceTimeMax Nullable`1
Tracks and visualizes statistics of using API grouped by product
AzureApiManagementStatisticsBySubscription
AzureApiManagementStatisticBySubscription[]
Name String
UserId String
ProductId String
SubscriptionId String
CallCountSuccess Nullable`1
CallCountBlocked Nullable`1
CallCountFailed Nullable`1
CallCountOther Nullable`1
CallCountTotal Nullable`1
Bandwidth Nullable`1
CacheHitCount Nullable`1
cacheMissCount Nullable`1
apiTimeAvg Nullable`1
apiTimeMin Nullable`1
apiTimeMax Nullable`1
serviceTimeAvg Nullable`1
serviceTimeMin Nullable`1
serviceTimeMax Nullable`1
Tracks and visualizes statistics of using API grouped by Subscription
AzureApiManagementStatisticsByUser
AzureApiManagementStatisticByUser[]
Name String
CallCountSuccess Nullable`1
CallCountBlocked Nullable`1
CallCountFailed Nullable`1
CallCountOther Nullable`1
CallCountTotal Nullable`1
Bandwidth Nullable`1
CacheHitCount Nullable`1
cacheMissCount Nullable`1
apiTimeAvg Nullable`1
apiTimeMin Nullable`1
apiTimeMax Nullable`1
serviceTimeAvg Nullable`1
serviceTimeMin Nullable`1
serviceTimeMax Nullable`1
Tracks and visualizes statistics of using API grouped by User
AzureApiManagementStatisticsValue
Double
Tracks and visualizes statistics value as chart
AzureMonitorMetric
Double
Tracks Azure metrics using latest Azure Monitor API - more info @ https://docs.microsoft.com/en-us/rest/api/monitor/
DerivedMetric
Double
Allows for deriving new metrics from existing ones. Useful for combining existing metrics together or for multiplying metrics by a factor
LinkedMetric
Object
Allows for tracking of metrics from other resources. Useful when it is important to evaluate metrics from different resources side-by-side
ResourceStatus
String
Tracks overall status of the resource. This is an important metric as it is used to drive Uptime reports. Possible values: Ready, Down, Unknown and in some cases Stopped

Available Commands

Possible commands that can be executed on a given resource. Ultimate subscription is required.

Command Type Description
WebRequest Runs custom WebRequest to specified URL

Default Templates

CloudMonix provided default monitoring templates.

Pre-configured Metrics

Metric Name Metric Type Description
BlockedRequestsCount AzureApiManagementStatisticsValue
FailedRequestsCount AzureApiManagementStatisticsValue
FailedRequestsLog AzureApiManagementRequests
RecommendedActions AzureAdvisorRecommendationMetric Tracks recommended actions for specified resource.
StatisticsByApi AzureApiManagementStatisticsByApi
StatisticsByGeo AzureApiManagementStatisticsByGeo
StatisticsByOperation AzureApiManagementStatisticsByOperation
StatisticsByProduct AzureApiManagementStatisticsByProduct
StatisticsBySubscription AzureApiManagementStatisticsBySubscription
StatisticsByUser AzureApiManagementStatisticsByUser
TotalRequestsCount AzureApiManagementStatisticsValue