Intune API Access Test
The Microsoft Graph API for Intune enables programmatic access to Intune information for your tenant; the API performs the same Intune operations as those available through the Azure Portal.
eG Enterprise uses the Microsoft Graph API for Intune to pull metrics on the health of Microsoft Azure Intune. If there are issues in the connectivity between the eG agent and the API, or if any slowness is observed in the responsiveness of the API, eG's monitoring service is bound to get affected. This is why, it is important to periodically check the accessibility of the Microsoft Graph API. This can be achieved using the Intune API Access test!
This test periodically checks the availability of the Microsoft Graph API. Additionally, the test measures the responsiveness of the API to requests from the eG agent. In the process, the test brings to focus bottlenecks in the functioning of the API by revealing the response code returned. If the eG agent is unable to pull metrics from Microsoft Azure Intune or is experiencing some delay in the process, then these metrics will help you explain why - is it because the API is inaccessible/unavailable? or is it owing to the poor responsiveness of the API?
Target of the Test: Microsoft Azure Intune
Agent deploying the test: A remote agent
Output of the test: One set of results for the target Microsoft Azure Intune being monitored
Parameters | Description |
---|---|
Test Period |
How often should the test be executed. |
Host |
The host for which the test is to be configured. |
Tenant ID |
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 Intune Using Intune REST API. |
Client ID, Client Password, and Confirm Password |
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 Intune Using Intune 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. |
Proxy Host and Proxy Port |
In some environments, all communication with the Azure cloud 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. |
Proxy Username, Proxy Password and Confirm Password |
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. |
DD Frequency |
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. |
Detailed Diagnosis |
To make diagnosis more efficient and accurate, the eG Enterprise embeds an optional detailed diagnostic capability. With this capability, the eG agents can be configured to run detailed, more elaborate tests as and when specific problems are detected. To enable the detailed diagnosis capability of this test for a particular server, choose the On option. To disable the capability, click on the Off option. The option to selectively enable/disable the detailed diagnosis capability will be available only if the following conditions are fulfilled:
|
Measures reported by the test:
Measurement | Description | Measurement Unit | Interpretation |
---|---|---|---|
API availability |
Indicates the availability of Intune API. |
Percent |
A value of 100 percent indicates that the Intune API is available and a value of 0 indicates that the Intune API is not available. The detailed diagnosis of this measure lists the error message reported when the availability of the API is 0. |
Response code |
Indicates the response code returned by the Intune API for the requests received. |
Number |
A value between 200 and 300 indicates a good response. A 4xx value indicates a problem with the requested content (e.g., page not found). A 5xx value indicates a server error. |
Response time |
Indicates the time taken by Intune API to respond to the requests it receives. |
Seconds |
Response time being high denotes a problem. Poor response times may be due to the Azure Intune being overloaded or misconfigured. |