Configuration of AzrApiAccessTest

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 cloud may not be available. Therefore it is necessary to periodically check the accessibility of the Resource manager API. The AzrApiAccessTest helps administrators in this regard.

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

The default parameters associated with this test are:

• The TEST PERIOD list box helps the user to decide how often this test needs to be executed.

• In the HOST text box, specify the HOST for which this test is to be configured.

• Specify the GUID which uniquely identifies the Microsoft Azure Subscription to be monitored in the SUBSCRIPTION ID text box.To know the ID that maps to the target subscription, click here.

• Specify the Directory ID of the Azure AD tenant to which the target subscription belongs in the TENANT ID text box. To know how to determine the Directory ID/Tenant ID, click here.

• The eG agent communicates with the target Microsoft Azure Subscrption 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.Specify the Application ID of the created Application in the CLIENT ID text box. To know how to determine the Application ID ,click here. Specify the client secret value in the CLIENT PASSWORD text box. To obtain the client secret value, click here.

• Confirm the CLIENT PASSWORD by retyping it in the CONFIRM PASSWORD text box.

• 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.

• 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.

• If multiple components of the same component type are awaiting configuration, then an APPLY TO OTHER COMPONENTS button will appear in this page. Clicking on this button will allow you to apply the configuration to all/selected components of that type.

• Once the necessary values have been provided, clicking on the UPDATE button will register the changes made.

When changing the configuration for specific servers, a “*” beside the text box corresponding to the parameter signifies that these values have to be manually configured by the user. The parameter values that require to be configured will typically be prefixed with a “$” or contain a series of “*”. A value of “none” in the parameter value indicates that the corresponding parameter value can be changed if required.