Azure.ResourceManager.Monitor.Models Namespace

Classes

ActionGroupEnableContent

Describes a receiver that should be resubscribed.

ActionGroupPatch

An action group object for the body of patch operations.

ActivityLogAlertActionGroup

A pointer to an Azure Action Group.

ActivityLogAlertAnyOfOrLeafCondition

An Activity Log Alert rule condition that is met when all its member conditions are met. Each condition can be of one of the following types: Important: Each type has its unique subset of properties. Properties from different types CANNOT exist in one condition.

  • Leaf Condition - must contain 'field' and either 'equals' or 'containsAny'. Please note, 'anyOf' should not be set in a Leaf Condition.
  • AnyOf Condition - must contain only 'anyOf' (which is an array of Leaf Conditions). Please note, 'field', 'equals' and 'containsAny' should not be set in an AnyOf Condition.
ActivityLogAlertPatch

An Activity Log Alert rule object for the body of patch operations.

AlertRuleAction

The action that is performed when the alert rule becomes active, and when an alert condition is resolved. Please note AlertRuleAction is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include RuleEmailAction and RuleWebhookAction.

AlertRuleCondition

The condition that results in the alert rule being activated. Please note AlertRuleCondition is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include LocationThresholdRuleCondition, ManagementEventRuleCondition and ThresholdRuleCondition.

AlertRuleLeafCondition

An Activity Log Alert rule condition that is met by comparing the field and value of an Activity Log event. This condition must contain 'field' and either 'equals' or 'containsAny'.

AlertRulePatch

The alert rule object for patch operations.

ArmMonitorModelFactory

Model factory for models.

ArmResourceGetMonitorMetricBaselinesOptions

The ArmResourceGetMonitorMetricBaselinesOptions.

ArmResourceGetMonitorMetricsOptions

The ArmResourceGetMonitorMetricsOptions.

AutoscaleNotification

Autoscale notification.

AutoscaleProfile

Autoscale profile.

AutoscaleRule

A rule that provide the triggers and parameters for the scaling action.

AutoscaleRuleMetricDimension

Specifies an auto scale rule metric dimension.

AutoscaleSettingPatch

The autoscale setting object for patch operations.

AutoscaleSettingPredicativeResult

The response to a metrics query.

BatchProcessor

Batch processor.

ConditionFailingPeriods

The minimum number of violations required within the selected lookback time window required to raise an alert. Relevant only for rules of the kind LogAlert.

DataCollectionEndpointFailoverConfiguration

Failover configuration on this endpoint. This property is READ-ONLY.

DataCollectionEndpointMetadata

Metadata for the resource. This property is READ-ONLY.

DataCollectionRuleAssociationMetadata

Metadata about the resource.

DataCollectionRuleBcdrFailoverConfigurationSpec

The DataCollectionRuleBcdrFailoverConfigurationSpec.

DataCollectionRuleBcdrLocationSpec

The DataCollectionRuleBcdrLocationSpec.

DataCollectionRuleDataSources

The specification of data sources. This property is optional and can be omitted if the rule is meant to be used via direct calls to the provisioned endpoint.

DataCollectionRuleDestinations

The specification of destinations.

DataCollectionRuleEventHubDataSource

The DataCollectionRuleEventHubDataSource.

DataCollectionRuleEventHubDestination

The DataCollectionRuleEventHubDestination.

DataCollectionRuleEventHubDirectDestination

The DataCollectionRuleEventHubDirectDestination.

DataCollectionRuleMetadata

Metadata about the resource.

DataCollectionRulePrivateLinkScopedResourceInfo

The DataCollectionRulePrivateLinkScopedResourceInfo.

DataCollectionRuleRelatedResourceMetadata

Metadata about the resource.

DataCollectionRuleStorageBlobDestination

The DataCollectionRuleStorageBlobDestination.

DataCollectionRuleStorageTableDestination

The DataCollectionRuleStorageTableDestination.

DataColumnDefinition

Definition of custom data column.

DataContainer

Information about a container with data for a given resource.

DataContainerWorkspace

Information about a Log Analytics Workspace.

DataFlow

Definition of which streams are sent to which destinations.

DataImportSourcesEventHub

Definition of Event Hub configuration.

DataSourcesSpec

Specification of data sources that will be collected.

DataStreamDeclaration

Declaration of a custom stream.

DestinationsSpec

Specification of destinations that can be used in data flows.

DynamicMetricCriteria

Criterion for dynamic threshold.

DynamicThresholdFailingPeriods

The minimum number of violations required within the selected lookback time window required to raise an alert.

EmailNotification

Email notification of an autoscale event.

EventDataHttpRequestInfo

The Http request info.

EventDataInfo

The Azure event log entries are of type EventData.

ExtensionDataSource

Definition of which data will be collected from a separate VM extension that integrates with the Azure Monitor Agent. Collected from either Windows and Linux machines, depending on which extension is defined.

IisLogsDataSource

Enables IIS logs to be collected by this data collection rule.

LocationThresholdRuleCondition

A rule condition based on a certain number of locations failing.

LogAnalyticsDestination

Log Analytics destination.

LogFilesDataSource

Definition of which custom log files will be collected by this data collection rule.

LogProfilePatch

The log profile resource for patch operations.

LogSettings

Part of MultiTenantDiagnosticSettings. Specifies the settings for a particular log.

ManagementEventAggregationCondition

How the data that is collected should be combined over time.

ManagementEventRuleCondition

A management event rule condition.

MetricAlertAction

An alert action.

MetricAlertCriteria

The rule criteria that defines the conditions of the alert rule. Please note MetricAlertCriteria is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include MetricAlertMultipleResourceMultipleMetricCriteria, MetricAlertSingleResourceMultipleMetricCriteria and WebtestLocationAvailabilityCriteria.

MetricAlertMultipleResourceMultipleMetricCriteria

Specifies the metric alert criteria for multiple resource that has multiple metric criteria.

MetricAlertPatch

The metric alert resource for patch operations.

MetricAlertSingleResourceMultipleMetricCriteria

Specifies the metric alert criteria for a single resource that has multiple metric criteria.

MetricAlertStatus

An alert status.

MetricAlertStatusProperties

An alert status properties.

MetricCriteria

Criterion to filter metrics.

MetricDimension

Specifies a metric dimension.

MetricSettings

Part of MultiTenantDiagnosticSettings. Specifies the settings for a particular metric.

MetricTrigger

The trigger that results in a scaling action.

MonitorArmRoleReceiver

An arm role receiver.

MonitorAutomationRunbookReceiver

The Azure Automation Runbook notification receiver.

MonitorAzureAppPushReceiver

The Azure mobile App push notification receiver.

MonitorAzureFunctionReceiver

An azure function receiver.

MonitorBaselineMetadata

Represents a baseline metadata value.

MonitorDimension

Dimension splitting and filtering definition.

MonitorEmailReceiver

An email receiver.

MonitorEventHubReceiver

An Event hub receiver.

MonitorIncident

An alert incident indicates the activation status of an alert rule.

MonitoringAccountDestination

Monitoring account destination.

MonitorItsmReceiver

An Itsm receiver.

MonitorLocalizableString

The localizable string class.

MonitorLogicAppReceiver

A logic app receiver.

MonitorMetadataValue

Represents a metric metadata value.

MonitorMetric

The result data of a query.

MonitorMetricAvailability

Metric availability specifies the time grain (aggregation interval or frequency) and the retention period for that time grain.

MonitorMetricDefinition

Metric definition class specifies the metadata for a metric.

MonitorMetricNamespace

Metric namespace class specifies the metadata for a metric namespace.

MonitorMetricSingleDimension

The metric dimension name and value.

MonitorMetricValue

Represents a metric value.

MonitorPrivateLinkAccessModeSettings

Properties that define the scope private link mode settings.

MonitorPrivateLinkAccessModeSettingsExclusion

Properties that define the scope private link mode settings exclusion item. This setting applies to a specific private endpoint connection and overrides the default settings for that private endpoint connection.

MonitorPrivateLinkScopeOperationStatus

The status of operation.

MonitorPrivateLinkScopePatch

A container holding only the Tags for a resource, allowing the user to update the tags on a PrivateLinkScope instance.

MonitorPrivateLinkServiceConnectionState

A collection of information about the state of the connection between service consumer and provider.

MonitorRecurrence

The repeating times at which this profile begins. This element is not used if the FixedDate element is used.

MonitorScaleAction

The parameters for the scaling action.

MonitorScaleCapacity

The number of instances that can be used during this profile.

MonitorSingleBaseline

The baseline values for a single sensitivity value.

MonitorSingleMetricBaseline

The baseline results of a single metric.

MonitorSmsReceiver

An SMS receiver.

MonitorTimeSeriesBaseline

The baseline values for a single time series.

MonitorTimeSeriesElement

A time series result type. The discriminator value is always TimeSeries in this case.

MonitorTimeWindow

A specific date-time for the profile.

MonitorVoiceReceiver

A voice receiver.

MonitorWebhookReceiver

A webhook receiver.

MonitorWorkspaceDefaultIngestionSettings

The Data Collection Rule and Endpoint used for ingestion by default.

MonitorWorkspaceIngestionSettings

Settings for data ingestion.

MonitorWorkspaceLogsApiConfig

Azure Monitor Workspace Logs Api configurations.

MonitorWorkspaceLogsExporter

Azure Monitor Workspace Logs specific configurations.

MonitorWorkspaceLogsExporterCacheConfiguration

Cache configurations.

MonitorWorkspaceLogsExporterConcurrencyConfiguration

Concurrent publishing configuration.

MonitorWorkspaceLogsRecordMap

Record map for schema in azure monitor.

MonitorWorkspaceLogsResourceMap

Resource map for schema in azure monitor.

MonitorWorkspaceLogsSchemaMap

Schema map for azure monitor for logs.

MonitorWorkspaceLogsScopeMap

Scope map for schema in azure monitor.

MonitorWorkspaceMetricProperties

Information about metrics for the workspace.

MonitorWorkspaceMetrics

Properties related to the metrics container in the Azure Monitor Workspace.

MonitorWorkspacePrivateEndpointConnection

The private endpoint connection resource.

MonitorWorkspaceResourcePatch

The type used for update operations of the AzureMonitorWorkspace.

MultiMetricCriteria

The types of conditions for a multi resource alert. Please note MultiMetricCriteria is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include DynamicMetricCriteria and MetricCriteria.

NotificationActionDetail

The action detail.

NotificationContent

The request body which contain contact detail metadata.

NotificationContext

The context info.

NotificationStatus

The details of the test notification results.

PerfCounterDataSource

Definition of which performance counters will be collected and how they will be collected by this data collection rule. Collected from both Windows and Linux machines where the counter is present.

PipelineGroupExporter

Exporter Info.

PipelineGroupNetworkingConfiguration

Networking configuration for the pipeline group instance.

PipelineGroupNetworkingRoute

Networking route configuration.

PipelineGroupPatch

The type used for update operations of the PipelineGroup.

PipelineGroupProcessor

Processor Info.

PipelineGroupReceiver

Receiver Info.

PipelineGroupService

Service Info.

PipelineGroupServicePipeline

Pipeline Info.

PlatformTelemetryDataSource

Definition of platform telemetry data source configuration.

PredictiveAutoscalePolicy

The parameters for enabling predictive autoscale.

PredictiveValue

Represents a predictive metric value in the given bucket.

PrometheusForwarderDataSource

Definition of Prometheus metrics forwarding configuration.

RecurrentSchedule

The scheduling constraints for when the profile begins.

ResourceForUpdate

Definition of ARM tracked top level resource properties for update operation.

RetentionPolicy

Specifies the retention policy for the log.

RuleDataSource

The resource from which the rule collects its data. Please note RuleDataSource is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include RuleManagementEventDataSource and RuleMetricDataSource.

RuleEmailAction

Specifies the action to send email when the rule condition is evaluated. The discriminator is always RuleEmailAction in this case.

RuleManagementEventDataSource

A rule management event data source. The discriminator fields is always RuleManagementEventDataSource in this case.

RuleMetricDataSource

A rule metric data source. The discriminator value is always RuleMetricDataSource in this case.

RuleWebhookAction

Specifies the action to post to service when the rule condition is evaluated. The discriminator is always RuleWebhookAction in this case.

ScheduledQueryRuleActions

Actions to invoke when the alert fires.

ScheduledQueryRuleCondition

A condition of the scheduled query rule.

ScheduledQueryRulePatch

The scheduled query rule resource for patch operations.

SenderAuthorization

the authorization used by the user who has performed the operation that led to this event. This captures the RBAC properties of the event. These usually include the 'action', 'role' and the 'scope'.

SubscriptionMonitorMetric

The result data of a query.

SubscriptionResourceGetMonitorMetricsOptions

The SubscriptionResourceGetMonitorMetricsOptions.

SubscriptionResourceGetMonitorMetricsWithPostContent

Query parameters can also be specified in the body, specifying the same parameter in both the body and query parameters will result in an error.

SubscriptionResourceGetMonitorMetricsWithPostOptions

The SubscriptionResourceGetMonitorMetricsWithPostOptions.

SyslogDataSource

Definition of which syslog data will be collected and how it will be collected. Only collected from Linux machines.

SyslogReceiver

Base receiver using TCP as transport protocol.

ThresholdRuleCondition

A rule condition based on a metric crossing a threshold.

UdpReceiver

Receiver using UDP as transport protocol.

WebhookNotification

Webhook notification of an autoscale event.

WebtestLocationAvailabilityCriteria

Specifies the metric alert rule criteria for a web test resource.

WindowsEventLogDataSource

Definition of which Windows Event Log events will be collected and how they will be collected. Only collected from Windows machines.

WindowsFirewallLogsDataSource

Enables Firewall logs to be collected by this data collection rule.

Structs

AlertSeverity

Severity of the alert. Should be an integer between [0-4]. Value of 0 is severest. Relevant and required only for rules of the kind LogAlert.

DataCollectionEndpointProvisioningState

The resource provisioning state. This property is READ-ONLY.

DataCollectionEndpointResourceKind

The kind of the resource.

DataCollectionRuleAssociationProvisioningState

The resource provisioning state.

DataCollectionRuleBcdrLocationSpecProvisioningStatus

The resource provisioning state in this location.

DataCollectionRuleKnownPrometheusForwarderDataSourceStream

The DataCollectionRuleKnownPrometheusForwarderDataSourceStream.

DataCollectionRuleProvisioningState

The resource provisioning state.

DataCollectionRuleResourceKind

The kind of the resource.

DataColumnDefinitionType

The type of the column data.

DataFlowStream

The DataFlowStream.

DataStatus

The status of VM Insights data from the resource. When reported as present the data array will contain information about the data containers to which data for the specified resource is being routed.

DynamicThresholdOperator

The operator used to compare the metric value against the threshold.

DynamicThresholdSensitivity

The extent of deviation required to trigger an alert. This will affect how tight the threshold is to the metric series pattern.

ExtensionDataSourceStream

The ExtensionDataSourceStream.

LogFilesDataSourceFormat

The data format of the log files.

LogFileTextSettingsRecordStartTimestampFormat

One of the supported timestamp formats.

MetricCriteriaOperator

the criteria operator.

MetricCriteriaTimeAggregationType

the criteria time aggregation types.

MonitorBaselineSensitivity

the sensitivity of the baseline.

MonitorCategoryType

The type of the diagnostic settings category.

MonitorDayOfWeek

The MonitorDayOfWeek.

MonitorDimensionOperator

Operator for dimension values.

MonitorMetricClass

The class of the metric.

MonitorMetricResultType

Reduces the set of data collected. The syntax allowed depends on the operation. See the operation's description for details.

MonitorMetricUnit

The unit of the metric.

MonitorNamespaceClassification

Kind of namespace.

MonitorOperationType

the operation associated with the notification and its value must be "scale".

MonitorPrivateEndpointConnectionProvisioningState

The current provisioning state.

MonitorPrivateEndpointServiceConnectionStatus

The private endpoint connection status.

MonitorPrivateLinkAccessMode

Access mode types.

MonitorProvisioningState

The provisioning state of a resource.

MonitorPublicNetworkAccess

The configuration to set whether network access from public internet to the endpoints are allowed.

MonitorWorkspacePublicNetworkAccess

State of the public network access.

OnboardingStatus

The onboarding status for the resource. Note that, a higher level scope, e.g., resource group or subscription, is considered onboarded if at least one resource under it is onboarded.

PerfCounterDataSourceStream

The PerfCounterDataSourceStream.

PipelineGroupExporterType

The exporter type.

PipelineGroupExternalNetworkingMode

The mode of the external networking.

PipelineGroupProcessorType

The processor type.

PipelineGroupReceiverType

The receiver type.

PipelineGroupServicePipelineType

The pipeline type.

ScaleRuleMetricDimensionOperationType

the dimension operator. Only 'Equals' and 'NotEquals' are supported. 'Equals' being equal to any of the values. 'NotEquals' being not equal to all of the values.

ScheduledQueryRuleKind

Indicates the type of scheduled query rule. The default is LogAlert.

ScheduledQueryRuleTimeAggregationType

Aggregation type. Relevant and required only for rules of the kind LogAlert.

StreamEncodingType

The encoding of the stream being received.

SyslogDataSourceFacilityName

The SyslogDataSourceFacilityName.

SyslogDataSourceLogLevel

The SyslogDataSourceLogLevel.

SyslogDataSourceStream

The SyslogDataSourceStream.

SyslogProtocol

Protocol to parse syslog messages. Default rfc3164.

WindowsEventLogDataSourceStream

The WindowsEventLogDataSourceStream.

Enums

MetricStatisticType

the metric statistic type. How the metrics from multiple instances are combined.

MetricTriggerComparisonOperation

the operator that is used to compare the metric data and the threshold.

MetricTriggerTimeAggregationType

time aggregation type. How the data that is collected should be combined over time. The default value is Average.

MonitorAggregationType

the aggregation type of the metric.

MonitorConditionOperator

Operators allowed in the rule condition.

MonitorEventLevel

the event level.

MonitorReceiverStatus

Indicates the status of the receiver. Receivers that are not Enabled will not receive any communications.

MonitorResultType

The MonitorResultType.

MonitorScaleDirection

the scale direction. Whether the scaling action increases or decreases the number of instances.

MonitorScaleType

the type of action that should occur when the scale rule fires.

PredictiveAutoscalePolicyScaleMode

the predictive autoscale mode.

RecurrenceFrequency

the recurrence frequency. How often the schedule profile should take effect. This value must be Week, meaning each week will have the same set of profiles. For example, to set a daily schedule, set schedule to every day of the week. The frequency property specifies that the schedule is repeated weekly.

ThresholdRuleConditionTimeAggregationType

Aggregation operators allowed in a rule.