- 4 minutes to read

Manage Azure API Management Service APIs monitoring

Manage monitoring options and perform remote administrative actions on APIs for configured Azure API Management Services.

To Manage other parts of Azure API Management Service using Nodinite; Review the following user guides:

Delegate the ability to control all or individual APIs to selected team members and the business. This feature helps the people involved in the support and maintenance team have the power to manage problems with your APIs without having individual direct access to the Microsoft Azure Portal. Reducing access limits the number of attack vectors, and having fewer people with fewer access rights minimizes the risk for disruption of mission-critical services.

Application Management Team IT Operations Business
Let your AM team have the power to detect application-related problems without involving the IT operations team Stay in complete control with access to everything Give your business Data and self-service for solutions built using Azure API Management Service

Management Features

For Resources in the Role-based Monitor Views with the Remote Actions privilege grant; The following Remote Actions grouped by Category are available:

Category Monitoring Actions Metrics/Statistics
API Management Service - API Test API
Details
-

As an Administrator with access to the Configuration for Monitoring Agents, the additional monitoring options are available:

Monitoring Remote Configuration
Monitoring Azure API Management Service
  • Add and Remove Azure API Management Service connections
  • Enable and Disable Monitoring as specified
  • Edit monitoring thresholds

    API

    The 'API Management Service - API' Category provides one resource for each API discovered from the set of configured Azure API Management Services. The name of the Resource is a combination of the Display Name and the Name.

    %Display Name% (%Name%)

    API Management Service APIs
    Example from a Monitor View with a list of configured 'API Management Service APIs'

    See Monitoring Azure API Management Service for additional details about Azure API Management Service Monitoring.

    The API Management Service - API category provides Resources that display the evaluated monitored state according to user-defined thresholds.

    Remote Actions

    The following Remote Actions are available for the API Management Service Category.

    1. Details
    2. Edit
    3. Test API

    Actions
    Example with a list of Remote Actions as seen from the dropdown menu of the Actions button.

    Details

    To view the selected API; Click the Action button and then click on the Details menu item within the 'Control Center' section.

    Details Menu Action
    Use the 'Details' action menu item to open the details modal for the selected API.

    Next, click the option to present the modal.
    API details
    Here's an example of details for selected API.

    Expand the API Operations accordion to see the complete list of operations:
    API Operations
    Here's an example of API Operations.

    Test API

    To test the API; Click the Action button and then click on the Test API menu item within the 'Control Center' section.

    Test Action
    Test API Action button menu item.

    Next, click the option to present the modal.
    Test API Modal
    Here's an example of the Test API modal.

    Click on one of the operations to populate the parameters section:
    Operation Parameters
    Here's an example of API Parameters to be set to test the API.

    1. Template parameters - As defined by the API

      • Name - The name of the parameter (read-only)
      • Value - The value to use for the parameter
      • Type - The data type for the parameter (read-only)
      • Description - The description for the parameter (read-only)
    2. Query parameters - Other optional parameters

      • Name - The name of the parameter
      • Value - The value to use for the parameter
      • Type - The data type for the parameter (string; read-only)
      • Description - The description for the parameter (default; read-only)
    3. Headers - The headers to be applied

      • Name - The name of the header
      • Value - The value to use for the header
      • Type - The data type for the parameter (read-only)
      • Description - The description for the parameter (read-only)
    4. Apply product scope - If Products exist; Select the product scope

    5. Request URL - As defined by the API

    Click the Test button to invoke the API.
    Test
    Test API button.

    Edit

    The Action Edit is implemented as a placeholder for the future. Please request new features to support@nodinite.com.
    Edit API Modal


    Next Step

    Managing API
    Global Configuration of the Azure Monitoring agent

    Azure Logging and Monitoring Overview
    Prerequisites for Azure Agent