Microsoft.AppPlatform Spring/monitoringSettings 2021-06-01-preview

Template format

To create a Microsoft.AppPlatform/Spring/monitoringSettings resource, add the following JSON to the resources section of your template.

  "name": "default",
  "type": "Microsoft.AppPlatform/Spring/monitoringSettings",
  "apiVersion": "2021-06-01-preview",
  "properties": {
    "error": {
      "code": "string",
      "message": "string"
    "traceEnabled": "boolean",
    "appInsightsInstrumentationKey": "string",
    "appInsightsSamplingRate": "number",
    "appInsightsAgentVersions": {}

Property values

The following tables describe the values you need to set in the schema.

Microsoft.AppPlatform/Spring/monitoringSettings object


In Bicep, type and apiVersion are specified in the first line of the resource declaration. Use the format <type>@<apiVersion>. Don't set those properties in the resource body.

Name Type Required Value
name string Yes default
type enum Yes For JSON -monitoringSettings

See Set name and type for child resources.
apiVersion enum Yes For JSON - 2021-06-01-preview
properties object Yes Properties of the Monitoring Setting resource - MonitoringSettingProperties object

MonitoringSettingProperties object

Name Type Required Value
error object No Error when apply Monitoring Setting changes. - Error object
traceEnabled boolean No Indicates whether enable the trace functionality, which will be deprecated since api version 2020-11-01-preview. Please leverage appInsightsInstrumentationKey to indicate if monitoringSettings enabled or not
appInsightsInstrumentationKey string No Target application insight instrumentation key, null or whitespace include empty will disable monitoringSettings
appInsightsSamplingRate number No Indicates the sampling rate of application insight agent, should be in range [0.0, 100.0]
appInsightsAgentVersions object No Indicates the versions of application insight agent

Error object

Name Type Required Value
code string No The code of error.
message string No The message of error.