Skip to content

Commit ece98cf

Browse files
authored
Add Warning about failures due to minAPIVersion
A common cause for customer's opening support cases is if they set minAPIVersion property of API Management to a very recent version, newer than what we tell az mon to use to connect to us when creating a diagnostic settings object. This results in a failure and the error message is not very descriptive. Az Mon team has indicated they can't change the error message reported back to users, hence the doc update is being submitted.
1 parent 0c713ea commit ece98cf

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

articles/api-management/api-management-howto-use-azure-monitor.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,6 +138,8 @@ To configure resource logs:
138138

139139
For more information, see [Create diagnostic settings to send platform logs and metrics to different destinations](../azure-monitor/essentials/diagnostic-settings.md).
140140

141+
> [!NOTE]
142+
> Adding diagnostic setting object may result in a failure if the [MinApiVersion property](https://learn.microsoft.com/en-us/dotnet/api/microsoft.azure.management.apimanagement.models.apiversionconstraint.minapiversion) of your API Management service is set to any API Version higher than 2019-12-01.
141143
## View diagnostic data in Azure Monitor
142144

143145
If you enable collection of GatewayLogs or metrics in a Log Analytics workspace, it can take a few minutes for data to appear in Azure Monitor. To view the data:
@@ -211,4 +213,4 @@ In this tutorial, you learned how to:
211213
Advance to the next tutorial:
212214

213215
> [!div class="nextstepaction"]
214-
> [Trace calls](api-management-howto-api-inspector.md)
216+
> [Trace calls](api-management-howto-api-inspector.md)

0 commit comments

Comments
 (0)