API Management helps organizations publish APIs to external, partner, and internal developers to unlock the potential of their data and services.

Businesses everywhere want to extend their operations as a digital platform, creating new channels, finding new customers, and driving deeper engagement with existing ones. API Management provides the core competencies to ensure a successful API program through developer engagement, business insights, analytics, security, and protection.

You can use Azure API Management to take any back end and launch a full-fledged API program based on it. Also, use the Azure public cloud integration to discover and collect metrics against the Azure service.


To set up the Azure integration and discover the API Management, do the following:

  1. Create an Azure Integration if not available in your installed integrations. For more information on how to install the Azure Integration, refer to Install Azure integration.

  2. Create a discovery profile.

  3. Select Azure API Management under the Filter Criteria on the Edit Discovery Profile page.

  4. Save the discovery profile to make it available in the list of Discovery Profiles.

  5. Scan to discover the resources at any time independent of the predefined schedule.

  6. Once the scan is completed, you can view the API Management resources under Infrastructure > Resources > Microsoft Azure category.

  7. Create a template with collector type Azure and applicable for API Management. See Create a Template for more information on how to create a template.

  8. Refer to Assign a Template on how to assign a template to a resource.

  9. Click the Metrics tab to view the monitoring data of Azure API Management.

Event support

OpsRamp supports Azure events for Azure API Management. Configure Azure Events in OpsRamp Azure integration discovery profile. See Process Azure Events for more information on how to configure Azure events.

Supported metrics

OpsRamp MetricAzure MetricMetric Display NameUnitDescriptionAggregation Type
azure_apimanagement_service_TotalRequestsTotalRequestsTotal Gateway Requests (Deprecated)CountNumber of gateway requests.Total
azure_apimanagement_service_SuccessfulRequestsSuccessfulRequestsSuccessful Gateway Requests (Deprecated)CountNumber of successful gateway requests.Total
azure_apimanagement_service_UnauthorizedRequestsUnauthorizedRequestsUnauthorized Gateway Requests (Deprecated)CountNumber of unauthorized gateway requests.Total
azure_apimanagement_service_FailedRequestsFailedRequestsFailed Gateway Requests (Deprecated)CountNumber of failed gateway requests.Total
azure_apimanagement_service_OtherRequestsOtherRequestsOther Gateway Requests (Deprecated)CountNumber of other gateway requests.Total
azure_apimanagement_service_DurationDurationOverall Duration of Gateway RequestsMillisecondsOverall duration of gateway requests in milliseconds.Average
azure_apimanagement_service_CapacityCapacityCapacity (Preview)PercentUtilization metric for the API management service.Maximum
azure_apimanagement_service_RequestsRequestsTotal Number of Gateway RequestsCountTotal number of gateway requests.Total
azure_apimanagement_service_EventHubTotalEventsEventHubTotalEventsTotal EventHub EventsCountTotal number of events sent to EventHub from API Management in a given period.Total
azure_apimanagement_service_EventHubSuccessfulEventsEventHubSuccessfulEventsSuccessful Eventhub EventsCountTotal number of successful EventHub events in a given period.Total
azure_apimanagement_service_EventHubTotalFailedEventsEventHubTotalFailedEventsTotal Failed Eventhub EventsCountTotal number of failed EventHub events in a given period.Total
azure_apimanagement_service_EventHubRejectedEventsEventHubRejectedEvents=Rejected Eventhub EventsCountTotal number of Rejected EventHub (wrong configuration or unauthorized) events in a given period.Total
azure_apimanagement_service_EventHubThrottledEventsEventHubThrottledEventsThrottled Eventhub EventsCountTotal number of Throttled EventHub events in a given period.Total
azure_apimanagement_service_EventHubTimedoutEventsEventHubTimedoutEventsTimedout Eventhub EventsCountTotal number of timed-out EventHub events in a given period.Total
azure_apimanagement_service_EventHubDroppedEventsEventHubDroppedEventsDropped Eventhub EventsCountTotal number of events skipped because of queue size limit reached in a given period.Total
azure_apimanagement_service_EventHubTotalBytesSentEventHubTotalBytesSentSize of EventHub EventsBytesTotal size of EventHub events in bytes in a given period.Total
azure_apimanagement_service_NetworkConnectivityNetworkConnectivityNetwork Connectivity Status of Resources (Preview)CountNetwork Connectivity status of dependent resource types from API Management service.Total
azure_apimanagement_service_BackendDurationBackendDurationDuration of Backend RequestsMilliSecondsRefers to the duration of backend requests in milliseconds.Average
azure_apimanagement_service_ConnectionAttemptsConnectionAttemptsWebSocket Connection Attempts (Preview)CountCount of Wwbsocket connection attempts based on selected source and destination.Total
azure_apimanagement_service_WebSocketMessagesWebSocketMessagesWebSocket Messages (Preview)CountCount of websocket messages based on selected source and destination.Total
cloud_instance_staten/aStatus/Staten/aStatus/State of the cloud instance.n/a

External reference

Azure API Management