Diagnostics Settings to direct Audit Logs to Event Hub for APIM instance using Bicep

1. Hii @Taranjeet Malik

Welcome to the Microsoft Q&A Platform! Thank you for asking your question here.

To set up diagnostic settings for your Azure API Management (APIM) instance, first, check the Azure documentation to see which log categories are supported. You can also go to the Azure Portal, find your APIM instance, and manually configure diagnostic settings to see the available categories. This will help you choose the correct categories for your setup.

When updating your Bicep code for diagnostic settings, make sure to use valid category names. For Azure API Management (APIM), the common categories you should use are AuditLogs and GatewayLogs. Ensuring you use these correct names will help avoid errors and ensure that your diagnostic settings are configured properly.

Example for Bicep

resource apim 'Microsoft.ApiManagement/service@2021-08-01' existing = {

name: 'your-apim-instance-name'

}

resource apimdiaglogs 'Microsoft.Insights/diagnosticSettings@2021-05-01-preview' = {

name: '${apim.name}-diag'

scope: apim

properties: {

eventHubName: 'your-eventhub-name'

eventHubAuthorizationRuleId: 'your-eventhub-authorization-rule-id'

logs: [

  {

    category: 'AuditLogs'

    enabled: true

  }

  {

    category: 'GatewayLogs'

    enabled: true

  }

]
  }

}



To make sure your Bicep code is set up correctly, check that the scope in the diagnostic settings matches your APIM instance name. Confirm that the Event Hub name and authorization rule ID are correct. Also, use Azure Resource Explorer [https://resources.azure.com/]



To troubleshoot your deployment, check the Activity Logs in the Azure Portal for detailed error information. Also, try setting up diagnostic settings manually in the Azure Portal to see the available options and confirm that you are using the correct settings.

If you have any further queries, do let us know.

--------------------------------------------------------------------------------------

If the answer is helpful, please click "Accept Answer" and "Upvote it".