Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. appplatform
  5. getMonitoringSetting
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.0.1 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.appplatform.getMonitoringSetting

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.0.1 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azure-native

Get the Monitoring Setting and its properties.

Uses Azure REST API version 2024-01-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.

Using getMonitoringSetting

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getMonitoringSetting(args: GetMonitoringSettingArgs, opts?: InvokeOptions): Promise<GetMonitoringSettingResult>
function getMonitoringSettingOutput(args: GetMonitoringSettingOutputArgs, opts?: InvokeOptions): Output<GetMonitoringSettingResult>
Copy
def get_monitoring_setting(resource_group_name: Optional[str] = None,
                           service_name: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetMonitoringSettingResult
def get_monitoring_setting_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                           service_name: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetMonitoringSettingResult]
Copy
func LookupMonitoringSetting(ctx *Context, args *LookupMonitoringSettingArgs, opts ...InvokeOption) (*LookupMonitoringSettingResult, error)
func LookupMonitoringSettingOutput(ctx *Context, args *LookupMonitoringSettingOutputArgs, opts ...InvokeOption) LookupMonitoringSettingResultOutput
Copy

> Note: This function is named LookupMonitoringSetting in the Go SDK.

public static class GetMonitoringSetting 
{
    public static Task<GetMonitoringSettingResult> InvokeAsync(GetMonitoringSettingArgs args, InvokeOptions? opts = null)
    public static Output<GetMonitoringSettingResult> Invoke(GetMonitoringSettingInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetMonitoringSettingResult> getMonitoringSetting(GetMonitoringSettingArgs args, InvokeOptions options)
public static Output<GetMonitoringSettingResult> getMonitoringSetting(GetMonitoringSettingArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:appplatform:getMonitoringSetting
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

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.
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.
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.
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.
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.
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.

getMonitoringSetting Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Id string
Fully qualified resource Id for the resource.
Name string
The name of the resource.
Properties Pulumi.AzureNative.AppPlatform.Outputs.MonitoringSettingPropertiesResponse
Properties of the Monitoring Setting 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
Fully qualified resource Id for the resource.
Name string
The name of the resource.
Properties MonitoringSettingPropertiesResponse
Properties of the Monitoring Setting 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
Fully qualified resource Id for the resource.
name String
The name of the resource.
properties MonitoringSettingPropertiesResponse
Properties of the Monitoring Setting 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
Fully qualified resource Id for the resource.
name string
The name of the resource.
properties MonitoringSettingPropertiesResponse
Properties of the Monitoring Setting 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
Fully qualified resource Id for the resource.
name str
The name of the resource.
properties MonitoringSettingPropertiesResponse
Properties of the Monitoring Setting 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
Fully qualified resource Id for the resource.
name String
The name of the resource.
properties Property Map
Properties of the Monitoring Setting resource
systemData Property Map
Metadata pertaining to creation and last modification of the resource.
type String
The type of the resource.

Supporting Types

ApplicationInsightsAgentVersionsResponse

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

ErrorResponse

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.

MonitoringSettingPropertiesResponse

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

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.

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.0.1 published on Monday, Apr 7, 2025 by Pulumi
pulumi/pulumi-azure-native