API Management Services by APIs Test

How often should the test be executed.

The host for which the test is to be configured.

Specify the GUID which uniquely identifies the Microsoft Azure Subscription to be monitored. To know the ID that maps to the target subscription, do the following:

1. Login to the Microsoft Azure Portal.

2. When the portal opens, click on the Subscriptions option (as indicated by Figure 1).

   

   Figure 1 : Clicking on the Subscriptions option

3. Figure 2 that appears next will list all the subscriptions that have been configured for the target Azure AD tenant. Locate the subscription that is being monitored in the list, and check the value displayed for that subscription in the Subscription ID column.

   

   Figure 2 : Determining the Subscription ID

4. Copy the Subscription ID in Figure 2 to the text box corresponding to the SUBSCRIPTION ID parameter in the test configuration page.

Specify the Directory ID of the Azure AD tenant to which the target subscription belongs. To know how to determine the Directory ID, refer to Configuring the eG Agent to Monitor Microsoft Azure API Management Using Azure ARM REST API.

To connect to the target subscription, the eG agent requires an Access token in the form of an Application ID and the client secret value. For this purpose, you should register a new application with the Azure AD tenant. To know how to create such an application and determine its Application ID and client secret, refer to Configuring the eG Agent to Monitor Microsoft Azure API Management Using Azure ARM REST API. Specify the Application ID of the created Application in the Client ID text box and the client secret value in the Client Password text box. Confirm the Client Password by retyping it in the Confirm Password text box.

In some environments, all communication with the Azure cloud could be routed through a proxy server. In such environments, you should make sure that the eG agent connects to the cloud via the proxy server and collects metrics. To enable metrics collection via a proxy, specify the IP address of the proxy server and the port at which the server listens against the Proxy Host and Proxy Port parameters. By default, these parameters are set to none, indicating that the eG agent is not configured to communicate via a proxy, by default.

If the proxy server requires authentication, then, specify a valid proxy user name and password in the Proxy Username and Proxy Password parameters, respectively. Then, confirm the password by retyping it in the Confirm Password text box.

Specify the time limit in the Slow response duration in seconds text box for the request to get responded by the API. If the time taken for the response by the API is more than the set limit, then those responses are categorized as slow responses.

Specify the time limit in the Slow backend response duration in seconds text box for the request to get responded at the backend of the API. If the time taken for the response at the backend of the API is more than the set limit, then those responses are categorized as slow responses.

A resource group is a container that holds related resources for an Azure solution. The resource group can include all the resources for the solution, or only those resources that you want to manage as a group. Specify the name of the particular Resource Group which is a part of the Azure API Management to be managed in the Resource Group text box.

The Azure API Management allows you to manage multiple APIs under multiple services and reports the specific metrics for all APIs under each service. Specify the name of such Azure API Management Service in the APIM Service Name text box.

To show all the API Instances capability in this test for a particular service, choose the Yes option. To disable the capability, click on the No option.

Refers to the frequency with which detailed diagnosis measures are to be generated for this test. The default is 1:1. This indicates that, by default, detailed measures will be generated every time this test runs, and also every time the test detects a problem. You can modify this frequency, if you so desire. Also, if you intend to disable the detailed diagnosis capability for this test, you can do so by specifying none against DD Frequency.