Azure Synapse: create a diagnostic settings using ARM teplates

Question

Hello,

please, is it possible/supported to create a diagnostic settings for Azure Synapse WS using ARM templates?
Found an example for Azure SQL DB:

resource-manager-diagnostic-settings

but could not find any related to Synapse WS. Thank you.

Answer 1

Hello @Simon Zeinstra please, can you try out this example:

{  
    "condition":"[equals(parameters('enableDiagnosticSettings'),'true')]",  
    "scope":"[format('Microsoft.Synapse/workspaces/{0}', variables('synapseWorkspaceName'))]",  
    "type":"Microsoft.Insights/diagnosticsettings",  
    "apiVersion":"2017-05-01-preview",  
    "name":"[concat('diag-', variables('synapseWorkspaceName'))]",  
    "dependsOn":[  
        "[resourceId('Microsoft.Synapse/workspaces', variables('synapseWorkspaceName'))]"  
    ],  
    "properties":{  
        "workspaceId":"[parameters('logAnalyticsWorkspaceId')]",  
        "copy":[  
            {  
                "name":"logs",  
                "count":"[length(parameters('synapseWsDiagLogs'))]",  
                "input":{  
                    "category":"[parameters('synapseWsDiagLogs')[copyIndex('logs')]]",  
                    "enabled":true  
                }  
            }  
        ]  
    }  
}  

And here is the param definition for Logs:

"synapseWsDiagLogs":{  
    "type":"array",  
    "defaultValue":[  
        "SynapseRbacOperations",  
        "GatewayApiRequests",  
        "BuiltinSqlReqsEnded",  
        "IntegrationPipelineRuns",  
        "IntegrationActivityRuns",  
        "IntegrationTriggerRuns"  
    ],  
    "metadata":{  
        "description":"List of log diagnostic events to capture from Synapse WS and send to log analytics"  
    }  
},  

Answer 2

[Code sample edited]
Thank you @Samara Soucy - MSFT , I tweaked the existing Azure SQL DB example and here is the working code snippet (sharing for others who might need to create Diagnostic Settings for Synapse WS in ARM template):

 {  
     "condition":"[equals(parameters('enableDiagnosticSettings'),'true')]",  
     "scope":"[format('Microsoft.Synapse/workspaces/{0}', variables('synapseWorkspaceName'))]",  
     "type":"Microsoft.Insights/diagnosticsettings",  
     "apiVersion":"2017-05-01-preview",  
     "name":"[concat('diag-', variables('synapseWorkspaceName'))]",  
     "dependsOn":[  
         "[resourceId('Microsoft.Synapse/workspaces', variables('synapseWorkspaceName'))]"  
     ],  
     "properties":{  
         "workspaceId":"[parameters('logAnalyticsWorkspaceId')]",  
         "copy":[  
             {  
                 "name":"logs",  
                 "count":"[length(parameters('synapseWsDiagLogs'))]",  
                 "input":{  
                     "category":"[parameters('synapseWsDiagLogs')[copyIndex('logs')]]",  
                     "enabled":true  
                 }  
             }  
         ]  
     }  
 }  

and here is the param definition for Logs:

 "synapseWsDiagLogs":{  
     "type":"array",  
     "defaultValue":[  
         "SynapseRbacOperations",  
         "GatewayApiRequests",  
         "BuiltinSqlReqsEnded",  
         "IntegrationPipelineRuns",  
         "IntegrationActivityRuns",  
         "IntegrationTriggerRuns"  
     ],  
     "metadata":{  
         "description":"List of log diagnostic events to capture from Synapse WS and send to log analytics"  
     }  
 },  

Answer 3

The template for Synapse would essentially be the same. Instead of microsoft.sql/servers/databases/providers/diagnosticSettings it would be Microsoft.Synapse/workspaces/providers/diagnosticSettings and you will need to replace the metric names for the ones you want to setup for Synapse.

There is more info on how this works generally is in the Azure Monitor docs: https://learn.microsoft.com/en-us/azure/azure-monitor/essentials/resource-manager-diagnostic-settings