Azure API Access Test

The Azure Resource Manager provides a consistent management layer for the tasks performed through Azure PowerShell, Azure CLI, Azure portal, REST API, and development tools. All the tools use a common set of operations. These tools can be chosen and used in a hassle free manner. The Azure Resource Manager communicates with the development tools using the Azure Resource manager API. The API passes requests from the tools to the Resource Manager service, which authenticates and authorizes the requests. Resource Manager then routes the requests to the appropriate resource providers. If the Resource Manager API is not accessible, then the tools hosted on the Azure may not be available. Therefore it is necessary to periodically check the accessibility of the Resource manager API. The Azure API Access test helps administrators in this regard.

This test helps administrators figure out whether/not the API is accessible.

Target of the Test : Microsoft Azure

Agent deploying the test: A remote agent

Output of the test: One set of results for each cloud service of the target Microsoft Azure being monitored

Configurable parameters for the test
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 Active Directory that is associated with the subscription of the target Microsoft Azure. To know how to determine the Directory ID, refer to Pre-Requisites for Monitoring Microsoft Azure (ARM).

Client ID and Client Password

The eG agent communicates with the target Microsoft Azure using JAVA API calls. To collect the required metrics, the eG agent requires an Access token in the form of an Application ID and the client secret value. To know more about determining the Application ID and the key refer to Broad Steps to Determine the Tenant ID and the Access Token. Specify the Application ID of the created Web Application in the Client ID text box and the client secret value in the Client Password text box.

Measures made by the test
Measurement Description Measurement Unit Interpretation

Is API accessible?

Indicates whether/not the API is accessible.

 

The values reported by this measure and its numeric equivalents are mentioned in the table below:

Measure Value Numeric Value
Yes 1
No 0

Note:

By default, this measure reports the Measure Values listed in the table above to indicate whether/not the API is accessible. The graph of this measure however, represents the status of a server using the numeric equivalents only i.e., 0 or 1.