Manage Azure API Management Service Monitoring

Take full control of your Azure API Management Service monitoring with Nodinite. Manage, configure, and troubleshoot all monitoring options efficiently, without direct Azure Portal access. You and your teams perform Remote Actions, speed up root cause analysis, and securely delegate management with role-based self-service.

• ✅ Perform Remote Actions and manage monitoring for all API Management resources
• ✅ Create the Event Hub Logger for your API logging policy without the Azure Portal
• ✅ Give business and IT users secure, role-based self-service
• ✅ Reduce risk by limiting direct Azure Portal access
• ✅ Speed up root cause analysis with actionable insights

Manage monitoring options and perform remote administrative actions on Azure API Management Service related items for configured Azure subscriptions.

Start with Monitoring Azure API Management Service for an overview of what Nodinite monitors, which thresholds apply, and how it discovers the service, before you use the Remote Actions below.

You can manage other parts of Azure API Management Service with Nodinite. Review the following user guides:

• Manage API
• Manage Certificate
• Manage Event Hub Logger
• Manage Private Endpoint
• All Azure API Management Service features

Let your business and end-users manage and gain insights into selected Azure API Management Services in Azure. Nodinite Monitoring gives support and maintenance teams additional data for root cause analysis without granting individual Users direct access to the Microsoft Azure Portal. By reducing access, you limit attack vectors and minimize the risk of disruption to mission-critical services.

Diagram: The Nodinite Azure Agent monitors each API Management Service together with its Certificates, APIs, Event Hub Loggers, and Private Endpoints.

Management Features

For Resources in the Role-based Monitor Views with the Remote Actions privilege, these Remote Actions are available, grouped by Category:

As an Administrator with access to the Configuration for Monitoring Agents, you have these additional monitoring options:

API Management Service

The 'API Management Service' Category provides one resource for each 'Azure API Management Service' in the configured Azure Subscriptions and Resource Groups, with the deployed Azure name as the resource name:

Example from a Monitor View with a list of configured 'API Management Services'.

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

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

These Remote Actions are available for the API Management Service Category:

1. Details
2. Create Event Hub Logger

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

Details

To view the selected API Management Service resource, click the Action button and then click the Details menu item in the 'Control Center' section.

Use the 'Details' action menu item to open the details modal for the selected API Management Service.

Next, click the option to open the modal.

Example of details for the selected Azure API Management Service.

Create Event Hub Logger

The API Logging user guide details logging to Nodinite with a Policy; the Event Hub policy guide covers the Event Hub option.

If you are Logging from an API with the Azure API Management Service, your policy contains a named Logger. You can manage this logger from within Nodinite with these operations:

• Create (this page)
• Modify (Edit)
• Delete (Delete)

To Create a new Event Hub Logger, click the Action button and then click the Create Logger menu item in the 'Control Center' section.

Create Logger Action button menu item.

Next, click the option to open the modal.

Example of the create new logger modal.

1. Logger Name - Enter the name of the Event Hub logger. This name should rarely change, since your hard-coded policy uses it.

2. Event Hub Name - Enter the name of the Event Hub entity to use as target for the Nodinite JSON Log Event.

3. Event Hub Connection String - Enter the connection string with access to write events triggered by the policy.

   Note

   EntityPath should not be part of the Connection String.

4. Resource ID ^{New 6.2.1.2} - Enter the path to the target Event Hub entity:

   Format: /subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.EventHub/namespaces/{namespace}/eventhubs/{eventhub-name}
   Example: subscriptions/ae3da538-3e2b-4490-9feb-7dfe30a6683c/resourceGroups/Default-Storage-NorthEurope/providers/Microsoft.EventHub/namespaces/{NAMESPACENAME}/eventhubs/{EventHubName}

   Note

   This configuration is manual and can be tricky to set up correctly, especially since the target Event Hub entity might be located in a different resource group or namespace than the API Management Service where this Event Hub logger will be used.

5. Description - Optionally, provide a user-friendly description for this logger instance.

6. Is Buffered - The default is checked.

Click the Create button to persist changes.

Create operation button.

Tip

Use the Post remote action and send a JSON Log Event to the Event Hub entity, using an example from the Swagger in the Nodinite Log API, to validate that your configuration works.

Verify each part of the chain:

• ✅ Azure Agent configuration with the right to post to an Event Hub entity
• ✅ Pickup Service properly configured to read from the Event Hub entity
• ✅ Event Hub Logger operational; see Monitoring Event Hub Logger
• ✅ Policy operational in the Azure APIM Service API

Next Steps

• Monitoring API Management Service
• Manage Event Hub Logger
• Azure API Management logging
• Global Configuration of the Azure Monitoring agent

Related Topics

• Azure API Management Service Overview
• Azure Logging and Monitoring Overview
• Prerequisites for Azure Agent
• Troubleshooting
• Post a test message to an Event Hub
• Pickup Service
• Remote Actions
• Monitor Views