Microsoft.AppPlatform Spring/monitoringSettings

  • Article

Bicep resource definition

The Spring/monitoringSettings resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.AppPlatform/Spring/monitoringSettings resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.AppPlatform/Spring/monitoringSettings@2023-03-01-preview' = {
  name: 'default'
  parent: resourceSymbolicName
  properties: {
    appInsightsAgentVersions: {}
    appInsightsInstrumentationKey: 'string'
    appInsightsSamplingRate: int
    error: {
      code: 'string'
      message: 'string'
    }
    traceEnabled: bool
  }
}

Property values

Spring/monitoringSettings

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.		 'default'
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: Spring
properties Properties of the Monitoring Setting resource MonitoringSettingProperties

MonitoringSettingProperties

Name Description Value
appInsightsAgentVersions Indicates the versions of application insight agent ApplicationInsightsAgentVersions
appInsightsInstrumentationKey Target application insight instrumentation key, null or whitespace include empty will disable monitoringSettings string
appInsightsSamplingRate Indicates the sampling rate of application insight agent, should be in range [0.0, 100.0] int
error Error when apply Monitoring Setting changes. Error
traceEnabled 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 bool

ApplicationInsightsAgentVersions

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

Error

Name Description Value
code The code of error. string
message The message of error. string

ARM template resource definition

The Spring/monitoringSettings resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

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

{
  "type": "Microsoft.AppPlatform/Spring/monitoringSettings",
  "apiVersion": "2023-03-01-preview",
  "name": "default",
  "properties": {
    "appInsightsAgentVersions": {},
    "appInsightsInstrumentationKey": "string",
    "appInsightsSamplingRate": "int",
    "error": {
      "code": "string",
      "message": "string"
    },
    "traceEnabled": "bool"
  }
}

Property values

Spring/monitoringSettings

Name Description Value
type The resource type 'Microsoft.AppPlatform/Spring/monitoringSettings'
apiVersion The resource api version '2023-03-01-preview'
name The resource name

See how to set names and types for child resources in JSON ARM templates.		 'default'
properties Properties of the Monitoring Setting resource MonitoringSettingProperties

MonitoringSettingProperties

Name Description Value
appInsightsAgentVersions Indicates the versions of application insight agent ApplicationInsightsAgentVersions
appInsightsInstrumentationKey Target application insight instrumentation key, null or whitespace include empty will disable monitoringSettings string
appInsightsSamplingRate Indicates the sampling rate of application insight agent, should be in range [0.0, 100.0] int
error Error when apply Monitoring Setting changes. Error
traceEnabled 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 bool

ApplicationInsightsAgentVersions

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

Error

Name Description Value
code The code of error. string
message The message of error. string

Terraform (AzAPI provider) resource definition

The Spring/monitoringSettings resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.AppPlatform/Spring/monitoringSettings resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.AppPlatform/Spring/monitoringSettings@2023-03-01-preview"
  name = "default"
  parent_id = "string"
  body = jsonencode({
    properties = {
      appInsightsAgentVersions = {}
      appInsightsInstrumentationKey = "string"
      appInsightsSamplingRate = int
      error = {
        code = "string"
        message = "string"
      }
      traceEnabled = bool
    }
  })
}

Property values

Spring/monitoringSettings

Name Description Value
type The resource type "Microsoft.AppPlatform/Spring/monitoringSettings@2023-03-01-preview"
name The resource name "default"
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: Spring
properties Properties of the Monitoring Setting resource MonitoringSettingProperties

MonitoringSettingProperties

Name Description Value
appInsightsAgentVersions Indicates the versions of application insight agent ApplicationInsightsAgentVersions
appInsightsInstrumentationKey Target application insight instrumentation key, null or whitespace include empty will disable monitoringSettings string
appInsightsSamplingRate Indicates the sampling rate of application insight agent, should be in range [0.0, 100.0] int
error Error when apply Monitoring Setting changes. Error
traceEnabled 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 bool

ApplicationInsightsAgentVersions

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

Error

Name Description Value
code The code of error. string
message The message of error. string