Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. appplatform
  5. MonitoringSetting
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.appplatform.MonitoringSetting

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

Monitoring Setting resource

Uses Azure REST API version 2024-01-01-preview. In version 2.x of the Azure Native provider, it used API version 2023-05-01-preview.

Other available API versions: 2023-05-01-preview, 2023-07-01-preview, 2023-09-01-preview, 2023-11-01-preview, 2023-12-01, 2024-05-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native appplatform [ApiVersion]. See the version guide for details.

Example Usage

MonitoringSettings_UpdatePut

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var monitoringSetting = new AzureNative.AppPlatform.MonitoringSetting("monitoringSetting", new()
    {
        Properties = new AzureNative.AppPlatform.Inputs.MonitoringSettingPropertiesArgs
        {
            AppInsightsInstrumentationKey = "00000000-0000-0000-0000-000000000000",
            AppInsightsSamplingRate = 10,
            TraceEnabled = true,
        },
        ResourceGroupName = "myResourceGroup",
        ServiceName = "myservice",
    });

});
Copy
package main

import (
	appplatform "github.com/pulumi/pulumi-azure-native-sdk/appplatform/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := appplatform.NewMonitoringSetting(ctx, "monitoringSetting", &appplatform.MonitoringSettingArgs{
			Properties: &appplatform.MonitoringSettingPropertiesArgs{
				AppInsightsInstrumentationKey: pulumi.String("00000000-0000-0000-0000-000000000000"),
				AppInsightsSamplingRate:       pulumi.Float64(10),
				TraceEnabled:                  pulumi.Bool(true),
			},
			ResourceGroupName: pulumi.String("myResourceGroup"),
			ServiceName:       pulumi.String("myservice"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.appplatform.MonitoringSetting;
import com.pulumi.azurenative.appplatform.MonitoringSettingArgs;
import com.pulumi.azurenative.appplatform.inputs.MonitoringSettingPropertiesArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var monitoringSetting = new MonitoringSetting("monitoringSetting", MonitoringSettingArgs.builder()
            .properties(MonitoringSettingPropertiesArgs.builder()
                .appInsightsInstrumentationKey("00000000-0000-0000-0000-000000000000")
                .appInsightsSamplingRate(10.0)
                .traceEnabled(true)
                .build())
            .resourceGroupName("myResourceGroup")
            .serviceName("myservice")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const monitoringSetting = new azure_native.appplatform.MonitoringSetting("monitoringSetting", {
    properties: {
        appInsightsInstrumentationKey: "00000000-0000-0000-0000-000000000000",
        appInsightsSamplingRate: 10,
        traceEnabled: true,
    },
    resourceGroupName: "myResourceGroup",
    serviceName: "myservice",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

monitoring_setting = azure_native.appplatform.MonitoringSetting("monitoringSetting",
    properties={
        "app_insights_instrumentation_key": "00000000-0000-0000-0000-000000000000",
        "app_insights_sampling_rate": 10,
        "trace_enabled": True,
    },
    resource_group_name="myResourceGroup",
    service_name="myservice")
Copy
resources:
  monitoringSetting:
    type: azure-native:appplatform:MonitoringSetting
    properties:
      properties:
        appInsightsInstrumentationKey: 00000000-0000-0000-0000-000000000000
        appInsightsSamplingRate: 10
        traceEnabled: true
      resourceGroupName: myResourceGroup
      serviceName: myservice
Copy

Create MonitoringSetting Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new MonitoringSetting(name: string, args: MonitoringSettingArgs, opts?: CustomResourceOptions);
@overload
def MonitoringSetting(resource_name: str,
                      args: MonitoringSettingArgs,
                      opts: Optional[ResourceOptions] = None)

@overload
def MonitoringSetting(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      resource_group_name: Optional[str] = None,
                      service_name: Optional[str] = None,
                      properties: Optional[MonitoringSettingPropertiesArgs] = None)
func NewMonitoringSetting(ctx *Context, name string, args MonitoringSettingArgs, opts ...ResourceOption) (*MonitoringSetting, error)
public MonitoringSetting(string name, MonitoringSettingArgs args, CustomResourceOptions? opts = null)
public MonitoringSetting(String name, MonitoringSettingArgs args)
public MonitoringSetting(String name, MonitoringSettingArgs args, CustomResourceOptions options)

type: azure-native:appplatform:MonitoringSetting
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. MonitoringSettingArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. MonitoringSettingArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. MonitoringSettingArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. MonitoringSettingArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. MonitoringSettingArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var monitoringSettingResource = new AzureNative.AppPlatform.MonitoringSetting("monitoringSettingResource", new()
{
    ResourceGroupName = "string",
    ServiceName = "string",
    Properties = new AzureNative.AppPlatform.Inputs.MonitoringSettingPropertiesArgs
    {
        AppInsightsInstrumentationKey = "string",
        AppInsightsSamplingRate = 0,
        Error = new AzureNative.AppPlatform.Inputs.ErrorArgs
        {
            Code = "string",
            Message = "string",
        },
        TraceEnabled = false,
    },
});
Copy
example, err := appplatform.NewMonitoringSetting(ctx, "monitoringSettingResource", &appplatform.MonitoringSettingArgs{
	ResourceGroupName: pulumi.String("string"),
	ServiceName:       pulumi.String("string"),
	Properties: &appplatform.MonitoringSettingPropertiesArgs{
		AppInsightsInstrumentationKey: pulumi.String("string"),
		AppInsightsSamplingRate:       pulumi.Float64(0),
		Error: &appplatform.ErrorArgs{
			Code:    pulumi.String("string"),
			Message: pulumi.String("string"),
		},
		TraceEnabled: pulumi.Bool(false),
	},
})
Copy
var monitoringSettingResource = new MonitoringSetting("monitoringSettingResource", MonitoringSettingArgs.builder()
    .resourceGroupName("string")
    .serviceName("string")
    .properties(MonitoringSettingPropertiesArgs.builder()
        .appInsightsInstrumentationKey("string")
        .appInsightsSamplingRate(0)
        .error(ErrorArgs.builder()
            .code("string")
            .message("string")
            .build())
        .traceEnabled(false)
        .build())
    .build());
Copy
monitoring_setting_resource = azure_native.appplatform.MonitoringSetting("monitoringSettingResource",
    resource_group_name="string",
    service_name="string",
    properties={
        "app_insights_instrumentation_key": "string",
        "app_insights_sampling_rate": 0,
        "error": {
            "code": "string",
            "message": "string",
        },
        "trace_enabled": False,
    })
Copy
const monitoringSettingResource = new azure_native.appplatform.MonitoringSetting("monitoringSettingResource", {
    resourceGroupName: "string",
    serviceName: "string",
    properties: {
        appInsightsInstrumentationKey: "string",
        appInsightsSamplingRate: 0,
        error: {
            code: "string",
            message: "string",
        },
        traceEnabled: false,
    },
});
Copy
type: azure-native:appplatform:MonitoringSetting
properties:
    properties:
        appInsightsInstrumentationKey: string
        appInsightsSamplingRate: 0
        error:
            code: string
            message: string
        traceEnabled: false
    resourceGroupName: string
    serviceName: string
Copy

MonitoringSetting Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The MonitoringSetting resource accepts the following input properties:

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Service resource.
Properties Pulumi.AzureNative.AppPlatform.Inputs.MonitoringSettingProperties
Properties of the Monitoring Setting resource
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Service resource.
Properties MonitoringSettingPropertiesArgs
Properties of the Monitoring Setting resource
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Service resource.
properties MonitoringSettingProperties
Properties of the Monitoring Setting resource
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Service resource.
properties MonitoringSettingProperties
Properties of the Monitoring Setting resource
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
service_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Service resource.
properties MonitoringSettingPropertiesArgs
Properties of the Monitoring Setting resource
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Service resource.
properties Property Map
Properties of the Monitoring Setting resource

Outputs

All input properties are implicitly available as output properties. Additionally, the MonitoringSetting resource produces the following output properties:

AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource.
SystemData Pulumi.AzureNative.AppPlatform.Outputs.SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
Type string
The type of the resource.
AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource.
SystemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
Type string
The type of the resource.
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type String
The type of the resource.
azureApiVersion string
The Azure API version of the resource.
id string
The provider-assigned unique ID for this managed resource.
name string
The name of the resource.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type string
The type of the resource.
azure_api_version str
The Azure API version of the resource.
id str
The provider-assigned unique ID for this managed resource.
name str
The name of the resource.
system_data SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type str
The type of the resource.
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource.
systemData Property Map
Metadata pertaining to creation and last modification of the resource.
type String
The type of the resource.

Supporting Types

ApplicationInsightsAgentVersionsResponse
, ApplicationInsightsAgentVersionsResponseArgs

Java This property is required. string
Indicates the version of application insight java agent
Java This property is required. string
Indicates the version of application insight java agent
java This property is required. String
Indicates the version of application insight java agent
java This property is required. string
Indicates the version of application insight java agent
java This property is required. str
Indicates the version of application insight java agent
java This property is required. String
Indicates the version of application insight java agent

Error
, ErrorArgs

Code string
The code of error.
Message string
The message of error.
Code string
The code of error.
Message string
The message of error.
code String
The code of error.
message String
The message of error.
code string
The code of error.
message string
The message of error.
code str
The code of error.
message str
The message of error.
code String
The code of error.
message String
The message of error.

ErrorResponse
, ErrorResponseArgs

Code string
The code of error.
Message string
The message of error.
Code string
The code of error.
Message string
The message of error.
code String
The code of error.
message String
The message of error.
code string
The code of error.
message string
The message of error.
code str
The code of error.
message str
The message of error.
code String
The code of error.
message String
The message of error.

MonitoringSettingProperties
, MonitoringSettingPropertiesArgs

AppInsightsInstrumentationKey string
Target application insight instrumentation key, null or whitespace include empty will disable monitoringSettings
AppInsightsSamplingRate double
Indicates the sampling rate of application insight agent, should be in range [0.0, 100.0]
Error Pulumi.AzureNative.AppPlatform.Inputs.Error
Error when apply Monitoring Setting changes.
TraceEnabled bool
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
Target application insight instrumentation key, null or whitespace include empty will disable monitoringSettings
AppInsightsSamplingRate float64
Indicates the sampling rate of application insight agent, should be in range [0.0, 100.0]
Error Error
Error when apply Monitoring Setting changes.
TraceEnabled bool
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
Target application insight instrumentation key, null or whitespace include empty will disable monitoringSettings
appInsightsSamplingRate Double
Indicates the sampling rate of application insight agent, should be in range [0.0, 100.0]
error Error
Error when apply Monitoring Setting changes.
traceEnabled Boolean
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
Target application insight instrumentation key, null or whitespace include empty will disable monitoringSettings
appInsightsSamplingRate number
Indicates the sampling rate of application insight agent, should be in range [0.0, 100.0]
error Error
Error when apply Monitoring Setting changes.
traceEnabled boolean
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
app_insights_instrumentation_key str
Target application insight instrumentation key, null or whitespace include empty will disable monitoringSettings
app_insights_sampling_rate float
Indicates the sampling rate of application insight agent, should be in range [0.0, 100.0]
error Error
Error when apply Monitoring Setting changes.
trace_enabled bool
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
Target application insight instrumentation key, null or whitespace include empty will disable monitoringSettings
appInsightsSamplingRate Number
Indicates the sampling rate of application insight agent, should be in range [0.0, 100.0]
error Property Map
Error when apply Monitoring Setting changes.
traceEnabled Boolean
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

MonitoringSettingPropertiesResponse
, MonitoringSettingPropertiesResponseArgs

ProvisioningState This property is required. string
State of the Monitoring Setting.
AppInsightsAgentVersions Pulumi.AzureNative.AppPlatform.Inputs.ApplicationInsightsAgentVersionsResponse
Indicates the versions of application insight agent
AppInsightsInstrumentationKey string
Target application insight instrumentation key, null or whitespace include empty will disable monitoringSettings
AppInsightsSamplingRate double
Indicates the sampling rate of application insight agent, should be in range [0.0, 100.0]
Error Pulumi.AzureNative.AppPlatform.Inputs.ErrorResponse
Error when apply Monitoring Setting changes.
TraceEnabled bool
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
ProvisioningState This property is required. string
State of the Monitoring Setting.
AppInsightsAgentVersions ApplicationInsightsAgentVersionsResponse
Indicates the versions of application insight agent
AppInsightsInstrumentationKey string
Target application insight instrumentation key, null or whitespace include empty will disable monitoringSettings
AppInsightsSamplingRate float64
Indicates the sampling rate of application insight agent, should be in range [0.0, 100.0]
Error ErrorResponse
Error when apply Monitoring Setting changes.
TraceEnabled bool
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
provisioningState This property is required. String
State of the Monitoring Setting.
appInsightsAgentVersions ApplicationInsightsAgentVersionsResponse
Indicates the versions of application insight agent
appInsightsInstrumentationKey String
Target application insight instrumentation key, null or whitespace include empty will disable monitoringSettings
appInsightsSamplingRate Double
Indicates the sampling rate of application insight agent, should be in range [0.0, 100.0]
error ErrorResponse
Error when apply Monitoring Setting changes.
traceEnabled Boolean
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
provisioningState This property is required. string
State of the Monitoring Setting.
appInsightsAgentVersions ApplicationInsightsAgentVersionsResponse
Indicates the versions of application insight agent
appInsightsInstrumentationKey string
Target application insight instrumentation key, null or whitespace include empty will disable monitoringSettings
appInsightsSamplingRate number
Indicates the sampling rate of application insight agent, should be in range [0.0, 100.0]
error ErrorResponse
Error when apply Monitoring Setting changes.
traceEnabled boolean
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
provisioning_state This property is required. str
State of the Monitoring Setting.
app_insights_agent_versions ApplicationInsightsAgentVersionsResponse
Indicates the versions of application insight agent
app_insights_instrumentation_key str
Target application insight instrumentation key, null or whitespace include empty will disable monitoringSettings
app_insights_sampling_rate float
Indicates the sampling rate of application insight agent, should be in range [0.0, 100.0]
error ErrorResponse
Error when apply Monitoring Setting changes.
trace_enabled bool
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
provisioningState This property is required. String
State of the Monitoring Setting.
appInsightsAgentVersions Property Map
Indicates the versions of application insight agent
appInsightsInstrumentationKey String
Target application insight instrumentation key, null or whitespace include empty will disable monitoringSettings
appInsightsSamplingRate Number
Indicates the sampling rate of application insight agent, should be in range [0.0, 100.0]
error Property Map
Error when apply Monitoring Setting changes.
traceEnabled Boolean
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

SystemDataResponse
, SystemDataResponseArgs

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource modification (UTC).
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource modification (UTC).
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource modification (UTC).
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource modification (UTC).
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource modification (UTC).
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource modification (UTC).
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:appplatform:MonitoringSetting default /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/monitoringSettings/default
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native