Share via


DataCollectionRule Class

Definition

Definition of what monitoring data to collect and where that data should be sent.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Monitor.DataCollection.Models.DataCollectionRuleTypeConverter))]
public class DataCollectionRule : Microsoft.Azure.PowerShell.Cmdlets.Monitor.DataCollection.Models.IDataCollectionRule
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Monitor.DataCollection.Models.DataCollectionRuleTypeConverter))>]
type DataCollectionRule = class
    interface IDataCollectionRule
    interface IJsonSerializable
Public Class DataCollectionRule
Implements IDataCollectionRule
Inheritance
DataCollectionRule
Attributes
Implements

Constructors

DataCollectionRule()

Creates an new DataCollectionRule instance.

Properties

DataCollectionEndpointId

The resource ID of the data collection endpoint that this rule can be used with.

DataFlow

The specification of data flows.

DataSourceDataImportEventHubConsumerGroup

Event Hub consumer group name

DataSourceDataImportEventHubName

A friendly name for the data source. This name should be unique across all data sources (regardless of type) within the data collection rule.

DataSourceDataImportEventHubStream

The stream to collect from EventHub

DataSourceExtension

The list of Azure VM extension data source configurations.

DataSourceIisLog

The list of IIS logs source configurations.

DataSourceLogFile

The list of Log files source configurations.

DataSourcePerformanceCounter

The list of performance counter data source configurations.

DataSourcePlatformTelemetry

The list of platform telemetry configurations

DataSourcePrometheusForwarder

The list of Prometheus forwarder data source configurations.

DataSourceSyslog

The list of Syslog data source configurations.

DataSourceWindowsEventLog

The list of Windows Event Log data source configurations.

DataSourceWindowsFirewallLog

The list of Windows Firewall logs source configurations.

Description

Description of the data collection rule.

DestinationAzureMonitorMetricName

A friendly name for the destination. This name should be unique across all destinations (regardless of type) within the data collection rule.

DestinationEventHub

List of Event Hubs destinations.

DestinationEventHubsDirect

List of Event Hubs Direct destinations.

DestinationLogAnalytic

List of Log Analytics destinations.

DestinationMonitoringAccount

List of monitoring account destinations.

DestinationStorageAccount

List of storage accounts destinations.

DestinationStorageBlobsDirect

List of Storage Blob Direct destinations. To be used only for sending data directly to store from the agent.

DestinationStorageTablesDirect

List of Storage Table Direct destinations.

ImmutableId

The immutable ID of this data collection rule. This property is READ-ONLY.

MetadataProvisionedBy

Azure offering managing this resource on-behalf-of customer.

MetadataProvisionedByResourceId

Resource Id of azure offering managing this resource on-behalf-of customer.

ProvisioningState

The resource provisioning state.

StreamDeclaration

Declaration of custom streams used in this rule.

Methods

DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of DataCollectionRule.

DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of DataCollectionRule.

FromJson(JsonNode)

Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.Monitor.DataCollection.Models.IDataCollectionRule.

FromJsonString(String)

Creates a new instance of DataCollectionRule, deserializing the content from a json string.

ToJson(JsonObject, SerializationMode)

Serializes this instance of DataCollectionRule into a JsonNode.

ToJsonString()

Serializes this instance to a json string.

ToString()

Applies to