---
title: "Host Template: Cloud - Azure - API Management Services"
description: ""
url: "https://docs.itrsgroup.com/docs/opsview/6.11.7/opspacks/cloud-azure-opspack/cloud-azure-api-management-services-host-template/index.html"
---## Overview

Azure API Management helps organizations publish APIs to unlock the potential of their data and services. API Management provides the essentials to ensure a successful API program through developer engagement, business insights, analytics, security, and protection. You can use Azure API Management to take any backend and create a complete API program based on it.

This Host Template allows you to monitor all the metrics you need to efficiently run Azure API Management Services on Microsoft Azure. After installation, you'll be able to check the total number of requests, the overall duration of gateway requests as well as the utilisation percentage.

This Host Template includes the following Service Checks:

| Service&nbsp;Check&nbsp;Name | Description | Default&nbsp;Thresholds (Metric:&nbsp;Warning,&nbsp;Critical) | UOM |
|:-----------------------------|:------------|:------------------------------------------------:|:---:|
| Azure - API Management Service - Capacity | Utilization metric for ApiManagement service, in percent
[Default Timespan = 5mins, Default Check Interval = 5mins] | capacity: &#8203;`$WARNINGDT;70;85$`,`$CRITICALDT;90;95$`
[[Supports Dynamic Thresholds]](#dynamic-thresholds-support) | % |
| Azure - API Management Service - Duration | Overall Duration of Gateway Requests in milliseconds
[Default Timespan = 5mins, Default Check Interval = 5mins] | N/A | ms |
| Azure - API Management Service - Requests | Total number of requests by status
[Default Timespan = 5mins, Default Check Interval = 5mins] | N/A | N/A |


**Note**


The "Default Timespan" given for these Service Checks refers to the time period we use when retrieving metrics from Azure.




**Note**


See details about [Monitoring Plugin thresholds here](https://www.monitoring-plugins.org/doc/guidelines.html#THRESHOLDFORMAT).



### Dynamic Thresholds Support

Some Service Checks within this Host Template support [Dynamic Thresholds for Opsview Enterprise](https://docs.itrsgroup.com/docs/opsview/6.11.7/integrations/dynamic-thresholds/configuring-dynamic-thresholds/index.html#configure-service-checks).

## Prerequisites for monitoring

### Provide Subscription Access

To use this Host Template you will need to provide access to the subscription you wish to monitor.
Navigate to the **Subscriptions** section and select your Subscription.

In the Subscription to be monitored, click **Access Control (IAM)**.

Then click the **Add** button, select the required role and select the application, once for each of the following roles:

- **Reader**

![Add Subscription to Application](https://docscdn.itrsgroup.com/opsview/images/opspacks-cloud-azure-add_subscription_1.png)

![Add Subscription to Application](https://docscdn.itrsgroup.com/opsview/images/opspacks-cloud-azure-add_subscription_2.png)

Repeat these steps for each subscription you wish to monitor.

## Usage Instructions

Please review the overall [Cloud - Azure Opspack](https://docs.itrsgroup.com/docs/opsview/6.11.7/opspacks/cloud-azure-opspack/cloud-azure-opspack/index.html) documentation for details on prerequisites, known issues, and other necessary configurations that apply to all Host Templates in the Opspack.

### Add this Host Template

Add the **Cloud - Azure - API Management Services** Host Template to your Opsview Monitor host.
If the resource you're monitoring has no hostname or public IP, then open the **Advanced** settings pane and change **Host Check Command** to **Always assumed to be UP**.


**Note**


For more information, refer to the documentation on [Adding Host Templates to Hosts](https://docs.itrsgroup.com/docs/opsview/6.11.7/host/index.html#host-templates).



### Add and configure Variables

The Service Checks in this Host Template use the following variables, and they will be added to your Opsview Monitor instance alongside the Host Template:

- [**AZURE_CREDENTIALS**](#azure_credentials)
- [**AZURE_RESOURCE_DETAILS**](#azure_resource_details)


**Note**


For more information, refer to the documentation on [Adding Variables to Hosts](https://docs.itrsgroup.com/docs/opsview/6.11.7/adding-a-new-variable/index.html#adding-a-variable-to-a-host).



### Apply Changes

Apply Changes and the system will now be monitored:

![View Output](https://docscdn.itrsgroup.com/opsview/images/opspacks-cloud-azure-output-cloud-azure-api-management-services.png)

## Available Variables

### AZURE_CREDENTIALS

The Value is not used and therefore can be set to anything. Override the arguments with your Azure Credentials.

| Plugin&nbsp;Parameter | Position&nbsp;in Variable | Name | Description |
|:---------------------:|:-------------------------:|:-----|:------------|
| N/A (Opsview UI Only) | Value | Credentials | The credentials for your Azure Subscription |
| `--subscription-id` | Arg1 | Subscription ID | The Subscription ID of your Azure Subscription |
| `--client-id` | Arg2 | Client ID | The Client ID of your Azure Subscription |
| `--secret-key` | Arg3 | Secret Key | The Secret Key of your Azure Subscription |
| `--tenant-id` | Arg4 | Tenant ID | The Tenant ID of your Azure Subscription |

### AZURE_RESOURCE_DETAILS

The Value is not used and therefore can be set to anything. Override the arguments with your Azure Resource Details.

| Plugin&nbsp;Parameter | Position&nbsp;in Variable | Name | Description |
|:---------------------:|:-------------------------:|:-----|:------------|
| N/A (Opsview UI Only) | Value | Resource Details | The details of your Azure Resource |
| `--resource-group` | Arg1 | Resource Group | Name of the Azure resource group of your resource |
| `--resource-name` | Arg2 | Resource Name | Name of the Azure resource to be monitored |

## Plugin help

Plugin: `check_azure`


**Secure Args**


This plugin uses the [Secure Args](https://docs.itrsgroup.com/docs/opsview/6.11.7/configuration/secure-arguments/index.html) feature for argument passing.



For mode-specific help, run the plugin with the `-h -m <mode>` flags. This will list the required and optional Variable Arguments for that mode.
The appropriate mode for each Service Check is listed here:

| Service&nbsp;Check&nbsp;Name | Mode |
|:-----------------------------|:-----|
| Azure - API Management Service - Capacity | `Az.APS.Capacity` |
| Azure - API Management Service - Duration | `Az.APS.Duration` |
| Azure - API Management Service - Requests | `Az.APS.Request` |


