Clarify that diagnostic settings retention only applies for Storage

The az monitor diagnostic-settings doc should clarify the retentionPolicy schema as it’s now only shown in an example, and most importantly it should call out that retention policies can only be used when targeting a Storage account. That example which now shows retention policy furthermore has a --event-hub-rule {eventHubRuleID} parameter which doesn’t make sense in this case as the diagnostics target is a Storage account, not Event Hub.

---

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

• ID: b9ae3afa-74ff-12e8-a32c-c01240bd37da
• Version Independent ID: 522b7e55-2510-8e51-021a-2fc134fabfbe
• Content: az monitor diagnostic-settings
• Content Source: latest/docs-ref-autogen/monitor/diagnostic-settings.yml
• Service: monitoring-and-diagnostics
• GitHub Login: @rloutlaw
• Microsoft Alias: routlaw

[kairu-ms]

Thanks @jelledruyts, we will fix it.

[jelledruyts]

Hi @kairu-ms, yes those commands include either --log or --metrics which contain diagnosticSettings but the schema isn’t mentioned, only examples. I’d say the following actions would be good:

• Under the Optional parameters header, the --logs and --metrics parameters should link to the schema definitions, respectively here and here.
• That API doc has the RetentionPolicy schema defined, but it should mention that retention only applies when the target is a storage account. Perhaps that doc is owned by a different team, but if that’s the case then I’m not sure how to approach them to ask for this clarification?
• Ideally, the CLI doc we’re talking about here would also note the fact that retention only applies when the target is a storage account to avoid customer confusion.
• The CLI doc should remove the --event-hub-rule {eventHubRuleID} parameter from the example as it doesn’t make sense.

Hope that helps!