Microsoft.AppPlatform Spring/monitoringSettings
- Latest
- 2024-05-01-preview
- 2024-01-01-preview
- 2023-12-01
- 2023-11-01-preview
- 2023-09-01-preview
- 2023-07-01-preview
- 2023-05-01-preview
- 2023-03-01-preview
- 2023-01-01-preview
- 2022-12-01
- 2022-11-01-preview
- 2022-09-01-preview
- 2022-05-01-preview
- 2022-04-01
- 2022-03-01-preview
- 2022-01-01-preview
- 2021-09-01-preview
- 2021-06-01-preview
- 2020-11-01-preview
- 2020-07-01
Bicep resource definition
The Spring/monitoringSettings resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
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@2024-05-01-preview' = {
parent: resourceSymbolicName
name: 'default'
properties: {
appInsightsAgentVersions: {}
appInsightsInstrumentationKey: 'string'
appInsightsSamplingRate: int
error: {
code: 'string'
message: 'string'
}
traceEnabled: bool
}
}
Property values
ApplicationInsightsAgentVersions
| Name | Description | Value |
|---|
Error
| Name | Description | Value |
|---|---|---|
| code | The code of error. | string |
| message | The message of error. | string |
Microsoft.AppPlatform/Spring/monitoringSettings
| Name | Description | Value |
|---|---|---|
| name | The resource name | 'default' (required) |
| 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 Constraints: Min value = 0 Max value = 100 |
| 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 |
Quickstart samples
The following quickstart samples deploy this resource type.
| Bicep File | Description |
|---|---|
| Deploy a simple Azure Spring Apps microservice application | This template deploys a simple Azure Spring Apps microservice application to run on Azure. |
ARM template resource definition
The Spring/monitoringSettings resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
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": "2024-05-01-preview",
"name": "string",
"properties": {
"appInsightsAgentVersions": {
},
"appInsightsInstrumentationKey": "string",
"appInsightsSamplingRate": "int",
"error": {
"code": "string",
"message": "string"
},
"traceEnabled": "bool"
}
}
Property values
ApplicationInsightsAgentVersions
| Name | Description | Value |
|---|
Error
| Name | Description | Value |
|---|---|---|
| code | The code of error. | string |
| message | The message of error. | string |
Microsoft.AppPlatform/Spring/monitoringSettings
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2024-05-01-preview' |
| name | The resource name | 'default' (required) |
| properties | Properties of the Monitoring Setting resource | MonitoringSettingProperties |
| type | The resource type | 'Microsoft.AppPlatform/Spring/monitoringSettings' |
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 Constraints: Min value = 0 Max value = 100 |
| 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 |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
Deploy a simple Azure Spring Apps microservice application |
This template deploys a simple Azure Spring Apps microservice application to run on Azure. |
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@2024-05-01-preview"
name = "string"
body = jsonencode({
properties = {
appInsightsAgentVersions = {
}
appInsightsInstrumentationKey = "string"
appInsightsSamplingRate = int
error = {
code = "string"
message = "string"
}
traceEnabled = bool
}
})
}
Property values
ApplicationInsightsAgentVersions
| Name | Description | Value |
|---|
Error
| Name | Description | Value |
|---|---|---|
| code | The code of error. | string |
| message | The message of error. | string |
Microsoft.AppPlatform/Spring/monitoringSettings
| Name | Description | Value |
|---|---|---|
| name | The resource name | 'default' (required) |
| 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 |
| type | The resource type | "Microsoft.AppPlatform/Spring/monitoringSettings@2024-05-01-preview" |
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 Constraints: Min value = 0 Max value = 100 |
| 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 |