Azure API Management

Azure API Management is a hybrid, multicloud management platform for APIs across all environments.

You must configure cloud connections to monitor this entity. See Configure Azure Cloud Connection.

Cisco Cloud Observability displays Azure entities on the Observe page. Metrics are displayed for specific entity instances in the list and detail views.

This document contains references to third-party documentation. Splunk AppDynamics does not own any rights and assumes no responsibility for the accuracy or completeness of such third-party documentation.

Detail View

To display the detail view for Azure API Management:

Navigate to the Observe page.
Under Managed Application Hosting, click Azure API Management.
The list view now displays.
Click an instance Name to display the detail view.
The detail view displays metrics, key performance indicators, and properties (attributes) related to the instance you selected.

Metrics and Key Performance Indicators

Cisco Cloud Observability displays the following metrics and key performance indicators (KPIs) for Azure API Management. See Supported metrics for Microsoft.ApiManagement/service.

Display Name	Source Metric Name	Description
Capacity (%)	`Capacity`	The utilization metric for the API Management service. For SKUs other than Premium, the `Max` aggregation will show the value as 0.
Backend Duration (ms)	`BackendDuration`	The duration of backend requests in milliseconds.
Total Duration (ms)	`Duration`	The overall duration of gateway requests in milliseconds.
Requests (Count)	`Requests`	The number of gateway request metrics with multiple dimensions.
Network Connectivity	`NetworkConnectivity`	The network connectivity status of dependent resource types from the API Management service.
EventHub Events	`EventHubDroppedEvents`	The number of events skipped because the queue size limit was reached.
	`EventHubRejectedEvents`	The number of rejected Event Hub events (wrong configuration or unauthorized).
	`EventHubSuccessfulEvents`	The number of successful Event Hub events.
	`EventHubThrottledEvents`	The number of throttled Event Hub events.
	`EventHubTimedoutEvents`	The number of timed out Event Hub events.
	`EventHubTotalBytesSent`	The total size of Event Hub events in bytes.
	`EventHubTotalEvents`	The number of events sent to Event Hub.
	`EventHubTotalFailedEvents`	The number of failed Event Hub events.

Properties (Attributes)

Cisco Cloud Observability displays the following properties for Azure API Management.

Display Name	Property Name	Description
Resource Name	`azure.api_management_service.name`	The resource name.
Resource Group	`azure.resource.group`	The resource group of the API Management service.
ID	`azure.resource.id`	The fully qualified ID of the Azure API Management service.
Disable Gateway	`azure.api_management_service.disableGateway`	This property is only valid for an API Management service deployed in multiple locations. This can be used to disable the gateway in this additional location.
Publisher Email	`azure.api_management_service.publisherEmail`	The publisher email.
Publisher Name	`azure.api_management_service.publisherName`	The publisher name.
Provisioning State	`azure.api_management_service.provisioningState`	The current provisioning state of the API Management service, which can be one of the following: `Created` `Activating` `Succeeded` `Updating` `Failed` `Stopped` `Terminating` `TerminationFailed` `Deleted`
Gateway URL	`azure.api_management_service.gatewayUrl`	The gateway URL of the API Management service.
Gateway Regional URL	`azure.api_management_service.gatewayRegionalUrl`	The gateway URL of the API Management service in the region.
Portal URL	`azure.api_management_service.portalUrl`	The publisher portal endpoint URL of the API Management service.
Developer Portal URL	`azure.api_management_service.developerPortalUrl`	The developer portal endpoint URL of the API Management service.
Management API URL	`azure.api_management_service.managementApiUrl`	The management API endpoint URL of the API Management service.
SCM URL	`azure.api_management_service.scmUrl`	The SCM endpoint URL of the API Management service.
SKU Name	`azure.api_management_service.sku.name`	The name of the SKU.
SKU Capacity	`azure.api_management_service.sku.capacity`	The capacity of the SKU (number of deployed units of the SKU). For the consumption SKU, the capacity must be specified as 0.
Created At	`azure.api_management_service.created_at`	The timestamp that the resource was created, in UTC format.
Created By	`azure.api_management_service.created_by`	The identity that created the resource.
Last Modified At	`azure.api_management_service.last_modified_at`	The timestamp that the resource was last modified, in UTC format.
Last Modified By	`azure.api_management_service.last_modified_by`	The identity that last modified the resource.

Retention and Purge Time-To-Live (TTL)

For all cloud and infrastructure entities, the retention TTL is 180 minutes (3 hours) and the purge TTL is 525,600 minutes (365 days).

Microsoft Azure, the Microsoft Azure logo, Azure, and any other Microsoft Azure Marks used in these materials are trademarks of Microsoft Corporation or its affiliates in the United States and/or other countries.