[Deprecated]: Deploy Diagnostic Settings for Relay to Log Analytics workspace

Azure Landing Zones (ALZ) Policy definition

Alias

Namespace

ResourceType

Path

PathIsDefault

DefaultPath

Modifiable

Microsoft.Insights/diagnosticSettings/logs.enabled

microsoft.insights

diagnosticSettings

properties.logs[*].enabled

True

False

Microsoft.Insights/diagnosticSettings/metrics.enabled

microsoft.insights

diagnosticSettings

properties.metrics[*].enabled

True

False

Microsoft.Insights/diagnosticSettings/workspaceId

microsoft.insights

diagnosticSettings

properties.workspaceId

True

False

Rows: 1-1 / 1

Records:

Use the filters above each column to filter and limit table data. Advanced searches can be performed by using the following operators:
<, <=, >, >=, =, *, !, {, }, ||,&&, [empty], [nonempty], rgx:
Learn more

TableFilter v0.7.3

https://www.tablefilter.com/
©2015-2025 Max Guglielmi

Page of 1

Initiative DisplayName

Initiative Id

Initiative Category

State

[Deprecated]: Deploy Diagnostic Settings to Azure Services

Deploy-Diagnostics-LogAnalytics

Monitoring

Deprecated

Date/Time (UTC ymd) (i)

Change type

Change detail

2024-06-03 17:39:43

change

Version remains equal, new suffix: deprecated (1.1.0 > 1.1.0-deprecated)

2022-10-25 25:16:43

change

Minor (1.0.0 > 1.1.0)

{

policyType: "Custom",
mode: "Indexed",
displayName: "[Deprecated]: Deploy Diagnostic Settings for Relay to Log Analytics workspace",
description: "Deploys the diagnostic settings for Relay to stream to a Log Analytics workspace when any Relay which is missing this diagnostic settings is created or updated. This policy is superseded by built-in initiative https://www.azadvertizer.net/azpolicyinitiativesadvertizer/0884adba-2312-4468-abeb-5422caed1038.html.",
metadata: {5 items
- deprecated: true,
- version: "1.1.0-deprecated",
- category: "Monitoring",
- source: "https://github.com/Azure/Enterprise-Scale/",
- alzCloudEnvironments: [3 items
  - "AzureCloud",
  - "AzureChinaCloud",
  - "AzureUSGovernment"
  ]
},
parameters: {5 items
- logAnalytics: {2 items
  - type: "String",
  - metadata: {3 items
    - displayName: "Log Analytics workspace",
    - description: "Select Log Analytics workspace from dropdown list. If this workspace is outside of the scope of the assignment you must manually grant 'Log Analytics Contributor' permissions (or similar) to the policy assignment's principal ID.",
    - strongType: "omsWorkspace"
    }
  },
- effect: {4 items
  - type: "String",
  - defaultValue: "DeployIfNotExists",
  - allowedValues: [2 items
    - "DeployIfNotExists",
    - "Disabled"
    ],
  - metadata: {2 items
    - displayName: "Effect",
    - description: "Enable or disable the execution of the policy"
    }
  },
- profileName: {3 items
  - type: "String",
  - defaultValue: "setbypolicy",
  - metadata: {2 items
    - displayName: "Profile name",
    - description: "The diagnostic settings profile name"
    }
  },
- metricsEnabled: {4 items
  - type: "String",
  - defaultValue: "True",
  - allowedValues: [2 items
    - "True",
    - "False"
    ],
  - metadata: {2 items
    - displayName: "Enable metrics",
    - description: "Whether to enable metrics stream to the Log Analytics workspace - True or False"
    }
  },
- logsEnabled: {4 items
  - type: "String",
  - defaultValue: "True",
  - allowedValues: [2 items
    - "True",
    - "False"
    ],
  - metadata: {2 items
    - displayName: "Enable logs",
    - description: "Whether to enable logs stream to the Log Analytics workspace - True or False"
    }
  }
},
policyRule: {2 items
- if: {2 items
  - field: "type",
  - equals: "Microsoft.Relay/namespaces"
  },
- then: {2 items
  - effect: "[parameters('effect')]",
  - details: {5 items
    - type: "Microsoft.Insights/diagnosticSettings",
    - name: "[parameters('profileName')]",
    - existenceCondition: {1 item
      - allOf: [3 items
        {2 items
        field: "Microsoft.Insights/diagnosticSettings/logs.enabled",
        equals: "true"
        },
        {2 items
        field: "Microsoft.Insights/diagnosticSettings/metrics.enabled",
        equals: "true"
        },
        {2 items
        field: "Microsoft.Insights/diagnosticSettings/workspaceId",
        equals: "[parameters('logAnalytics')]"
        }
        ]
      },
    - roleDefinitionIds: [2 items
      - "/providers/microsoft.authorization/roleDefinitions/749f88d5-cbae-40b8-bcfc-e573ddc772fa" Monitoring Contributor ,
      - "/providers/microsoft.authorization/roleDefinitions/92aaf0da-9dab-42b6-94a3-d43ce8d16293" Log Analytics Contributor
      ],
    - deployment: {1 item
      - properties: {3 items
        mode: "Incremental",
        template: {6 items
        $schema: "http://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#",
        contentVersion: "1.0.0.0",
        parameters: {6 items
        resourceName: {1 item
        type: "String"
        },
        logAnalytics: {1 item
        type: "String"
        },
        location: {1 item
        type: "String"
        },
        profileName: {1 item
        type: "String"
        },
        metricsEnabled: {1 item
        type: "String"
        },
        logsEnabled: {1 item
        type: "String"
        }
        },
        variables: {},
        resources: [1 item
        {6 items
        type: "Microsoft.Relay/namespaces/providers/diagnosticSettings",
        apiVersion: "2017-05-01-preview",
        name: 🔍"[ concat( parameters('resourceName'), '/', 'Microsoft.Insights/', parameters('profileName') ) ]",
        location: "[parameters('location')]",
        dependsOn: [],
        properties: {3 items
        workspaceId: "[parameters('logAnalytics')]",
        metrics: [1 item
        {4 items
        category: "AllMetrics",
        enabled: "[parameters('metricsEnabled')]",
        retentionPolicy: {2 items
        days: 0,
        enabled: false
        },
        timeGrain: null
        }
        ],
        logs: [1 item
        {2 items
        category: "HybridConnectionsEvent",
        enabled: "[parameters('logsEnabled')]"
        }
        ]
        }
        }
        ],
        outputs: {}
        },
        parameters: {6 items
        logAnalytics: {1 item
        value: "[parameters('logAnalytics')]"
        },
        location: {1 item
        value: "[field('location')]"
        },
        resourceName: {1 item
        value: "[field('name')]"
        },
        profileName: {1 item
        value: "[parameters('profileName')]"
        },
        metricsEnabled: {1 item
        value: "[parameters('metricsEnabled')]"
        },
        logsEnabled: {1 item
        value: "[parameters('logsEnabled')]"
        }
        }
        }
      }
    }
  }
}

}