We recommend using Azure Native.
azure.monitoring.DataCollectionRule
Explore with Pulumi AI
Manages a Data Collection Rule.
Create DataCollectionRule Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new DataCollectionRule(name: string, args: DataCollectionRuleArgs, opts?: CustomResourceOptions);
@overload
def DataCollectionRule(resource_name: str,
args: DataCollectionRuleArgs,
opts: Optional[ResourceOptions] = None)
@overload
def DataCollectionRule(resource_name: str,
opts: Optional[ResourceOptions] = None,
data_flows: Optional[Sequence[DataCollectionRuleDataFlowArgs]] = None,
destinations: Optional[DataCollectionRuleDestinationsArgs] = None,
resource_group_name: Optional[str] = None,
data_collection_endpoint_id: Optional[str] = None,
data_sources: Optional[DataCollectionRuleDataSourcesArgs] = None,
description: Optional[str] = None,
identity: Optional[DataCollectionRuleIdentityArgs] = None,
kind: Optional[str] = None,
location: Optional[str] = None,
name: Optional[str] = None,
stream_declarations: Optional[Sequence[DataCollectionRuleStreamDeclarationArgs]] = None,
tags: Optional[Mapping[str, str]] = None)
func NewDataCollectionRule(ctx *Context, name string, args DataCollectionRuleArgs, opts ...ResourceOption) (*DataCollectionRule, error)
public DataCollectionRule(string name, DataCollectionRuleArgs args, CustomResourceOptions? opts = null)
public DataCollectionRule(String name, DataCollectionRuleArgs args)
public DataCollectionRule(String name, DataCollectionRuleArgs args, CustomResourceOptions options)
type: azure:monitoring:DataCollectionRule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args DataCollectionRuleArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args DataCollectionRuleArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args DataCollectionRuleArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DataCollectionRuleArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DataCollectionRuleArgs
- 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 dataCollectionRuleResource = new Azure.Monitoring.DataCollectionRule("dataCollectionRuleResource", new()
{
DataFlows = new[]
{
new Azure.Monitoring.Inputs.DataCollectionRuleDataFlowArgs
{
Destinations = new[]
{
"string",
},
Streams = new[]
{
"string",
},
BuiltInTransform = "string",
OutputStream = "string",
TransformKql = "string",
},
},
Destinations = new Azure.Monitoring.Inputs.DataCollectionRuleDestinationsArgs
{
AzureMonitorMetrics = new Azure.Monitoring.Inputs.DataCollectionRuleDestinationsAzureMonitorMetricsArgs
{
Name = "string",
},
EventHub = new Azure.Monitoring.Inputs.DataCollectionRuleDestinationsEventHubArgs
{
EventHubId = "string",
Name = "string",
},
EventHubDirect = new Azure.Monitoring.Inputs.DataCollectionRuleDestinationsEventHubDirectArgs
{
EventHubId = "string",
Name = "string",
},
LogAnalytics = new[]
{
new Azure.Monitoring.Inputs.DataCollectionRuleDestinationsLogAnalyticArgs
{
Name = "string",
WorkspaceResourceId = "string",
},
},
MonitorAccounts = new[]
{
new Azure.Monitoring.Inputs.DataCollectionRuleDestinationsMonitorAccountArgs
{
MonitorAccountId = "string",
Name = "string",
},
},
StorageBlobDirects = new[]
{
new Azure.Monitoring.Inputs.DataCollectionRuleDestinationsStorageBlobDirectArgs
{
ContainerName = "string",
Name = "string",
StorageAccountId = "string",
},
},
StorageBlobs = new[]
{
new Azure.Monitoring.Inputs.DataCollectionRuleDestinationsStorageBlobArgs
{
ContainerName = "string",
Name = "string",
StorageAccountId = "string",
},
},
StorageTableDirects = new[]
{
new Azure.Monitoring.Inputs.DataCollectionRuleDestinationsStorageTableDirectArgs
{
Name = "string",
StorageAccountId = "string",
TableName = "string",
},
},
},
ResourceGroupName = "string",
DataCollectionEndpointId = "string",
DataSources = new Azure.Monitoring.Inputs.DataCollectionRuleDataSourcesArgs
{
DataImport = new Azure.Monitoring.Inputs.DataCollectionRuleDataSourcesDataImportArgs
{
EventHubDataSources = new[]
{
new Azure.Monitoring.Inputs.DataCollectionRuleDataSourcesDataImportEventHubDataSourceArgs
{
Name = "string",
Stream = "string",
ConsumerGroup = "string",
},
},
},
Extensions = new[]
{
new Azure.Monitoring.Inputs.DataCollectionRuleDataSourcesExtensionArgs
{
ExtensionName = "string",
Name = "string",
Streams = new[]
{
"string",
},
ExtensionJson = "string",
InputDataSources = new[]
{
"string",
},
},
},
IisLogs = new[]
{
new Azure.Monitoring.Inputs.DataCollectionRuleDataSourcesIisLogArgs
{
Name = "string",
Streams = new[]
{
"string",
},
LogDirectories = new[]
{
"string",
},
},
},
LogFiles = new[]
{
new Azure.Monitoring.Inputs.DataCollectionRuleDataSourcesLogFileArgs
{
FilePatterns = new[]
{
"string",
},
Format = "string",
Name = "string",
Streams = new[]
{
"string",
},
Settings = new Azure.Monitoring.Inputs.DataCollectionRuleDataSourcesLogFileSettingsArgs
{
Text = new Azure.Monitoring.Inputs.DataCollectionRuleDataSourcesLogFileSettingsTextArgs
{
RecordStartTimestampFormat = "string",
},
},
},
},
PerformanceCounters = new[]
{
new Azure.Monitoring.Inputs.DataCollectionRuleDataSourcesPerformanceCounterArgs
{
CounterSpecifiers = new[]
{
"string",
},
Name = "string",
SamplingFrequencyInSeconds = 0,
Streams = new[]
{
"string",
},
},
},
PlatformTelemetries = new[]
{
new Azure.Monitoring.Inputs.DataCollectionRuleDataSourcesPlatformTelemetryArgs
{
Name = "string",
Streams = new[]
{
"string",
},
},
},
PrometheusForwarders = new[]
{
new Azure.Monitoring.Inputs.DataCollectionRuleDataSourcesPrometheusForwarderArgs
{
Name = "string",
Streams = new[]
{
"string",
},
LabelIncludeFilters = new[]
{
new Azure.Monitoring.Inputs.DataCollectionRuleDataSourcesPrometheusForwarderLabelIncludeFilterArgs
{
Label = "string",
Value = "string",
},
},
},
},
Syslogs = new[]
{
new Azure.Monitoring.Inputs.DataCollectionRuleDataSourcesSyslogArgs
{
FacilityNames = new[]
{
"string",
},
LogLevels = new[]
{
"string",
},
Name = "string",
Streams = new[]
{
"string",
},
},
},
WindowsEventLogs = new[]
{
new Azure.Monitoring.Inputs.DataCollectionRuleDataSourcesWindowsEventLogArgs
{
Name = "string",
Streams = new[]
{
"string",
},
XPathQueries = new[]
{
"string",
},
},
},
WindowsFirewallLogs = new[]
{
new Azure.Monitoring.Inputs.DataCollectionRuleDataSourcesWindowsFirewallLogArgs
{
Name = "string",
Streams = new[]
{
"string",
},
},
},
},
Description = "string",
Identity = new Azure.Monitoring.Inputs.DataCollectionRuleIdentityArgs
{
Type = "string",
IdentityIds = new[]
{
"string",
},
PrincipalId = "string",
TenantId = "string",
},
Kind = "string",
Location = "string",
Name = "string",
StreamDeclarations = new[]
{
new Azure.Monitoring.Inputs.DataCollectionRuleStreamDeclarationArgs
{
Columns = new[]
{
new Azure.Monitoring.Inputs.DataCollectionRuleStreamDeclarationColumnArgs
{
Name = "string",
Type = "string",
},
},
StreamName = "string",
},
},
Tags =
{
{ "string", "string" },
},
});
example, err := monitoring.NewDataCollectionRule(ctx, "dataCollectionRuleResource", &monitoring.DataCollectionRuleArgs{
DataFlows: monitoring.DataCollectionRuleDataFlowArray{
&monitoring.DataCollectionRuleDataFlowArgs{
Destinations: pulumi.StringArray{
pulumi.String("string"),
},
Streams: pulumi.StringArray{
pulumi.String("string"),
},
BuiltInTransform: pulumi.String("string"),
OutputStream: pulumi.String("string"),
TransformKql: pulumi.String("string"),
},
},
Destinations: &monitoring.DataCollectionRuleDestinationsArgs{
AzureMonitorMetrics: &monitoring.DataCollectionRuleDestinationsAzureMonitorMetricsArgs{
Name: pulumi.String("string"),
},
EventHub: &monitoring.DataCollectionRuleDestinationsEventHubArgs{
EventHubId: pulumi.String("string"),
Name: pulumi.String("string"),
},
EventHubDirect: &monitoring.DataCollectionRuleDestinationsEventHubDirectArgs{
EventHubId: pulumi.String("string"),
Name: pulumi.String("string"),
},
LogAnalytics: monitoring.DataCollectionRuleDestinationsLogAnalyticArray{
&monitoring.DataCollectionRuleDestinationsLogAnalyticArgs{
Name: pulumi.String("string"),
WorkspaceResourceId: pulumi.String("string"),
},
},
MonitorAccounts: monitoring.DataCollectionRuleDestinationsMonitorAccountArray{
&monitoring.DataCollectionRuleDestinationsMonitorAccountArgs{
MonitorAccountId: pulumi.String("string"),
Name: pulumi.String("string"),
},
},
StorageBlobDirects: monitoring.DataCollectionRuleDestinationsStorageBlobDirectArray{
&monitoring.DataCollectionRuleDestinationsStorageBlobDirectArgs{
ContainerName: pulumi.String("string"),
Name: pulumi.String("string"),
StorageAccountId: pulumi.String("string"),
},
},
StorageBlobs: monitoring.DataCollectionRuleDestinationsStorageBlobArray{
&monitoring.DataCollectionRuleDestinationsStorageBlobArgs{
ContainerName: pulumi.String("string"),
Name: pulumi.String("string"),
StorageAccountId: pulumi.String("string"),
},
},
StorageTableDirects: monitoring.DataCollectionRuleDestinationsStorageTableDirectArray{
&monitoring.DataCollectionRuleDestinationsStorageTableDirectArgs{
Name: pulumi.String("string"),
StorageAccountId: pulumi.String("string"),
TableName: pulumi.String("string"),
},
},
},
ResourceGroupName: pulumi.String("string"),
DataCollectionEndpointId: pulumi.String("string"),
DataSources: &monitoring.DataCollectionRuleDataSourcesArgs{
DataImport: &monitoring.DataCollectionRuleDataSourcesDataImportArgs{
EventHubDataSources: monitoring.DataCollectionRuleDataSourcesDataImportEventHubDataSourceArray{
&monitoring.DataCollectionRuleDataSourcesDataImportEventHubDataSourceArgs{
Name: pulumi.String("string"),
Stream: pulumi.String("string"),
ConsumerGroup: pulumi.String("string"),
},
},
},
Extensions: monitoring.DataCollectionRuleDataSourcesExtensionArray{
&monitoring.DataCollectionRuleDataSourcesExtensionArgs{
ExtensionName: pulumi.String("string"),
Name: pulumi.String("string"),
Streams: pulumi.StringArray{
pulumi.String("string"),
},
ExtensionJson: pulumi.String("string"),
InputDataSources: pulumi.StringArray{
pulumi.String("string"),
},
},
},
IisLogs: monitoring.DataCollectionRuleDataSourcesIisLogArray{
&monitoring.DataCollectionRuleDataSourcesIisLogArgs{
Name: pulumi.String("string"),
Streams: pulumi.StringArray{
pulumi.String("string"),
},
LogDirectories: pulumi.StringArray{
pulumi.String("string"),
},
},
},
LogFiles: monitoring.DataCollectionRuleDataSourcesLogFileArray{
&monitoring.DataCollectionRuleDataSourcesLogFileArgs{
FilePatterns: pulumi.StringArray{
pulumi.String("string"),
},
Format: pulumi.String("string"),
Name: pulumi.String("string"),
Streams: pulumi.StringArray{
pulumi.String("string"),
},
Settings: &monitoring.DataCollectionRuleDataSourcesLogFileSettingsArgs{
Text: &monitoring.DataCollectionRuleDataSourcesLogFileSettingsTextArgs{
RecordStartTimestampFormat: pulumi.String("string"),
},
},
},
},
PerformanceCounters: monitoring.DataCollectionRuleDataSourcesPerformanceCounterArray{
&monitoring.DataCollectionRuleDataSourcesPerformanceCounterArgs{
CounterSpecifiers: pulumi.StringArray{
pulumi.String("string"),
},
Name: pulumi.String("string"),
SamplingFrequencyInSeconds: pulumi.Int(0),
Streams: pulumi.StringArray{
pulumi.String("string"),
},
},
},
PlatformTelemetries: monitoring.DataCollectionRuleDataSourcesPlatformTelemetryArray{
&monitoring.DataCollectionRuleDataSourcesPlatformTelemetryArgs{
Name: pulumi.String("string"),
Streams: pulumi.StringArray{
pulumi.String("string"),
},
},
},
PrometheusForwarders: monitoring.DataCollectionRuleDataSourcesPrometheusForwarderArray{
&monitoring.DataCollectionRuleDataSourcesPrometheusForwarderArgs{
Name: pulumi.String("string"),
Streams: pulumi.StringArray{
pulumi.String("string"),
},
LabelIncludeFilters: monitoring.DataCollectionRuleDataSourcesPrometheusForwarderLabelIncludeFilterArray{
&monitoring.DataCollectionRuleDataSourcesPrometheusForwarderLabelIncludeFilterArgs{
Label: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
},
},
Syslogs: monitoring.DataCollectionRuleDataSourcesSyslogArray{
&monitoring.DataCollectionRuleDataSourcesSyslogArgs{
FacilityNames: pulumi.StringArray{
pulumi.String("string"),
},
LogLevels: pulumi.StringArray{
pulumi.String("string"),
},
Name: pulumi.String("string"),
Streams: pulumi.StringArray{
pulumi.String("string"),
},
},
},
WindowsEventLogs: monitoring.DataCollectionRuleDataSourcesWindowsEventLogArray{
&monitoring.DataCollectionRuleDataSourcesWindowsEventLogArgs{
Name: pulumi.String("string"),
Streams: pulumi.StringArray{
pulumi.String("string"),
},
XPathQueries: pulumi.StringArray{
pulumi.String("string"),
},
},
},
WindowsFirewallLogs: monitoring.DataCollectionRuleDataSourcesWindowsFirewallLogArray{
&monitoring.DataCollectionRuleDataSourcesWindowsFirewallLogArgs{
Name: pulumi.String("string"),
Streams: pulumi.StringArray{
pulumi.String("string"),
},
},
},
},
Description: pulumi.String("string"),
Identity: &monitoring.DataCollectionRuleIdentityArgs{
Type: pulumi.String("string"),
IdentityIds: pulumi.StringArray{
pulumi.String("string"),
},
PrincipalId: pulumi.String("string"),
TenantId: pulumi.String("string"),
},
Kind: pulumi.String("string"),
Location: pulumi.String("string"),
Name: pulumi.String("string"),
StreamDeclarations: monitoring.DataCollectionRuleStreamDeclarationArray{
&monitoring.DataCollectionRuleStreamDeclarationArgs{
Columns: monitoring.DataCollectionRuleStreamDeclarationColumnArray{
&monitoring.DataCollectionRuleStreamDeclarationColumnArgs{
Name: pulumi.String("string"),
Type: pulumi.String("string"),
},
},
StreamName: pulumi.String("string"),
},
},
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var dataCollectionRuleResource = new DataCollectionRule("dataCollectionRuleResource", DataCollectionRuleArgs.builder()
.dataFlows(DataCollectionRuleDataFlowArgs.builder()
.destinations("string")
.streams("string")
.builtInTransform("string")
.outputStream("string")
.transformKql("string")
.build())
.destinations(DataCollectionRuleDestinationsArgs.builder()
.azureMonitorMetrics(DataCollectionRuleDestinationsAzureMonitorMetricsArgs.builder()
.name("string")
.build())
.eventHub(DataCollectionRuleDestinationsEventHubArgs.builder()
.eventHubId("string")
.name("string")
.build())
.eventHubDirect(DataCollectionRuleDestinationsEventHubDirectArgs.builder()
.eventHubId("string")
.name("string")
.build())
.logAnalytics(DataCollectionRuleDestinationsLogAnalyticArgs.builder()
.name("string")
.workspaceResourceId("string")
.build())
.monitorAccounts(DataCollectionRuleDestinationsMonitorAccountArgs.builder()
.monitorAccountId("string")
.name("string")
.build())
.storageBlobDirects(DataCollectionRuleDestinationsStorageBlobDirectArgs.builder()
.containerName("string")
.name("string")
.storageAccountId("string")
.build())
.storageBlobs(DataCollectionRuleDestinationsStorageBlobArgs.builder()
.containerName("string")
.name("string")
.storageAccountId("string")
.build())
.storageTableDirects(DataCollectionRuleDestinationsStorageTableDirectArgs.builder()
.name("string")
.storageAccountId("string")
.tableName("string")
.build())
.build())
.resourceGroupName("string")
.dataCollectionEndpointId("string")
.dataSources(DataCollectionRuleDataSourcesArgs.builder()
.dataImport(DataCollectionRuleDataSourcesDataImportArgs.builder()
.eventHubDataSources(DataCollectionRuleDataSourcesDataImportEventHubDataSourceArgs.builder()
.name("string")
.stream("string")
.consumerGroup("string")
.build())
.build())
.extensions(DataCollectionRuleDataSourcesExtensionArgs.builder()
.extensionName("string")
.name("string")
.streams("string")
.extensionJson("string")
.inputDataSources("string")
.build())
.iisLogs(DataCollectionRuleDataSourcesIisLogArgs.builder()
.name("string")
.streams("string")
.logDirectories("string")
.build())
.logFiles(DataCollectionRuleDataSourcesLogFileArgs.builder()
.filePatterns("string")
.format("string")
.name("string")
.streams("string")
.settings(DataCollectionRuleDataSourcesLogFileSettingsArgs.builder()
.text(DataCollectionRuleDataSourcesLogFileSettingsTextArgs.builder()
.recordStartTimestampFormat("string")
.build())
.build())
.build())
.performanceCounters(DataCollectionRuleDataSourcesPerformanceCounterArgs.builder()
.counterSpecifiers("string")
.name("string")
.samplingFrequencyInSeconds(0)
.streams("string")
.build())
.platformTelemetries(DataCollectionRuleDataSourcesPlatformTelemetryArgs.builder()
.name("string")
.streams("string")
.build())
.prometheusForwarders(DataCollectionRuleDataSourcesPrometheusForwarderArgs.builder()
.name("string")
.streams("string")
.labelIncludeFilters(DataCollectionRuleDataSourcesPrometheusForwarderLabelIncludeFilterArgs.builder()
.label("string")
.value("string")
.build())
.build())
.syslogs(DataCollectionRuleDataSourcesSyslogArgs.builder()
.facilityNames("string")
.logLevels("string")
.name("string")
.streams("string")
.build())
.windowsEventLogs(DataCollectionRuleDataSourcesWindowsEventLogArgs.builder()
.name("string")
.streams("string")
.xPathQueries("string")
.build())
.windowsFirewallLogs(DataCollectionRuleDataSourcesWindowsFirewallLogArgs.builder()
.name("string")
.streams("string")
.build())
.build())
.description("string")
.identity(DataCollectionRuleIdentityArgs.builder()
.type("string")
.identityIds("string")
.principalId("string")
.tenantId("string")
.build())
.kind("string")
.location("string")
.name("string")
.streamDeclarations(DataCollectionRuleStreamDeclarationArgs.builder()
.columns(DataCollectionRuleStreamDeclarationColumnArgs.builder()
.name("string")
.type("string")
.build())
.streamName("string")
.build())
.tags(Map.of("string", "string"))
.build());
data_collection_rule_resource = azure.monitoring.DataCollectionRule("dataCollectionRuleResource",
data_flows=[azure.monitoring.DataCollectionRuleDataFlowArgs(
destinations=["string"],
streams=["string"],
built_in_transform="string",
output_stream="string",
transform_kql="string",
)],
destinations=azure.monitoring.DataCollectionRuleDestinationsArgs(
azure_monitor_metrics=azure.monitoring.DataCollectionRuleDestinationsAzureMonitorMetricsArgs(
name="string",
),
event_hub=azure.monitoring.DataCollectionRuleDestinationsEventHubArgs(
event_hub_id="string",
name="string",
),
event_hub_direct=azure.monitoring.DataCollectionRuleDestinationsEventHubDirectArgs(
event_hub_id="string",
name="string",
),
log_analytics=[azure.monitoring.DataCollectionRuleDestinationsLogAnalyticArgs(
name="string",
workspace_resource_id="string",
)],
monitor_accounts=[azure.monitoring.DataCollectionRuleDestinationsMonitorAccountArgs(
monitor_account_id="string",
name="string",
)],
storage_blob_directs=[azure.monitoring.DataCollectionRuleDestinationsStorageBlobDirectArgs(
container_name="string",
name="string",
storage_account_id="string",
)],
storage_blobs=[azure.monitoring.DataCollectionRuleDestinationsStorageBlobArgs(
container_name="string",
name="string",
storage_account_id="string",
)],
storage_table_directs=[azure.monitoring.DataCollectionRuleDestinationsStorageTableDirectArgs(
name="string",
storage_account_id="string",
table_name="string",
)],
),
resource_group_name="string",
data_collection_endpoint_id="string",
data_sources=azure.monitoring.DataCollectionRuleDataSourcesArgs(
data_import=azure.monitoring.DataCollectionRuleDataSourcesDataImportArgs(
event_hub_data_sources=[azure.monitoring.DataCollectionRuleDataSourcesDataImportEventHubDataSourceArgs(
name="string",
stream="string",
consumer_group="string",
)],
),
extensions=[azure.monitoring.DataCollectionRuleDataSourcesExtensionArgs(
extension_name="string",
name="string",
streams=["string"],
extension_json="string",
input_data_sources=["string"],
)],
iis_logs=[azure.monitoring.DataCollectionRuleDataSourcesIisLogArgs(
name="string",
streams=["string"],
log_directories=["string"],
)],
log_files=[azure.monitoring.DataCollectionRuleDataSourcesLogFileArgs(
file_patterns=["string"],
format="string",
name="string",
streams=["string"],
settings=azure.monitoring.DataCollectionRuleDataSourcesLogFileSettingsArgs(
text=azure.monitoring.DataCollectionRuleDataSourcesLogFileSettingsTextArgs(
record_start_timestamp_format="string",
),
),
)],
performance_counters=[azure.monitoring.DataCollectionRuleDataSourcesPerformanceCounterArgs(
counter_specifiers=["string"],
name="string",
sampling_frequency_in_seconds=0,
streams=["string"],
)],
platform_telemetries=[azure.monitoring.DataCollectionRuleDataSourcesPlatformTelemetryArgs(
name="string",
streams=["string"],
)],
prometheus_forwarders=[azure.monitoring.DataCollectionRuleDataSourcesPrometheusForwarderArgs(
name="string",
streams=["string"],
label_include_filters=[azure.monitoring.DataCollectionRuleDataSourcesPrometheusForwarderLabelIncludeFilterArgs(
label="string",
value="string",
)],
)],
syslogs=[azure.monitoring.DataCollectionRuleDataSourcesSyslogArgs(
facility_names=["string"],
log_levels=["string"],
name="string",
streams=["string"],
)],
windows_event_logs=[azure.monitoring.DataCollectionRuleDataSourcesWindowsEventLogArgs(
name="string",
streams=["string"],
x_path_queries=["string"],
)],
windows_firewall_logs=[azure.monitoring.DataCollectionRuleDataSourcesWindowsFirewallLogArgs(
name="string",
streams=["string"],
)],
),
description="string",
identity=azure.monitoring.DataCollectionRuleIdentityArgs(
type="string",
identity_ids=["string"],
principal_id="string",
tenant_id="string",
),
kind="string",
location="string",
name="string",
stream_declarations=[azure.monitoring.DataCollectionRuleStreamDeclarationArgs(
columns=[azure.monitoring.DataCollectionRuleStreamDeclarationColumnArgs(
name="string",
type="string",
)],
stream_name="string",
)],
tags={
"string": "string",
})
const dataCollectionRuleResource = new azure.monitoring.DataCollectionRule("dataCollectionRuleResource", {
dataFlows: [{
destinations: ["string"],
streams: ["string"],
builtInTransform: "string",
outputStream: "string",
transformKql: "string",
}],
destinations: {
azureMonitorMetrics: {
name: "string",
},
eventHub: {
eventHubId: "string",
name: "string",
},
eventHubDirect: {
eventHubId: "string",
name: "string",
},
logAnalytics: [{
name: "string",
workspaceResourceId: "string",
}],
monitorAccounts: [{
monitorAccountId: "string",
name: "string",
}],
storageBlobDirects: [{
containerName: "string",
name: "string",
storageAccountId: "string",
}],
storageBlobs: [{
containerName: "string",
name: "string",
storageAccountId: "string",
}],
storageTableDirects: [{
name: "string",
storageAccountId: "string",
tableName: "string",
}],
},
resourceGroupName: "string",
dataCollectionEndpointId: "string",
dataSources: {
dataImport: {
eventHubDataSources: [{
name: "string",
stream: "string",
consumerGroup: "string",
}],
},
extensions: [{
extensionName: "string",
name: "string",
streams: ["string"],
extensionJson: "string",
inputDataSources: ["string"],
}],
iisLogs: [{
name: "string",
streams: ["string"],
logDirectories: ["string"],
}],
logFiles: [{
filePatterns: ["string"],
format: "string",
name: "string",
streams: ["string"],
settings: {
text: {
recordStartTimestampFormat: "string",
},
},
}],
performanceCounters: [{
counterSpecifiers: ["string"],
name: "string",
samplingFrequencyInSeconds: 0,
streams: ["string"],
}],
platformTelemetries: [{
name: "string",
streams: ["string"],
}],
prometheusForwarders: [{
name: "string",
streams: ["string"],
labelIncludeFilters: [{
label: "string",
value: "string",
}],
}],
syslogs: [{
facilityNames: ["string"],
logLevels: ["string"],
name: "string",
streams: ["string"],
}],
windowsEventLogs: [{
name: "string",
streams: ["string"],
xPathQueries: ["string"],
}],
windowsFirewallLogs: [{
name: "string",
streams: ["string"],
}],
},
description: "string",
identity: {
type: "string",
identityIds: ["string"],
principalId: "string",
tenantId: "string",
},
kind: "string",
location: "string",
name: "string",
streamDeclarations: [{
columns: [{
name: "string",
type: "string",
}],
streamName: "string",
}],
tags: {
string: "string",
},
});
type: azure:monitoring:DataCollectionRule
properties:
dataCollectionEndpointId: string
dataFlows:
- builtInTransform: string
destinations:
- string
outputStream: string
streams:
- string
transformKql: string
dataSources:
dataImport:
eventHubDataSources:
- consumerGroup: string
name: string
stream: string
extensions:
- extensionJson: string
extensionName: string
inputDataSources:
- string
name: string
streams:
- string
iisLogs:
- logDirectories:
- string
name: string
streams:
- string
logFiles:
- filePatterns:
- string
format: string
name: string
settings:
text:
recordStartTimestampFormat: string
streams:
- string
performanceCounters:
- counterSpecifiers:
- string
name: string
samplingFrequencyInSeconds: 0
streams:
- string
platformTelemetries:
- name: string
streams:
- string
prometheusForwarders:
- labelIncludeFilters:
- label: string
value: string
name: string
streams:
- string
syslogs:
- facilityNames:
- string
logLevels:
- string
name: string
streams:
- string
windowsEventLogs:
- name: string
streams:
- string
xPathQueries:
- string
windowsFirewallLogs:
- name: string
streams:
- string
description: string
destinations:
azureMonitorMetrics:
name: string
eventHub:
eventHubId: string
name: string
eventHubDirect:
eventHubId: string
name: string
logAnalytics:
- name: string
workspaceResourceId: string
monitorAccounts:
- monitorAccountId: string
name: string
storageBlobDirects:
- containerName: string
name: string
storageAccountId: string
storageBlobs:
- containerName: string
name: string
storageAccountId: string
storageTableDirects:
- name: string
storageAccountId: string
tableName: string
identity:
identityIds:
- string
principalId: string
tenantId: string
type: string
kind: string
location: string
name: string
resourceGroupName: string
streamDeclarations:
- columns:
- name: string
type: string
streamName: string
tags:
string: string
DataCollectionRule Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The DataCollectionRule resource accepts the following input properties:
- Data
Flows List<DataCollection Rule Data Flow> - One or more
data_flow
blocks as defined below. - Destinations
Data
Collection Rule Destinations - A
destinations
block as defined below. - Resource
Group stringName - The name of the Resource Group where the Data Collection Rule should exist. Changing this forces a new Data Collection Rule to be created.
- Data
Collection stringEndpoint Id - The resource ID of the Data Collection Endpoint that this rule can be used with.
- Data
Sources DataCollection Rule Data Sources - A
data_sources
block as defined below. This property is optional and can be omitted if the rule is meant to be used via direct calls to the provisioned endpoint. - Description string
- The description of the Data Collection Rule.
- Identity
Data
Collection Rule Identity - An
identity
block as defined below. - Kind string
The kind of the Data Collection Rule. Possible values are
Linux
,Windows
,AgentDirectToStore
andWorkspaceTransforms
. A rule of kindLinux
does not allow forwindows_event_log
data sources. And a rule of kindWindows
does not allow forsyslog
data sources. If kind is not specified, all kinds of data sources are allowed.NOTE Once
kind
has been set, changing it forces a new Data Collection Rule to be created.- Location string
- The Azure Region where the Data Collection Rule should exist. Changing this forces a new Data Collection Rule to be created.
- Name string
- The name which should be used for this Data Collection Rule. Changing this forces a new Data Collection Rule to be created.
- Stream
Declarations List<DataCollection Rule Stream Declaration> - A
stream_declaration
block as defined below. - Dictionary<string, string>
- A mapping of tags which should be assigned to the Data Collection Rule.
- Data
Flows []DataCollection Rule Data Flow Args - One or more
data_flow
blocks as defined below. - Destinations
Data
Collection Rule Destinations Args - A
destinations
block as defined below. - Resource
Group stringName - The name of the Resource Group where the Data Collection Rule should exist. Changing this forces a new Data Collection Rule to be created.
- Data
Collection stringEndpoint Id - The resource ID of the Data Collection Endpoint that this rule can be used with.
- Data
Sources DataCollection Rule Data Sources Args - A
data_sources
block as defined below. This property is optional and can be omitted if the rule is meant to be used via direct calls to the provisioned endpoint. - Description string
- The description of the Data Collection Rule.
- Identity
Data
Collection Rule Identity Args - An
identity
block as defined below. - Kind string
The kind of the Data Collection Rule. Possible values are
Linux
,Windows
,AgentDirectToStore
andWorkspaceTransforms
. A rule of kindLinux
does not allow forwindows_event_log
data sources. And a rule of kindWindows
does not allow forsyslog
data sources. If kind is not specified, all kinds of data sources are allowed.NOTE Once
kind
has been set, changing it forces a new Data Collection Rule to be created.- Location string
- The Azure Region where the Data Collection Rule should exist. Changing this forces a new Data Collection Rule to be created.
- Name string
- The name which should be used for this Data Collection Rule. Changing this forces a new Data Collection Rule to be created.
- Stream
Declarations []DataCollection Rule Stream Declaration Args - A
stream_declaration
block as defined below. - map[string]string
- A mapping of tags which should be assigned to the Data Collection Rule.
- data
Flows List<DataCollection Rule Data Flow> - One or more
data_flow
blocks as defined below. - destinations
Data
Collection Rule Destinations - A
destinations
block as defined below. - resource
Group StringName - The name of the Resource Group where the Data Collection Rule should exist. Changing this forces a new Data Collection Rule to be created.
- data
Collection StringEndpoint Id - The resource ID of the Data Collection Endpoint that this rule can be used with.
- data
Sources DataCollection Rule Data Sources - A
data_sources
block as defined below. This property is optional and can be omitted if the rule is meant to be used via direct calls to the provisioned endpoint. - description String
- The description of the Data Collection Rule.
- identity
Data
Collection Rule Identity - An
identity
block as defined below. - kind String
The kind of the Data Collection Rule. Possible values are
Linux
,Windows
,AgentDirectToStore
andWorkspaceTransforms
. A rule of kindLinux
does not allow forwindows_event_log
data sources. And a rule of kindWindows
does not allow forsyslog
data sources. If kind is not specified, all kinds of data sources are allowed.NOTE Once
kind
has been set, changing it forces a new Data Collection Rule to be created.- location String
- The Azure Region where the Data Collection Rule should exist. Changing this forces a new Data Collection Rule to be created.
- name String
- The name which should be used for this Data Collection Rule. Changing this forces a new Data Collection Rule to be created.
- stream
Declarations List<DataCollection Rule Stream Declaration> - A
stream_declaration
block as defined below. - Map<String,String>
- A mapping of tags which should be assigned to the Data Collection Rule.
- data
Flows DataCollection Rule Data Flow[] - One or more
data_flow
blocks as defined below. - destinations
Data
Collection Rule Destinations - A
destinations
block as defined below. - resource
Group stringName - The name of the Resource Group where the Data Collection Rule should exist. Changing this forces a new Data Collection Rule to be created.
- data
Collection stringEndpoint Id - The resource ID of the Data Collection Endpoint that this rule can be used with.
- data
Sources DataCollection Rule Data Sources - A
data_sources
block as defined below. This property is optional and can be omitted if the rule is meant to be used via direct calls to the provisioned endpoint. - description string
- The description of the Data Collection Rule.
- identity
Data
Collection Rule Identity - An
identity
block as defined below. - kind string
The kind of the Data Collection Rule. Possible values are
Linux
,Windows
,AgentDirectToStore
andWorkspaceTransforms
. A rule of kindLinux
does not allow forwindows_event_log
data sources. And a rule of kindWindows
does not allow forsyslog
data sources. If kind is not specified, all kinds of data sources are allowed.NOTE Once
kind
has been set, changing it forces a new Data Collection Rule to be created.- location string
- The Azure Region where the Data Collection Rule should exist. Changing this forces a new Data Collection Rule to be created.
- name string
- The name which should be used for this Data Collection Rule. Changing this forces a new Data Collection Rule to be created.
- stream
Declarations DataCollection Rule Stream Declaration[] - A
stream_declaration
block as defined below. - {[key: string]: string}
- A mapping of tags which should be assigned to the Data Collection Rule.
- data_
flows Sequence[DataCollection Rule Data Flow Args] - One or more
data_flow
blocks as defined below. - destinations
Data
Collection Rule Destinations Args - A
destinations
block as defined below. - resource_
group_ strname - The name of the Resource Group where the Data Collection Rule should exist. Changing this forces a new Data Collection Rule to be created.
- data_
collection_ strendpoint_ id - The resource ID of the Data Collection Endpoint that this rule can be used with.
- data_
sources DataCollection Rule Data Sources Args - A
data_sources
block as defined below. This property is optional and can be omitted if the rule is meant to be used via direct calls to the provisioned endpoint. - description str
- The description of the Data Collection Rule.
- identity
Data
Collection Rule Identity Args - An
identity
block as defined below. - kind str
The kind of the Data Collection Rule. Possible values are
Linux
,Windows
,AgentDirectToStore
andWorkspaceTransforms
. A rule of kindLinux
does not allow forwindows_event_log
data sources. And a rule of kindWindows
does not allow forsyslog
data sources. If kind is not specified, all kinds of data sources are allowed.NOTE Once
kind
has been set, changing it forces a new Data Collection Rule to be created.- location str
- The Azure Region where the Data Collection Rule should exist. Changing this forces a new Data Collection Rule to be created.
- name str
- The name which should be used for this Data Collection Rule. Changing this forces a new Data Collection Rule to be created.
- stream_
declarations Sequence[DataCollection Rule Stream Declaration Args] - A
stream_declaration
block as defined below. - Mapping[str, str]
- A mapping of tags which should be assigned to the Data Collection Rule.
- data
Flows List<Property Map> - One or more
data_flow
blocks as defined below. - destinations Property Map
- A
destinations
block as defined below. - resource
Group StringName - The name of the Resource Group where the Data Collection Rule should exist. Changing this forces a new Data Collection Rule to be created.
- data
Collection StringEndpoint Id - The resource ID of the Data Collection Endpoint that this rule can be used with.
- data
Sources Property Map - A
data_sources
block as defined below. This property is optional and can be omitted if the rule is meant to be used via direct calls to the provisioned endpoint. - description String
- The description of the Data Collection Rule.
- identity Property Map
- An
identity
block as defined below. - kind String
The kind of the Data Collection Rule. Possible values are
Linux
,Windows
,AgentDirectToStore
andWorkspaceTransforms
. A rule of kindLinux
does not allow forwindows_event_log
data sources. And a rule of kindWindows
does not allow forsyslog
data sources. If kind is not specified, all kinds of data sources are allowed.NOTE Once
kind
has been set, changing it forces a new Data Collection Rule to be created.- location String
- The Azure Region where the Data Collection Rule should exist. Changing this forces a new Data Collection Rule to be created.
- name String
- The name which should be used for this Data Collection Rule. Changing this forces a new Data Collection Rule to be created.
- stream
Declarations List<Property Map> - A
stream_declaration
block as defined below. - Map<String>
- A mapping of tags which should be assigned to the Data Collection Rule.
Outputs
All input properties are implicitly available as output properties. Additionally, the DataCollectionRule resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Immutable
Id string - The immutable ID of the Data Collection Rule.
- Id string
- The provider-assigned unique ID for this managed resource.
- Immutable
Id string - The immutable ID of the Data Collection Rule.
- id String
- The provider-assigned unique ID for this managed resource.
- immutable
Id String - The immutable ID of the Data Collection Rule.
- id string
- The provider-assigned unique ID for this managed resource.
- immutable
Id string - The immutable ID of the Data Collection Rule.
- id str
- The provider-assigned unique ID for this managed resource.
- immutable_
id str - The immutable ID of the Data Collection Rule.
- id String
- The provider-assigned unique ID for this managed resource.
- immutable
Id String - The immutable ID of the Data Collection Rule.
Look up Existing DataCollectionRule Resource
Get an existing DataCollectionRule resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: DataCollectionRuleState, opts?: CustomResourceOptions): DataCollectionRule
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
data_collection_endpoint_id: Optional[str] = None,
data_flows: Optional[Sequence[DataCollectionRuleDataFlowArgs]] = None,
data_sources: Optional[DataCollectionRuleDataSourcesArgs] = None,
description: Optional[str] = None,
destinations: Optional[DataCollectionRuleDestinationsArgs] = None,
identity: Optional[DataCollectionRuleIdentityArgs] = None,
immutable_id: Optional[str] = None,
kind: Optional[str] = None,
location: Optional[str] = None,
name: Optional[str] = None,
resource_group_name: Optional[str] = None,
stream_declarations: Optional[Sequence[DataCollectionRuleStreamDeclarationArgs]] = None,
tags: Optional[Mapping[str, str]] = None) -> DataCollectionRule
func GetDataCollectionRule(ctx *Context, name string, id IDInput, state *DataCollectionRuleState, opts ...ResourceOption) (*DataCollectionRule, error)
public static DataCollectionRule Get(string name, Input<string> id, DataCollectionRuleState? state, CustomResourceOptions? opts = null)
public static DataCollectionRule get(String name, Output<String> id, DataCollectionRuleState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Data
Collection stringEndpoint Id - The resource ID of the Data Collection Endpoint that this rule can be used with.
- Data
Flows List<DataCollection Rule Data Flow> - One or more
data_flow
blocks as defined below. - Data
Sources DataCollection Rule Data Sources - A
data_sources
block as defined below. This property is optional and can be omitted if the rule is meant to be used via direct calls to the provisioned endpoint. - Description string
- The description of the Data Collection Rule.
- Destinations
Data
Collection Rule Destinations - A
destinations
block as defined below. - Identity
Data
Collection Rule Identity - An
identity
block as defined below. - Immutable
Id string - The immutable ID of the Data Collection Rule.
- Kind string
The kind of the Data Collection Rule. Possible values are
Linux
,Windows
,AgentDirectToStore
andWorkspaceTransforms
. A rule of kindLinux
does not allow forwindows_event_log
data sources. And a rule of kindWindows
does not allow forsyslog
data sources. If kind is not specified, all kinds of data sources are allowed.NOTE Once
kind
has been set, changing it forces a new Data Collection Rule to be created.- Location string
- The Azure Region where the Data Collection Rule should exist. Changing this forces a new Data Collection Rule to be created.
- Name string
- The name which should be used for this Data Collection Rule. Changing this forces a new Data Collection Rule to be created.
- Resource
Group stringName - The name of the Resource Group where the Data Collection Rule should exist. Changing this forces a new Data Collection Rule to be created.
- Stream
Declarations List<DataCollection Rule Stream Declaration> - A
stream_declaration
block as defined below. - Dictionary<string, string>
- A mapping of tags which should be assigned to the Data Collection Rule.
- Data
Collection stringEndpoint Id - The resource ID of the Data Collection Endpoint that this rule can be used with.
- Data
Flows []DataCollection Rule Data Flow Args - One or more
data_flow
blocks as defined below. - Data
Sources DataCollection Rule Data Sources Args - A
data_sources
block as defined below. This property is optional and can be omitted if the rule is meant to be used via direct calls to the provisioned endpoint. - Description string
- The description of the Data Collection Rule.
- Destinations
Data
Collection Rule Destinations Args - A
destinations
block as defined below. - Identity
Data
Collection Rule Identity Args - An
identity
block as defined below. - Immutable
Id string - The immutable ID of the Data Collection Rule.
- Kind string
The kind of the Data Collection Rule. Possible values are
Linux
,Windows
,AgentDirectToStore
andWorkspaceTransforms
. A rule of kindLinux
does not allow forwindows_event_log
data sources. And a rule of kindWindows
does not allow forsyslog
data sources. If kind is not specified, all kinds of data sources are allowed.NOTE Once
kind
has been set, changing it forces a new Data Collection Rule to be created.- Location string
- The Azure Region where the Data Collection Rule should exist. Changing this forces a new Data Collection Rule to be created.
- Name string
- The name which should be used for this Data Collection Rule. Changing this forces a new Data Collection Rule to be created.
- Resource
Group stringName - The name of the Resource Group where the Data Collection Rule should exist. Changing this forces a new Data Collection Rule to be created.
- Stream
Declarations []DataCollection Rule Stream Declaration Args - A
stream_declaration
block as defined below. - map[string]string
- A mapping of tags which should be assigned to the Data Collection Rule.
- data
Collection StringEndpoint Id - The resource ID of the Data Collection Endpoint that this rule can be used with.
- data
Flows List<DataCollection Rule Data Flow> - One or more
data_flow
blocks as defined below. - data
Sources DataCollection Rule Data Sources - A
data_sources
block as defined below. This property is optional and can be omitted if the rule is meant to be used via direct calls to the provisioned endpoint. - description String
- The description of the Data Collection Rule.
- destinations
Data
Collection Rule Destinations - A
destinations
block as defined below. - identity
Data
Collection Rule Identity - An
identity
block as defined below. - immutable
Id String - The immutable ID of the Data Collection Rule.
- kind String
The kind of the Data Collection Rule. Possible values are
Linux
,Windows
,AgentDirectToStore
andWorkspaceTransforms
. A rule of kindLinux
does not allow forwindows_event_log
data sources. And a rule of kindWindows
does not allow forsyslog
data sources. If kind is not specified, all kinds of data sources are allowed.NOTE Once
kind
has been set, changing it forces a new Data Collection Rule to be created.- location String
- The Azure Region where the Data Collection Rule should exist. Changing this forces a new Data Collection Rule to be created.
- name String
- The name which should be used for this Data Collection Rule. Changing this forces a new Data Collection Rule to be created.
- resource
Group StringName - The name of the Resource Group where the Data Collection Rule should exist. Changing this forces a new Data Collection Rule to be created.
- stream
Declarations List<DataCollection Rule Stream Declaration> - A
stream_declaration
block as defined below. - Map<String,String>
- A mapping of tags which should be assigned to the Data Collection Rule.
- data
Collection stringEndpoint Id - The resource ID of the Data Collection Endpoint that this rule can be used with.
- data
Flows DataCollection Rule Data Flow[] - One or more
data_flow
blocks as defined below. - data
Sources DataCollection Rule Data Sources - A
data_sources
block as defined below. This property is optional and can be omitted if the rule is meant to be used via direct calls to the provisioned endpoint. - description string
- The description of the Data Collection Rule.
- destinations
Data
Collection Rule Destinations - A
destinations
block as defined below. - identity
Data
Collection Rule Identity - An
identity
block as defined below. - immutable
Id string - The immutable ID of the Data Collection Rule.
- kind string
The kind of the Data Collection Rule. Possible values are
Linux
,Windows
,AgentDirectToStore
andWorkspaceTransforms
. A rule of kindLinux
does not allow forwindows_event_log
data sources. And a rule of kindWindows
does not allow forsyslog
data sources. If kind is not specified, all kinds of data sources are allowed.NOTE Once
kind
has been set, changing it forces a new Data Collection Rule to be created.- location string
- The Azure Region where the Data Collection Rule should exist. Changing this forces a new Data Collection Rule to be created.
- name string
- The name which should be used for this Data Collection Rule. Changing this forces a new Data Collection Rule to be created.
- resource
Group stringName - The name of the Resource Group where the Data Collection Rule should exist. Changing this forces a new Data Collection Rule to be created.
- stream
Declarations DataCollection Rule Stream Declaration[] - A
stream_declaration
block as defined below. - {[key: string]: string}
- A mapping of tags which should be assigned to the Data Collection Rule.
- data_
collection_ strendpoint_ id - The resource ID of the Data Collection Endpoint that this rule can be used with.
- data_
flows Sequence[DataCollection Rule Data Flow Args] - One or more
data_flow
blocks as defined below. - data_
sources DataCollection Rule Data Sources Args - A
data_sources
block as defined below. This property is optional and can be omitted if the rule is meant to be used via direct calls to the provisioned endpoint. - description str
- The description of the Data Collection Rule.
- destinations
Data
Collection Rule Destinations Args - A
destinations
block as defined below. - identity
Data
Collection Rule Identity Args - An
identity
block as defined below. - immutable_
id str - The immutable ID of the Data Collection Rule.
- kind str
The kind of the Data Collection Rule. Possible values are
Linux
,Windows
,AgentDirectToStore
andWorkspaceTransforms
. A rule of kindLinux
does not allow forwindows_event_log
data sources. And a rule of kindWindows
does not allow forsyslog
data sources. If kind is not specified, all kinds of data sources are allowed.NOTE Once
kind
has been set, changing it forces a new Data Collection Rule to be created.- location str
- The Azure Region where the Data Collection Rule should exist. Changing this forces a new Data Collection Rule to be created.
- name str
- The name which should be used for this Data Collection Rule. Changing this forces a new Data Collection Rule to be created.
- resource_
group_ strname - The name of the Resource Group where the Data Collection Rule should exist. Changing this forces a new Data Collection Rule to be created.
- stream_
declarations Sequence[DataCollection Rule Stream Declaration Args] - A
stream_declaration
block as defined below. - Mapping[str, str]
- A mapping of tags which should be assigned to the Data Collection Rule.
- data
Collection StringEndpoint Id - The resource ID of the Data Collection Endpoint that this rule can be used with.
- data
Flows List<Property Map> - One or more
data_flow
blocks as defined below. - data
Sources Property Map - A
data_sources
block as defined below. This property is optional and can be omitted if the rule is meant to be used via direct calls to the provisioned endpoint. - description String
- The description of the Data Collection Rule.
- destinations Property Map
- A
destinations
block as defined below. - identity Property Map
- An
identity
block as defined below. - immutable
Id String - The immutable ID of the Data Collection Rule.
- kind String
The kind of the Data Collection Rule. Possible values are
Linux
,Windows
,AgentDirectToStore
andWorkspaceTransforms
. A rule of kindLinux
does not allow forwindows_event_log
data sources. And a rule of kindWindows
does not allow forsyslog
data sources. If kind is not specified, all kinds of data sources are allowed.NOTE Once
kind
has been set, changing it forces a new Data Collection Rule to be created.- location String
- The Azure Region where the Data Collection Rule should exist. Changing this forces a new Data Collection Rule to be created.
- name String
- The name which should be used for this Data Collection Rule. Changing this forces a new Data Collection Rule to be created.
- resource
Group StringName - The name of the Resource Group where the Data Collection Rule should exist. Changing this forces a new Data Collection Rule to be created.
- stream
Declarations List<Property Map> - A
stream_declaration
block as defined below. - Map<String>
- A mapping of tags which should be assigned to the Data Collection Rule.
Supporting Types
DataCollectionRuleDataFlow, DataCollectionRuleDataFlowArgs
- Destinations List<string>
- Specifies a list of destination names. A
azure_monitor_metrics
data source only allows for stream of kindMicrosoft-InsightsMetrics
. - Streams List<string>
- Specifies a list of streams. Possible values include but not limited to
Microsoft-Event
,Microsoft-InsightsMetrics
,Microsoft-Perf
,Microsoft-Syslog
,Microsoft-WindowsEvent
, andMicrosoft-PrometheusMetrics
. - Built
In stringTransform - The built-in transform to transform stream data.
- Output
Stream string - The output stream of the transform. Only required if the data flow changes data to a different stream.
- Transform
Kql string - The KQL query to transform stream data.
- Destinations []string
- Specifies a list of destination names. A
azure_monitor_metrics
data source only allows for stream of kindMicrosoft-InsightsMetrics
. - Streams []string
- Specifies a list of streams. Possible values include but not limited to
Microsoft-Event
,Microsoft-InsightsMetrics
,Microsoft-Perf
,Microsoft-Syslog
,Microsoft-WindowsEvent
, andMicrosoft-PrometheusMetrics
. - Built
In stringTransform - The built-in transform to transform stream data.
- Output
Stream string - The output stream of the transform. Only required if the data flow changes data to a different stream.
- Transform
Kql string - The KQL query to transform stream data.
- destinations List<String>
- Specifies a list of destination names. A
azure_monitor_metrics
data source only allows for stream of kindMicrosoft-InsightsMetrics
. - streams List<String>
- Specifies a list of streams. Possible values include but not limited to
Microsoft-Event
,Microsoft-InsightsMetrics
,Microsoft-Perf
,Microsoft-Syslog
,Microsoft-WindowsEvent
, andMicrosoft-PrometheusMetrics
. - built
In StringTransform - The built-in transform to transform stream data.
- output
Stream String - The output stream of the transform. Only required if the data flow changes data to a different stream.
- transform
Kql String - The KQL query to transform stream data.
- destinations string[]
- Specifies a list of destination names. A
azure_monitor_metrics
data source only allows for stream of kindMicrosoft-InsightsMetrics
. - streams string[]
- Specifies a list of streams. Possible values include but not limited to
Microsoft-Event
,Microsoft-InsightsMetrics
,Microsoft-Perf
,Microsoft-Syslog
,Microsoft-WindowsEvent
, andMicrosoft-PrometheusMetrics
. - built
In stringTransform - The built-in transform to transform stream data.
- output
Stream string - The output stream of the transform. Only required if the data flow changes data to a different stream.
- transform
Kql string - The KQL query to transform stream data.
- destinations Sequence[str]
- Specifies a list of destination names. A
azure_monitor_metrics
data source only allows for stream of kindMicrosoft-InsightsMetrics
. - streams Sequence[str]
- Specifies a list of streams. Possible values include but not limited to
Microsoft-Event
,Microsoft-InsightsMetrics
,Microsoft-Perf
,Microsoft-Syslog
,Microsoft-WindowsEvent
, andMicrosoft-PrometheusMetrics
. - built_
in_ strtransform - The built-in transform to transform stream data.
- output_
stream str - The output stream of the transform. Only required if the data flow changes data to a different stream.
- transform_
kql str - The KQL query to transform stream data.
- destinations List<String>
- Specifies a list of destination names. A
azure_monitor_metrics
data source only allows for stream of kindMicrosoft-InsightsMetrics
. - streams List<String>
- Specifies a list of streams. Possible values include but not limited to
Microsoft-Event
,Microsoft-InsightsMetrics
,Microsoft-Perf
,Microsoft-Syslog
,Microsoft-WindowsEvent
, andMicrosoft-PrometheusMetrics
. - built
In StringTransform - The built-in transform to transform stream data.
- output
Stream String - The output stream of the transform. Only required if the data flow changes data to a different stream.
- transform
Kql String - The KQL query to transform stream data.
DataCollectionRuleDataSources, DataCollectionRuleDataSourcesArgs
- Data
Import DataCollection Rule Data Sources Data Import - A
data_import
block as defined above. - Extensions
List<Data
Collection Rule Data Sources Extension> - One or more
extension
blocks as defined below. - Iis
Logs List<DataCollection Rule Data Sources Iis Log> - One or more
iis_log
blocks as defined below. - Log
Files List<DataCollection Rule Data Sources Log File> - One or more
log_file
blocks as defined below. - Performance
Counters List<DataCollection Rule Data Sources Performance Counter> - One or more
performance_counter
blocks as defined below. - Platform
Telemetries List<DataCollection Rule Data Sources Platform Telemetry> - One or more
platform_telemetry
blocks as defined below. - Prometheus
Forwarders List<DataCollection Rule Data Sources Prometheus Forwarder> - One or more
prometheus_forwarder
blocks as defined below. - Syslogs
List<Data
Collection Rule Data Sources Syslog> - One or more
syslog
blocks as defined below. - Windows
Event List<DataLogs Collection Rule Data Sources Windows Event Log> - One or more
windows_event_log
blocks as defined below. - Windows
Firewall List<DataLogs Collection Rule Data Sources Windows Firewall Log> - One or more
windows_firewall_log
blocks as defined below.
- Data
Import DataCollection Rule Data Sources Data Import - A
data_import
block as defined above. - Extensions
[]Data
Collection Rule Data Sources Extension - One or more
extension
blocks as defined below. - Iis
Logs []DataCollection Rule Data Sources Iis Log - One or more
iis_log
blocks as defined below. - Log
Files []DataCollection Rule Data Sources Log File - One or more
log_file
blocks as defined below. - Performance
Counters []DataCollection Rule Data Sources Performance Counter - One or more
performance_counter
blocks as defined below. - Platform
Telemetries []DataCollection Rule Data Sources Platform Telemetry - One or more
platform_telemetry
blocks as defined below. - Prometheus
Forwarders []DataCollection Rule Data Sources Prometheus Forwarder - One or more
prometheus_forwarder
blocks as defined below. - Syslogs
[]Data
Collection Rule Data Sources Syslog - One or more
syslog
blocks as defined below. - Windows
Event []DataLogs Collection Rule Data Sources Windows Event Log - One or more
windows_event_log
blocks as defined below. - Windows
Firewall []DataLogs Collection Rule Data Sources Windows Firewall Log - One or more
windows_firewall_log
blocks as defined below.
- data
Import DataCollection Rule Data Sources Data Import - A
data_import
block as defined above. - extensions
List<Data
Collection Rule Data Sources Extension> - One or more
extension
blocks as defined below. - iis
Logs List<DataCollection Rule Data Sources Iis Log> - One or more
iis_log
blocks as defined below. - log
Files List<DataCollection Rule Data Sources Log File> - One or more
log_file
blocks as defined below. - performance
Counters List<DataCollection Rule Data Sources Performance Counter> - One or more
performance_counter
blocks as defined below. - platform
Telemetries List<DataCollection Rule Data Sources Platform Telemetry> - One or more
platform_telemetry
blocks as defined below. - prometheus
Forwarders List<DataCollection Rule Data Sources Prometheus Forwarder> - One or more
prometheus_forwarder
blocks as defined below. - syslogs
List<Data
Collection Rule Data Sources Syslog> - One or more
syslog
blocks as defined below. - windows
Event List<DataLogs Collection Rule Data Sources Windows Event Log> - One or more
windows_event_log
blocks as defined below. - windows
Firewall List<DataLogs Collection Rule Data Sources Windows Firewall Log> - One or more
windows_firewall_log
blocks as defined below.
- data
Import DataCollection Rule Data Sources Data Import - A
data_import
block as defined above. - extensions
Data
Collection Rule Data Sources Extension[] - One or more
extension
blocks as defined below. - iis
Logs DataCollection Rule Data Sources Iis Log[] - One or more
iis_log
blocks as defined below. - log
Files DataCollection Rule Data Sources Log File[] - One or more
log_file
blocks as defined below. - performance
Counters DataCollection Rule Data Sources Performance Counter[] - One or more
performance_counter
blocks as defined below. - platform
Telemetries DataCollection Rule Data Sources Platform Telemetry[] - One or more
platform_telemetry
blocks as defined below. - prometheus
Forwarders DataCollection Rule Data Sources Prometheus Forwarder[] - One or more
prometheus_forwarder
blocks as defined below. - syslogs
Data
Collection Rule Data Sources Syslog[] - One or more
syslog
blocks as defined below. - windows
Event DataLogs Collection Rule Data Sources Windows Event Log[] - One or more
windows_event_log
blocks as defined below. - windows
Firewall DataLogs Collection Rule Data Sources Windows Firewall Log[] - One or more
windows_firewall_log
blocks as defined below.
- data_
import DataCollection Rule Data Sources Data Import - A
data_import
block as defined above. - extensions
Sequence[Data
Collection Rule Data Sources Extension] - One or more
extension
blocks as defined below. - iis_
logs Sequence[DataCollection Rule Data Sources Iis Log] - One or more
iis_log
blocks as defined below. - log_
files Sequence[DataCollection Rule Data Sources Log File] - One or more
log_file
blocks as defined below. - performance_
counters Sequence[DataCollection Rule Data Sources Performance Counter] - One or more
performance_counter
blocks as defined below. - platform_
telemetries Sequence[DataCollection Rule Data Sources Platform Telemetry] - One or more
platform_telemetry
blocks as defined below. - prometheus_
forwarders Sequence[DataCollection Rule Data Sources Prometheus Forwarder] - One or more
prometheus_forwarder
blocks as defined below. - syslogs
Sequence[Data
Collection Rule Data Sources Syslog] - One or more
syslog
blocks as defined below. - windows_
event_ Sequence[Datalogs Collection Rule Data Sources Windows Event Log] - One or more
windows_event_log
blocks as defined below. - windows_
firewall_ Sequence[Datalogs Collection Rule Data Sources Windows Firewall Log] - One or more
windows_firewall_log
blocks as defined below.
- data
Import Property Map - A
data_import
block as defined above. - extensions List<Property Map>
- One or more
extension
blocks as defined below. - iis
Logs List<Property Map> - One or more
iis_log
blocks as defined below. - log
Files List<Property Map> - One or more
log_file
blocks as defined below. - performance
Counters List<Property Map> - One or more
performance_counter
blocks as defined below. - platform
Telemetries List<Property Map> - One or more
platform_telemetry
blocks as defined below. - prometheus
Forwarders List<Property Map> - One or more
prometheus_forwarder
blocks as defined below. - syslogs List<Property Map>
- One or more
syslog
blocks as defined below. - windows
Event List<Property Map>Logs - One or more
windows_event_log
blocks as defined below. - windows
Firewall List<Property Map>Logs - One or more
windows_firewall_log
blocks as defined below.
DataCollectionRuleDataSourcesDataImport, DataCollectionRuleDataSourcesDataImportArgs
- Event
Hub List<DataData Sources Collection Rule Data Sources Data Import Event Hub Data Source> - An
event_hub_data_source
block as defined below.
- Event
Hub []DataData Sources Collection Rule Data Sources Data Import Event Hub Data Source - An
event_hub_data_source
block as defined below.
- event
Hub List<DataData Sources Collection Rule Data Sources Data Import Event Hub Data Source> - An
event_hub_data_source
block as defined below.
- event
Hub DataData Sources Collection Rule Data Sources Data Import Event Hub Data Source[] - An
event_hub_data_source
block as defined below.
- event_
hub_ Sequence[Datadata_ sources Collection Rule Data Sources Data Import Event Hub Data Source] - An
event_hub_data_source
block as defined below.
- event
Hub List<Property Map>Data Sources - An
event_hub_data_source
block as defined below.
DataCollectionRuleDataSourcesDataImportEventHubDataSource, DataCollectionRuleDataSourcesDataImportEventHubDataSourceArgs
- Name string
- The name which should be used for this data source. This name should be unique across all data sources regardless of type within the Data Collection Rule.
- Stream string
- The stream to collect from Event Hub. Possible value should be a custom stream name.
- Consumer
Group string - The Event Hub consumer group name.
- Name string
- The name which should be used for this data source. This name should be unique across all data sources regardless of type within the Data Collection Rule.
- Stream string
- The stream to collect from Event Hub. Possible value should be a custom stream name.
- Consumer
Group string - The Event Hub consumer group name.
- name String
- The name which should be used for this data source. This name should be unique across all data sources regardless of type within the Data Collection Rule.
- stream String
- The stream to collect from Event Hub. Possible value should be a custom stream name.
- consumer
Group String - The Event Hub consumer group name.
- name string
- The name which should be used for this data source. This name should be unique across all data sources regardless of type within the Data Collection Rule.
- stream string
- The stream to collect from Event Hub. Possible value should be a custom stream name.
- consumer
Group string - The Event Hub consumer group name.
- name str
- The name which should be used for this data source. This name should be unique across all data sources regardless of type within the Data Collection Rule.
- stream str
- The stream to collect from Event Hub. Possible value should be a custom stream name.
- consumer_
group str - The Event Hub consumer group name.
- name String
- The name which should be used for this data source. This name should be unique across all data sources regardless of type within the Data Collection Rule.
- stream String
- The stream to collect from Event Hub. Possible value should be a custom stream name.
- consumer
Group String - The Event Hub consumer group name.
DataCollectionRuleDataSourcesExtension, DataCollectionRuleDataSourcesExtensionArgs
- Extension
Name string - The name of the VM extension.
- Name string
- The name which should be used for this data source. This name should be unique across all data sources regardless of type within the Data Collection Rule.
- Streams List<string>
- Specifies a list of streams that this data source will be sent to. A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to. Possible values include but not limited to
Microsoft-Event
,Microsoft-InsightsMetrics
,Microsoft-Perf
,Microsoft-Syslog
,Microsoft-WindowsEvent
. - Extension
Json string - A JSON String which specifies the extension setting.
- Input
Data List<string>Sources - Specifies a list of data sources this extension needs data from. An item should be a name of a supported data source which produces only one stream. Supported data sources type:
performance_counter
,windows_event_log
,andsyslog
.
- Extension
Name string - The name of the VM extension.
- Name string
- The name which should be used for this data source. This name should be unique across all data sources regardless of type within the Data Collection Rule.
- Streams []string
- Specifies a list of streams that this data source will be sent to. A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to. Possible values include but not limited to
Microsoft-Event
,Microsoft-InsightsMetrics
,Microsoft-Perf
,Microsoft-Syslog
,Microsoft-WindowsEvent
. - Extension
Json string - A JSON String which specifies the extension setting.
- Input
Data []stringSources - Specifies a list of data sources this extension needs data from. An item should be a name of a supported data source which produces only one stream. Supported data sources type:
performance_counter
,windows_event_log
,andsyslog
.
- extension
Name String - The name of the VM extension.
- name String
- The name which should be used for this data source. This name should be unique across all data sources regardless of type within the Data Collection Rule.
- streams List<String>
- Specifies a list of streams that this data source will be sent to. A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to. Possible values include but not limited to
Microsoft-Event
,Microsoft-InsightsMetrics
,Microsoft-Perf
,Microsoft-Syslog
,Microsoft-WindowsEvent
. - extension
Json String - A JSON String which specifies the extension setting.
- input
Data List<String>Sources - Specifies a list of data sources this extension needs data from. An item should be a name of a supported data source which produces only one stream. Supported data sources type:
performance_counter
,windows_event_log
,andsyslog
.
- extension
Name string - The name of the VM extension.
- name string
- The name which should be used for this data source. This name should be unique across all data sources regardless of type within the Data Collection Rule.
- streams string[]
- Specifies a list of streams that this data source will be sent to. A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to. Possible values include but not limited to
Microsoft-Event
,Microsoft-InsightsMetrics
,Microsoft-Perf
,Microsoft-Syslog
,Microsoft-WindowsEvent
. - extension
Json string - A JSON String which specifies the extension setting.
- input
Data string[]Sources - Specifies a list of data sources this extension needs data from. An item should be a name of a supported data source which produces only one stream. Supported data sources type:
performance_counter
,windows_event_log
,andsyslog
.
- extension_
name str - The name of the VM extension.
- name str
- The name which should be used for this data source. This name should be unique across all data sources regardless of type within the Data Collection Rule.
- streams Sequence[str]
- Specifies a list of streams that this data source will be sent to. A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to. Possible values include but not limited to
Microsoft-Event
,Microsoft-InsightsMetrics
,Microsoft-Perf
,Microsoft-Syslog
,Microsoft-WindowsEvent
. - extension_
json str - A JSON String which specifies the extension setting.
- input_
data_ Sequence[str]sources - Specifies a list of data sources this extension needs data from. An item should be a name of a supported data source which produces only one stream. Supported data sources type:
performance_counter
,windows_event_log
,andsyslog
.
- extension
Name String - The name of the VM extension.
- name String
- The name which should be used for this data source. This name should be unique across all data sources regardless of type within the Data Collection Rule.
- streams List<String>
- Specifies a list of streams that this data source will be sent to. A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to. Possible values include but not limited to
Microsoft-Event
,Microsoft-InsightsMetrics
,Microsoft-Perf
,Microsoft-Syslog
,Microsoft-WindowsEvent
. - extension
Json String - A JSON String which specifies the extension setting.
- input
Data List<String>Sources - Specifies a list of data sources this extension needs data from. An item should be a name of a supported data source which produces only one stream. Supported data sources type:
performance_counter
,windows_event_log
,andsyslog
.
DataCollectionRuleDataSourcesIisLog, DataCollectionRuleDataSourcesIisLogArgs
- Name string
- The name which should be used for this data source. This name should be unique across all data sources regardless of type within the Data Collection Rule.
- Streams List<string>
- Specifies a list of streams that this data source will be sent to. A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to. Possible value is
Microsoft-W3CIISLog
. - Log
Directories List<string> - Specifies a list of absolute paths where the log files are located.
- Name string
- The name which should be used for this data source. This name should be unique across all data sources regardless of type within the Data Collection Rule.
- Streams []string
- Specifies a list of streams that this data source will be sent to. A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to. Possible value is
Microsoft-W3CIISLog
. - Log
Directories []string - Specifies a list of absolute paths where the log files are located.
- name String
- The name which should be used for this data source. This name should be unique across all data sources regardless of type within the Data Collection Rule.
- streams List<String>
- Specifies a list of streams that this data source will be sent to. A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to. Possible value is
Microsoft-W3CIISLog
. - log
Directories List<String> - Specifies a list of absolute paths where the log files are located.
- name string
- The name which should be used for this data source. This name should be unique across all data sources regardless of type within the Data Collection Rule.
- streams string[]
- Specifies a list of streams that this data source will be sent to. A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to. Possible value is
Microsoft-W3CIISLog
. - log
Directories string[] - Specifies a list of absolute paths where the log files are located.
- name str
- The name which should be used for this data source. This name should be unique across all data sources regardless of type within the Data Collection Rule.
- streams Sequence[str]
- Specifies a list of streams that this data source will be sent to. A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to. Possible value is
Microsoft-W3CIISLog
. - log_
directories Sequence[str] - Specifies a list of absolute paths where the log files are located.
- name String
- The name which should be used for this data source. This name should be unique across all data sources regardless of type within the Data Collection Rule.
- streams List<String>
- Specifies a list of streams that this data source will be sent to. A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to. Possible value is
Microsoft-W3CIISLog
. - log
Directories List<String> - Specifies a list of absolute paths where the log files are located.
DataCollectionRuleDataSourcesLogFile, DataCollectionRuleDataSourcesLogFileArgs
- File
Patterns List<string> - Specifies a list of file patterns where the log files are located. For example,
C:\\JavaLogs\\*.log
. - Format string
- The data format of the log files. possible value is
text
. - Name string
- The name which should be used for this data source. This name should be unique across all data sources regardless of type within the Data Collection Rule.
- Streams List<string>
- Specifies a list of streams that this data source will be sent to. A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to. Possible value should be custom stream names.
- Settings
Data
Collection Rule Data Sources Log File Settings - A
settings
block as defined below.
- File
Patterns []string - Specifies a list of file patterns where the log files are located. For example,
C:\\JavaLogs\\*.log
. - Format string
- The data format of the log files. possible value is
text
. - Name string
- The name which should be used for this data source. This name should be unique across all data sources regardless of type within the Data Collection Rule.
- Streams []string
- Specifies a list of streams that this data source will be sent to. A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to. Possible value should be custom stream names.
- Settings
Data
Collection Rule Data Sources Log File Settings - A
settings
block as defined below.
- file
Patterns List<String> - Specifies a list of file patterns where the log files are located. For example,
C:\\JavaLogs\\*.log
. - format String
- The data format of the log files. possible value is
text
. - name String
- The name which should be used for this data source. This name should be unique across all data sources regardless of type within the Data Collection Rule.
- streams List<String>
- Specifies a list of streams that this data source will be sent to. A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to. Possible value should be custom stream names.
- settings
Data
Collection Rule Data Sources Log File Settings - A
settings
block as defined below.
- file
Patterns string[] - Specifies a list of file patterns where the log files are located. For example,
C:\\JavaLogs\\*.log
. - format string
- The data format of the log files. possible value is
text
. - name string
- The name which should be used for this data source. This name should be unique across all data sources regardless of type within the Data Collection Rule.
- streams string[]
- Specifies a list of streams that this data source will be sent to. A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to. Possible value should be custom stream names.
- settings
Data
Collection Rule Data Sources Log File Settings - A
settings
block as defined below.
- file_
patterns Sequence[str] - Specifies a list of file patterns where the log files are located. For example,
C:\\JavaLogs\\*.log
. - format str
- The data format of the log files. possible value is
text
. - name str
- The name which should be used for this data source. This name should be unique across all data sources regardless of type within the Data Collection Rule.
- streams Sequence[str]
- Specifies a list of streams that this data source will be sent to. A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to. Possible value should be custom stream names.
- settings
Data
Collection Rule Data Sources Log File Settings - A
settings
block as defined below.
- file
Patterns List<String> - Specifies a list of file patterns where the log files are located. For example,
C:\\JavaLogs\\*.log
. - format String
- The data format of the log files. possible value is
text
. - name String
- The name which should be used for this data source. This name should be unique across all data sources regardless of type within the Data Collection Rule.
- streams List<String>
- Specifies a list of streams that this data source will be sent to. A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to. Possible value should be custom stream names.
- settings Property Map
- A
settings
block as defined below.
DataCollectionRuleDataSourcesLogFileSettings, DataCollectionRuleDataSourcesLogFileSettingsArgs
- Text
Data
Collection Rule Data Sources Log File Settings Text - A
text
block as defined below.
- Text
Data
Collection Rule Data Sources Log File Settings Text - A
text
block as defined below.
- text
Data
Collection Rule Data Sources Log File Settings Text - A
text
block as defined below.
- text
Data
Collection Rule Data Sources Log File Settings Text - A
text
block as defined below.
- text
Data
Collection Rule Data Sources Log File Settings Text - A
text
block as defined below.
- text Property Map
- A
text
block as defined below.
DataCollectionRuleDataSourcesLogFileSettingsText, DataCollectionRuleDataSourcesLogFileSettingsTextArgs
- Record
Start stringTimestamp Format - The timestamp format of the text log files. Possible values are
ISO 8601
,YYYY-MM-DD HH:MM:SS
,M/D/YYYY HH:MM:SS AM/PM
,Mon DD, YYYY HH:MM:SS
,yyMMdd HH:mm:ss
,ddMMyy HH:mm:ss
,MMM d hh:mm:ss
,dd/MMM/yyyy:HH:mm:ss zzz
,andyyyy-MM-ddTHH:mm:ssK
.
- Record
Start stringTimestamp Format - The timestamp format of the text log files. Possible values are
ISO 8601
,YYYY-MM-DD HH:MM:SS
,M/D/YYYY HH:MM:SS AM/PM
,Mon DD, YYYY HH:MM:SS
,yyMMdd HH:mm:ss
,ddMMyy HH:mm:ss
,MMM d hh:mm:ss
,dd/MMM/yyyy:HH:mm:ss zzz
,andyyyy-MM-ddTHH:mm:ssK
.
- record
Start StringTimestamp Format - The timestamp format of the text log files. Possible values are
ISO 8601
,YYYY-MM-DD HH:MM:SS
,M/D/YYYY HH:MM:SS AM/PM
,Mon DD, YYYY HH:MM:SS
,yyMMdd HH:mm:ss
,ddMMyy HH:mm:ss
,MMM d hh:mm:ss
,dd/MMM/yyyy:HH:mm:ss zzz
,andyyyy-MM-ddTHH:mm:ssK
.
- record
Start stringTimestamp Format - The timestamp format of the text log files. Possible values are
ISO 8601
,YYYY-MM-DD HH:MM:SS
,M/D/YYYY HH:MM:SS AM/PM
,Mon DD, YYYY HH:MM:SS
,yyMMdd HH:mm:ss
,ddMMyy HH:mm:ss
,MMM d hh:mm:ss
,dd/MMM/yyyy:HH:mm:ss zzz
,andyyyy-MM-ddTHH:mm:ssK
.
- record_
start_ strtimestamp_ format - The timestamp format of the text log files. Possible values are
ISO 8601
,YYYY-MM-DD HH:MM:SS
,M/D/YYYY HH:MM:SS AM/PM
,Mon DD, YYYY HH:MM:SS
,yyMMdd HH:mm:ss
,ddMMyy HH:mm:ss
,MMM d hh:mm:ss
,dd/MMM/yyyy:HH:mm:ss zzz
,andyyyy-MM-ddTHH:mm:ssK
.
- record
Start StringTimestamp Format - The timestamp format of the text log files. Possible values are
ISO 8601
,YYYY-MM-DD HH:MM:SS
,M/D/YYYY HH:MM:SS AM/PM
,Mon DD, YYYY HH:MM:SS
,yyMMdd HH:mm:ss
,ddMMyy HH:mm:ss
,MMM d hh:mm:ss
,dd/MMM/yyyy:HH:mm:ss zzz
,andyyyy-MM-ddTHH:mm:ssK
.
DataCollectionRuleDataSourcesPerformanceCounter, DataCollectionRuleDataSourcesPerformanceCounterArgs
- Counter
Specifiers List<string> - Specifies a list of specifier names of the performance counters you want to collect. To get a list of performance counters on Windows, run the command
typeperf
. Please see this document for more information. - Name string
- The name which should be used for this data source. This name should be unique across all data sources regardless of type within the Data Collection Rule.
- Sampling
Frequency intIn Seconds - The number of seconds between consecutive counter measurements (samples). The value should be integer between
1
and300
inclusive.sampling_frequency_in_seconds
must be equal to60
seconds for counters collected withMicrosoft-InsightsMetrics
stream. - Streams List<string>
- Specifies a list of streams that this data source will be sent to. A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to. Possible values include but not limited to
Microsoft-InsightsMetrics
,andMicrosoft-Perf
.
- Counter
Specifiers []string - Specifies a list of specifier names of the performance counters you want to collect. To get a list of performance counters on Windows, run the command
typeperf
. Please see this document for more information. - Name string
- The name which should be used for this data source. This name should be unique across all data sources regardless of type within the Data Collection Rule.
- Sampling
Frequency intIn Seconds - The number of seconds between consecutive counter measurements (samples). The value should be integer between
1
and300
inclusive.sampling_frequency_in_seconds
must be equal to60
seconds for counters collected withMicrosoft-InsightsMetrics
stream. - Streams []string
- Specifies a list of streams that this data source will be sent to. A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to. Possible values include but not limited to
Microsoft-InsightsMetrics
,andMicrosoft-Perf
.
- counter
Specifiers List<String> - Specifies a list of specifier names of the performance counters you want to collect. To get a list of performance counters on Windows, run the command
typeperf
. Please see this document for more information. - name String
- The name which should be used for this data source. This name should be unique across all data sources regardless of type within the Data Collection Rule.
- sampling
Frequency IntegerIn Seconds - The number of seconds between consecutive counter measurements (samples). The value should be integer between
1
and300
inclusive.sampling_frequency_in_seconds
must be equal to60
seconds for counters collected withMicrosoft-InsightsMetrics
stream. - streams List<String>
- Specifies a list of streams that this data source will be sent to. A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to. Possible values include but not limited to
Microsoft-InsightsMetrics
,andMicrosoft-Perf
.
- counter
Specifiers string[] - Specifies a list of specifier names of the performance counters you want to collect. To get a list of performance counters on Windows, run the command
typeperf
. Please see this document for more information. - name string
- The name which should be used for this data source. This name should be unique across all data sources regardless of type within the Data Collection Rule.
- sampling
Frequency numberIn Seconds - The number of seconds between consecutive counter measurements (samples). The value should be integer between
1
and300
inclusive.sampling_frequency_in_seconds
must be equal to60
seconds for counters collected withMicrosoft-InsightsMetrics
stream. - streams string[]
- Specifies a list of streams that this data source will be sent to. A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to. Possible values include but not limited to
Microsoft-InsightsMetrics
,andMicrosoft-Perf
.
- counter_
specifiers Sequence[str] - Specifies a list of specifier names of the performance counters you want to collect. To get a list of performance counters on Windows, run the command
typeperf
. Please see this document for more information. - name str
- The name which should be used for this data source. This name should be unique across all data sources regardless of type within the Data Collection Rule.
- sampling_
frequency_ intin_ seconds - The number of seconds between consecutive counter measurements (samples). The value should be integer between
1
and300
inclusive.sampling_frequency_in_seconds
must be equal to60
seconds for counters collected withMicrosoft-InsightsMetrics
stream. - streams Sequence[str]
- Specifies a list of streams that this data source will be sent to. A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to. Possible values include but not limited to
Microsoft-InsightsMetrics
,andMicrosoft-Perf
.
- counter
Specifiers List<String> - Specifies a list of specifier names of the performance counters you want to collect. To get a list of performance counters on Windows, run the command
typeperf
. Please see this document for more information. - name String
- The name which should be used for this data source. This name should be unique across all data sources regardless of type within the Data Collection Rule.
- sampling
Frequency NumberIn Seconds - The number of seconds between consecutive counter measurements (samples). The value should be integer between
1
and300
inclusive.sampling_frequency_in_seconds
must be equal to60
seconds for counters collected withMicrosoft-InsightsMetrics
stream. - streams List<String>
- Specifies a list of streams that this data source will be sent to. A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to. Possible values include but not limited to
Microsoft-InsightsMetrics
,andMicrosoft-Perf
.
DataCollectionRuleDataSourcesPlatformTelemetry, DataCollectionRuleDataSourcesPlatformTelemetryArgs
- Name string
- The name which should be used for this data source. This name should be unique across all data sources regardless of type within the Data Collection Rule.
- Streams List<string>
- Specifies a list of streams that this data source will be sent to. A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to. Possible values include but not limited to
Microsoft.Cache/redis:Metrics-Group-All
.
- Name string
- The name which should be used for this data source. This name should be unique across all data sources regardless of type within the Data Collection Rule.
- Streams []string
- Specifies a list of streams that this data source will be sent to. A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to. Possible values include but not limited to
Microsoft.Cache/redis:Metrics-Group-All
.
- name String
- The name which should be used for this data source. This name should be unique across all data sources regardless of type within the Data Collection Rule.
- streams List<String>
- Specifies a list of streams that this data source will be sent to. A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to. Possible values include but not limited to
Microsoft.Cache/redis:Metrics-Group-All
.
- name string
- The name which should be used for this data source. This name should be unique across all data sources regardless of type within the Data Collection Rule.
- streams string[]
- Specifies a list of streams that this data source will be sent to. A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to. Possible values include but not limited to
Microsoft.Cache/redis:Metrics-Group-All
.
- name str
- The name which should be used for this data source. This name should be unique across all data sources regardless of type within the Data Collection Rule.
- streams Sequence[str]
- Specifies a list of streams that this data source will be sent to. A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to. Possible values include but not limited to
Microsoft.Cache/redis:Metrics-Group-All
.
- name String
- The name which should be used for this data source. This name should be unique across all data sources regardless of type within the Data Collection Rule.
- streams List<String>
- Specifies a list of streams that this data source will be sent to. A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to. Possible values include but not limited to
Microsoft.Cache/redis:Metrics-Group-All
.
DataCollectionRuleDataSourcesPrometheusForwarder, DataCollectionRuleDataSourcesPrometheusForwarderArgs
- Name string
- The name which should be used for this data source. This name should be unique across all data sources regardless of type within the Data Collection Rule.
- Streams List<string>
- Specifies a list of streams that this data source will be sent to. A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to. Possible value is
Microsoft-PrometheusMetrics
. - Label
Include List<DataFilters Collection Rule Data Sources Prometheus Forwarder Label Include Filter> - One or more
label_include_filter
blocks as defined above.
- Name string
- The name which should be used for this data source. This name should be unique across all data sources regardless of type within the Data Collection Rule.
- Streams []string
- Specifies a list of streams that this data source will be sent to. A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to. Possible value is
Microsoft-PrometheusMetrics
. - Label
Include []DataFilters Collection Rule Data Sources Prometheus Forwarder Label Include Filter - One or more
label_include_filter
blocks as defined above.
- name String
- The name which should be used for this data source. This name should be unique across all data sources regardless of type within the Data Collection Rule.
- streams List<String>
- Specifies a list of streams that this data source will be sent to. A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to. Possible value is
Microsoft-PrometheusMetrics
. - label
Include List<DataFilters Collection Rule Data Sources Prometheus Forwarder Label Include Filter> - One or more
label_include_filter
blocks as defined above.
- name string
- The name which should be used for this data source. This name should be unique across all data sources regardless of type within the Data Collection Rule.
- streams string[]
- Specifies a list of streams that this data source will be sent to. A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to. Possible value is
Microsoft-PrometheusMetrics
. - label
Include DataFilters Collection Rule Data Sources Prometheus Forwarder Label Include Filter[] - One or more
label_include_filter
blocks as defined above.
- name str
- The name which should be used for this data source. This name should be unique across all data sources regardless of type within the Data Collection Rule.
- streams Sequence[str]
- Specifies a list of streams that this data source will be sent to. A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to. Possible value is
Microsoft-PrometheusMetrics
. - label_
include_ Sequence[Datafilters Collection Rule Data Sources Prometheus Forwarder Label Include Filter] - One or more
label_include_filter
blocks as defined above.
- name String
- The name which should be used for this data source. This name should be unique across all data sources regardless of type within the Data Collection Rule.
- streams List<String>
- Specifies a list of streams that this data source will be sent to. A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to. Possible value is
Microsoft-PrometheusMetrics
. - label
Include List<Property Map>Filters - One or more
label_include_filter
blocks as defined above.
DataCollectionRuleDataSourcesPrometheusForwarderLabelIncludeFilter, DataCollectionRuleDataSourcesPrometheusForwarderLabelIncludeFilterArgs
DataCollectionRuleDataSourcesSyslog, DataCollectionRuleDataSourcesSyslogArgs
- Facility
Names List<string> - Specifies a list of facility names. Use a wildcard
*
to collect logs for all facility names. Possible values arealert
,*
,audit
,auth
,authpriv
,clock
,cron
,daemon
,ftp
,kern
,local5
,local4
,local1
,local7
,local6
,local3
,local2
,local0
,lpr
,mail
,mark
,news
,nopri
,ntp
,syslog
,user
anduucp
. - Log
Levels List<string> - Specifies a list of log levels. Use a wildcard
*
to collect logs for all log levels. Possible values areDebug
,Info
,Notice
,Warning
,Error
,Critical
,Alert
,Emergency
,and*
. - Name string
- The name which should be used for this data source. This name should be unique across all data sources regardless of type within the Data Collection Rule.
- Streams List<string>
Specifies a list of streams that this data source will be sent to. A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to. Possible values include but not limited to
Microsoft-Syslog
,andMicrosoft-CiscoAsa
, andMicrosoft-CommonSecurityLog
.Note: In 4.0 or later version of the provider,
streams
will be required. In 3.x version of provider, ifstreams
is not specified in creation, it is default to["Microsoft-Syslog"]
. ifstreams
need to be modified (include change other value to the default value), it must be explicitly specified.
- Facility
Names []string - Specifies a list of facility names. Use a wildcard
*
to collect logs for all facility names. Possible values arealert
,*
,audit
,auth
,authpriv
,clock
,cron
,daemon
,ftp
,kern
,local5
,local4
,local1
,local7
,local6
,local3
,local2
,local0
,lpr
,mail
,mark
,news
,nopri
,ntp
,syslog
,user
anduucp
. - Log
Levels []string - Specifies a list of log levels. Use a wildcard
*
to collect logs for all log levels. Possible values areDebug
,Info
,Notice
,Warning
,Error
,Critical
,Alert
,Emergency
,and*
. - Name string
- The name which should be used for this data source. This name should be unique across all data sources regardless of type within the Data Collection Rule.
- Streams []string
Specifies a list of streams that this data source will be sent to. A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to. Possible values include but not limited to
Microsoft-Syslog
,andMicrosoft-CiscoAsa
, andMicrosoft-CommonSecurityLog
.Note: In 4.0 or later version of the provider,
streams
will be required. In 3.x version of provider, ifstreams
is not specified in creation, it is default to["Microsoft-Syslog"]
. ifstreams
need to be modified (include change other value to the default value), it must be explicitly specified.
- facility
Names List<String> - Specifies a list of facility names. Use a wildcard
*
to collect logs for all facility names. Possible values arealert
,*
,audit
,auth
,authpriv
,clock
,cron
,daemon
,ftp
,kern
,local5
,local4
,local1
,local7
,local6
,local3
,local2
,local0
,lpr
,mail
,mark
,news
,nopri
,ntp
,syslog
,user
anduucp
. - log
Levels List<String> - Specifies a list of log levels. Use a wildcard
*
to collect logs for all log levels. Possible values areDebug
,Info
,Notice
,Warning
,Error
,Critical
,Alert
,Emergency
,and*
. - name String
- The name which should be used for this data source. This name should be unique across all data sources regardless of type within the Data Collection Rule.
- streams List<String>
Specifies a list of streams that this data source will be sent to. A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to. Possible values include but not limited to
Microsoft-Syslog
,andMicrosoft-CiscoAsa
, andMicrosoft-CommonSecurityLog
.Note: In 4.0 or later version of the provider,
streams
will be required. In 3.x version of provider, ifstreams
is not specified in creation, it is default to["Microsoft-Syslog"]
. ifstreams
need to be modified (include change other value to the default value), it must be explicitly specified.
- facility
Names string[] - Specifies a list of facility names. Use a wildcard
*
to collect logs for all facility names. Possible values arealert
,*
,audit
,auth
,authpriv
,clock
,cron
,daemon
,ftp
,kern
,local5
,local4
,local1
,local7
,local6
,local3
,local2
,local0
,lpr
,mail
,mark
,news
,nopri
,ntp
,syslog
,user
anduucp
. - log
Levels string[] - Specifies a list of log levels. Use a wildcard
*
to collect logs for all log levels. Possible values areDebug
,Info
,Notice
,Warning
,Error
,Critical
,Alert
,Emergency
,and*
. - name string
- The name which should be used for this data source. This name should be unique across all data sources regardless of type within the Data Collection Rule.
- streams string[]
Specifies a list of streams that this data source will be sent to. A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to. Possible values include but not limited to
Microsoft-Syslog
,andMicrosoft-CiscoAsa
, andMicrosoft-CommonSecurityLog
.Note: In 4.0 or later version of the provider,
streams
will be required. In 3.x version of provider, ifstreams
is not specified in creation, it is default to["Microsoft-Syslog"]
. ifstreams
need to be modified (include change other value to the default value), it must be explicitly specified.
- facility_
names Sequence[str] - Specifies a list of facility names. Use a wildcard
*
to collect logs for all facility names. Possible values arealert
,*
,audit
,auth
,authpriv
,clock
,cron
,daemon
,ftp
,kern
,local5
,local4
,local1
,local7
,local6
,local3
,local2
,local0
,lpr
,mail
,mark
,news
,nopri
,ntp
,syslog
,user
anduucp
. - log_
levels Sequence[str] - Specifies a list of log levels. Use a wildcard
*
to collect logs for all log levels. Possible values areDebug
,Info
,Notice
,Warning
,Error
,Critical
,Alert
,Emergency
,and*
. - name str
- The name which should be used for this data source. This name should be unique across all data sources regardless of type within the Data Collection Rule.
- streams Sequence[str]
Specifies a list of streams that this data source will be sent to. A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to. Possible values include but not limited to
Microsoft-Syslog
,andMicrosoft-CiscoAsa
, andMicrosoft-CommonSecurityLog
.Note: In 4.0 or later version of the provider,
streams
will be required. In 3.x version of provider, ifstreams
is not specified in creation, it is default to["Microsoft-Syslog"]
. ifstreams
need to be modified (include change other value to the default value), it must be explicitly specified.
- facility
Names List<String> - Specifies a list of facility names. Use a wildcard
*
to collect logs for all facility names. Possible values arealert
,*
,audit
,auth
,authpriv
,clock
,cron
,daemon
,ftp
,kern
,local5
,local4
,local1
,local7
,local6
,local3
,local2
,local0
,lpr
,mail
,mark
,news
,nopri
,ntp
,syslog
,user
anduucp
. - log
Levels List<String> - Specifies a list of log levels. Use a wildcard
*
to collect logs for all log levels. Possible values areDebug
,Info
,Notice
,Warning
,Error
,Critical
,Alert
,Emergency
,and*
. - name String
- The name which should be used for this data source. This name should be unique across all data sources regardless of type within the Data Collection Rule.
- streams List<String>
Specifies a list of streams that this data source will be sent to. A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to. Possible values include but not limited to
Microsoft-Syslog
,andMicrosoft-CiscoAsa
, andMicrosoft-CommonSecurityLog
.Note: In 4.0 or later version of the provider,
streams
will be required. In 3.x version of provider, ifstreams
is not specified in creation, it is default to["Microsoft-Syslog"]
. ifstreams
need to be modified (include change other value to the default value), it must be explicitly specified.
DataCollectionRuleDataSourcesWindowsEventLog, DataCollectionRuleDataSourcesWindowsEventLogArgs
- Name string
- The name which should be used for this data source. This name should be unique across all data sources regardless of type within the Data Collection Rule.
- Streams List<string>
- Specifies a list of streams that this data source will be sent to. A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to. Possible values include but not limited to
Microsoft-Event
,andMicrosoft-WindowsEvent
,Microsoft-RomeDetectionEvent
, andMicrosoft-SecurityEvent
. - XPath
Queries List<string> - Specifies a list of Windows Event Log queries in XPath expression. Please see this document for more information.
- Name string
- The name which should be used for this data source. This name should be unique across all data sources regardless of type within the Data Collection Rule.
- Streams []string
- Specifies a list of streams that this data source will be sent to. A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to. Possible values include but not limited to
Microsoft-Event
,andMicrosoft-WindowsEvent
,Microsoft-RomeDetectionEvent
, andMicrosoft-SecurityEvent
. - XPath
Queries []string - Specifies a list of Windows Event Log queries in XPath expression. Please see this document for more information.
- name String
- The name which should be used for this data source. This name should be unique across all data sources regardless of type within the Data Collection Rule.
- streams List<String>
- Specifies a list of streams that this data source will be sent to. A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to. Possible values include but not limited to
Microsoft-Event
,andMicrosoft-WindowsEvent
,Microsoft-RomeDetectionEvent
, andMicrosoft-SecurityEvent
. - x
Path List<String>Queries - Specifies a list of Windows Event Log queries in XPath expression. Please see this document for more information.
- name string
- The name which should be used for this data source. This name should be unique across all data sources regardless of type within the Data Collection Rule.
- streams string[]
- Specifies a list of streams that this data source will be sent to. A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to. Possible values include but not limited to
Microsoft-Event
,andMicrosoft-WindowsEvent
,Microsoft-RomeDetectionEvent
, andMicrosoft-SecurityEvent
. - x
Path string[]Queries - Specifies a list of Windows Event Log queries in XPath expression. Please see this document for more information.
- name str
- The name which should be used for this data source. This name should be unique across all data sources regardless of type within the Data Collection Rule.
- streams Sequence[str]
- Specifies a list of streams that this data source will be sent to. A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to. Possible values include but not limited to
Microsoft-Event
,andMicrosoft-WindowsEvent
,Microsoft-RomeDetectionEvent
, andMicrosoft-SecurityEvent
. - x_
path_ Sequence[str]queries - Specifies a list of Windows Event Log queries in XPath expression. Please see this document for more information.
- name String
- The name which should be used for this data source. This name should be unique across all data sources regardless of type within the Data Collection Rule.
- streams List<String>
- Specifies a list of streams that this data source will be sent to. A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to. Possible values include but not limited to
Microsoft-Event
,andMicrosoft-WindowsEvent
,Microsoft-RomeDetectionEvent
, andMicrosoft-SecurityEvent
. - x
Path List<String>Queries - Specifies a list of Windows Event Log queries in XPath expression. Please see this document for more information.
DataCollectionRuleDataSourcesWindowsFirewallLog, DataCollectionRuleDataSourcesWindowsFirewallLogArgs
- Name string
- The name which should be used for this data source. This name should be unique across all data sources regardless of type within the Data Collection Rule.
- Streams List<string>
- Specifies a list of streams that this data source will be sent to. A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to.
- Name string
- The name which should be used for this data source. This name should be unique across all data sources regardless of type within the Data Collection Rule.
- Streams []string
- Specifies a list of streams that this data source will be sent to. A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to.
- name String
- The name which should be used for this data source. This name should be unique across all data sources regardless of type within the Data Collection Rule.
- streams List<String>
- Specifies a list of streams that this data source will be sent to. A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to.
- name string
- The name which should be used for this data source. This name should be unique across all data sources regardless of type within the Data Collection Rule.
- streams string[]
- Specifies a list of streams that this data source will be sent to. A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to.
- name str
- The name which should be used for this data source. This name should be unique across all data sources regardless of type within the Data Collection Rule.
- streams Sequence[str]
- Specifies a list of streams that this data source will be sent to. A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to.
- name String
- The name which should be used for this data source. This name should be unique across all data sources regardless of type within the Data Collection Rule.
- streams List<String>
- Specifies a list of streams that this data source will be sent to. A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to.
DataCollectionRuleDestinations, DataCollectionRuleDestinationsArgs
- Azure
Monitor DataMetrics Collection Rule Destinations Azure Monitor Metrics - A
azure_monitor_metrics
block as defined above. - Event
Hub DataCollection Rule Destinations Event Hub - One or more
event_hub
blocks as defined below. - Event
Hub DataDirect Collection Rule Destinations Event Hub Direct - One or more
event_hub
blocks as defined below. - Log
Analytics List<DataCollection Rule Destinations Log Analytic> - One or more
log_analytics
blocks as defined below. - Monitor
Accounts List<DataCollection Rule Destinations Monitor Account> - One or more
monitor_account
blocks as defined below. - Storage
Blob List<DataDirects Collection Rule Destinations Storage Blob Direct> - One or more
storage_blob_direct
blocks as defined below. - Storage
Blobs List<DataCollection Rule Destinations Storage Blob> - One or more
storage_blob
blocks as defined below. - Storage
Table List<DataDirects Collection Rule Destinations Storage Table Direct> One or more
storage_table_direct
blocks as defined below.NOTE
event_hub_direct
,storage_blob_direct
, andstorage_table_direct
are only available for rules of kindAgentDirectToStore
.NOTE At least one of
azure_monitor_metrics
,event_hub
,event_hub_direct
,log_analytics
,monitor_account
,storage_blob
,storage_blob_direct
,andstorage_table_direct
blocks must be specified.
- Azure
Monitor DataMetrics Collection Rule Destinations Azure Monitor Metrics - A
azure_monitor_metrics
block as defined above. - Event
Hub DataCollection Rule Destinations Event Hub - One or more
event_hub
blocks as defined below. - Event
Hub DataDirect Collection Rule Destinations Event Hub Direct - One or more
event_hub
blocks as defined below. - Log
Analytics []DataCollection Rule Destinations Log Analytic - One or more
log_analytics
blocks as defined below. - Monitor
Accounts []DataCollection Rule Destinations Monitor Account - One or more
monitor_account
blocks as defined below. - Storage
Blob []DataDirects Collection Rule Destinations Storage Blob Direct - One or more
storage_blob_direct
blocks as defined below. - Storage
Blobs []DataCollection Rule Destinations Storage Blob - One or more
storage_blob
blocks as defined below. - Storage
Table []DataDirects Collection Rule Destinations Storage Table Direct One or more
storage_table_direct
blocks as defined below.NOTE
event_hub_direct
,storage_blob_direct
, andstorage_table_direct
are only available for rules of kindAgentDirectToStore
.NOTE At least one of
azure_monitor_metrics
,event_hub
,event_hub_direct
,log_analytics
,monitor_account
,storage_blob
,storage_blob_direct
,andstorage_table_direct
blocks must be specified.
- azure
Monitor DataMetrics Collection Rule Destinations Azure Monitor Metrics - A
azure_monitor_metrics
block as defined above. - event
Hub DataCollection Rule Destinations Event Hub - One or more
event_hub
blocks as defined below. - event
Hub DataDirect Collection Rule Destinations Event Hub Direct - One or more
event_hub
blocks as defined below. - log
Analytics List<DataCollection Rule Destinations Log Analytic> - One or more
log_analytics
blocks as defined below. - monitor
Accounts List<DataCollection Rule Destinations Monitor Account> - One or more
monitor_account
blocks as defined below. - storage
Blob List<DataDirects Collection Rule Destinations Storage Blob Direct> - One or more
storage_blob_direct
blocks as defined below. - storage
Blobs List<DataCollection Rule Destinations Storage Blob> - One or more
storage_blob
blocks as defined below. - storage
Table List<DataDirects Collection Rule Destinations Storage Table Direct> One or more
storage_table_direct
blocks as defined below.NOTE
event_hub_direct
,storage_blob_direct
, andstorage_table_direct
are only available for rules of kindAgentDirectToStore
.NOTE At least one of
azure_monitor_metrics
,event_hub
,event_hub_direct
,log_analytics
,monitor_account
,storage_blob
,storage_blob_direct
,andstorage_table_direct
blocks must be specified.
- azure
Monitor DataMetrics Collection Rule Destinations Azure Monitor Metrics - A
azure_monitor_metrics
block as defined above. - event
Hub DataCollection Rule Destinations Event Hub - One or more
event_hub
blocks as defined below. - event
Hub DataDirect Collection Rule Destinations Event Hub Direct - One or more
event_hub
blocks as defined below. - log
Analytics DataCollection Rule Destinations Log Analytic[] - One or more
log_analytics
blocks as defined below. - monitor
Accounts DataCollection Rule Destinations Monitor Account[] - One or more
monitor_account
blocks as defined below. - storage
Blob DataDirects Collection Rule Destinations Storage Blob Direct[] - One or more
storage_blob_direct
blocks as defined below. - storage
Blobs DataCollection Rule Destinations Storage Blob[] - One or more
storage_blob
blocks as defined below. - storage
Table DataDirects Collection Rule Destinations Storage Table Direct[] One or more
storage_table_direct
blocks as defined below.NOTE
event_hub_direct
,storage_blob_direct
, andstorage_table_direct
are only available for rules of kindAgentDirectToStore
.NOTE At least one of
azure_monitor_metrics
,event_hub
,event_hub_direct
,log_analytics
,monitor_account
,storage_blob
,storage_blob_direct
,andstorage_table_direct
blocks must be specified.
- azure_
monitor_ Datametrics Collection Rule Destinations Azure Monitor Metrics - A
azure_monitor_metrics
block as defined above. - event_
hub DataCollection Rule Destinations Event Hub - One or more
event_hub
blocks as defined below. - event_
hub_ Datadirect Collection Rule Destinations Event Hub Direct - One or more
event_hub
blocks as defined below. - log_
analytics Sequence[DataCollection Rule Destinations Log Analytic] - One or more
log_analytics
blocks as defined below. - monitor_
accounts Sequence[DataCollection Rule Destinations Monitor Account] - One or more
monitor_account
blocks as defined below. - storage_
blob_ Sequence[Datadirects Collection Rule Destinations Storage Blob Direct] - One or more
storage_blob_direct
blocks as defined below. - storage_
blobs Sequence[DataCollection Rule Destinations Storage Blob] - One or more
storage_blob
blocks as defined below. - storage_
table_ Sequence[Datadirects Collection Rule Destinations Storage Table Direct] One or more
storage_table_direct
blocks as defined below.NOTE
event_hub_direct
,storage_blob_direct
, andstorage_table_direct
are only available for rules of kindAgentDirectToStore
.NOTE At least one of
azure_monitor_metrics
,event_hub
,event_hub_direct
,log_analytics
,monitor_account
,storage_blob
,storage_blob_direct
,andstorage_table_direct
blocks must be specified.
- azure
Monitor Property MapMetrics - A
azure_monitor_metrics
block as defined above. - event
Hub Property Map - One or more
event_hub
blocks as defined below. - event
Hub Property MapDirect - One or more
event_hub
blocks as defined below. - log
Analytics List<Property Map> - One or more
log_analytics
blocks as defined below. - monitor
Accounts List<Property Map> - One or more
monitor_account
blocks as defined below. - storage
Blob List<Property Map>Directs - One or more
storage_blob_direct
blocks as defined below. - storage
Blobs List<Property Map> - One or more
storage_blob
blocks as defined below. - storage
Table List<Property Map>Directs One or more
storage_table_direct
blocks as defined below.NOTE
event_hub_direct
,storage_blob_direct
, andstorage_table_direct
are only available for rules of kindAgentDirectToStore
.NOTE At least one of
azure_monitor_metrics
,event_hub
,event_hub_direct
,log_analytics
,monitor_account
,storage_blob
,storage_blob_direct
,andstorage_table_direct
blocks must be specified.
DataCollectionRuleDestinationsAzureMonitorMetrics, DataCollectionRuleDestinationsAzureMonitorMetricsArgs
- Name string
- The name which should be used for this destination. This name should be unique across all destinations regardless of type within the Data Collection Rule.
- Name string
- The name which should be used for this destination. This name should be unique across all destinations regardless of type within the Data Collection Rule.
- name String
- The name which should be used for this destination. This name should be unique across all destinations regardless of type within the Data Collection Rule.
- name string
- The name which should be used for this destination. This name should be unique across all destinations regardless of type within the Data Collection Rule.
- name str
- The name which should be used for this destination. This name should be unique across all destinations regardless of type within the Data Collection Rule.
- name String
- The name which should be used for this destination. This name should be unique across all destinations regardless of type within the Data Collection Rule.
DataCollectionRuleDestinationsEventHub, DataCollectionRuleDestinationsEventHubArgs
- Event
Hub stringId - The resource ID of the Event Hub.
- Name string
- The name which should be used for this destination. This name should be unique across all destinations regardless of type within the Data Collection Rule.
- Event
Hub stringId - The resource ID of the Event Hub.
- Name string
- The name which should be used for this destination. This name should be unique across all destinations regardless of type within the Data Collection Rule.
- event
Hub StringId - The resource ID of the Event Hub.
- name String
- The name which should be used for this destination. This name should be unique across all destinations regardless of type within the Data Collection Rule.
- event
Hub stringId - The resource ID of the Event Hub.
- name string
- The name which should be used for this destination. This name should be unique across all destinations regardless of type within the Data Collection Rule.
- event_
hub_ strid - The resource ID of the Event Hub.
- name str
- The name which should be used for this destination. This name should be unique across all destinations regardless of type within the Data Collection Rule.
- event
Hub StringId - The resource ID of the Event Hub.
- name String
- The name which should be used for this destination. This name should be unique across all destinations regardless of type within the Data Collection Rule.
DataCollectionRuleDestinationsEventHubDirect, DataCollectionRuleDestinationsEventHubDirectArgs
- Event
Hub stringId - The resource ID of the Event Hub.
- Name string
- The name which should be used for this destination. This name should be unique across all destinations regardless of type within the Data Collection Rule.
- Event
Hub stringId - The resource ID of the Event Hub.
- Name string
- The name which should be used for this destination. This name should be unique across all destinations regardless of type within the Data Collection Rule.
- event
Hub StringId - The resource ID of the Event Hub.
- name String
- The name which should be used for this destination. This name should be unique across all destinations regardless of type within the Data Collection Rule.
- event
Hub stringId - The resource ID of the Event Hub.
- name string
- The name which should be used for this destination. This name should be unique across all destinations regardless of type within the Data Collection Rule.
- event_
hub_ strid - The resource ID of the Event Hub.
- name str
- The name which should be used for this destination. This name should be unique across all destinations regardless of type within the Data Collection Rule.
- event
Hub StringId - The resource ID of the Event Hub.
- name String
- The name which should be used for this destination. This name should be unique across all destinations regardless of type within the Data Collection Rule.
DataCollectionRuleDestinationsLogAnalytic, DataCollectionRuleDestinationsLogAnalyticArgs
- Name string
- The name which should be used for this destination. This name should be unique across all destinations regardless of type within the Data Collection Rule.
- Workspace
Resource stringId - The ID of a Log Analytic Workspace resource.
- Name string
- The name which should be used for this destination. This name should be unique across all destinations regardless of type within the Data Collection Rule.
- Workspace
Resource stringId - The ID of a Log Analytic Workspace resource.
- name String
- The name which should be used for this destination. This name should be unique across all destinations regardless of type within the Data Collection Rule.
- workspace
Resource StringId - The ID of a Log Analytic Workspace resource.
- name string
- The name which should be used for this destination. This name should be unique across all destinations regardless of type within the Data Collection Rule.
- workspace
Resource stringId - The ID of a Log Analytic Workspace resource.
- name str
- The name which should be used for this destination. This name should be unique across all destinations regardless of type within the Data Collection Rule.
- workspace_
resource_ strid - The ID of a Log Analytic Workspace resource.
- name String
- The name which should be used for this destination. This name should be unique across all destinations regardless of type within the Data Collection Rule.
- workspace
Resource StringId - The ID of a Log Analytic Workspace resource.
DataCollectionRuleDestinationsMonitorAccount, DataCollectionRuleDestinationsMonitorAccountArgs
- Monitor
Account stringId - The resource ID of the Monitor Account.
- Name string
- The name which should be used for this destination. This name should be unique across all destinations regardless of type within the Data Collection Rule.
- Monitor
Account stringId - The resource ID of the Monitor Account.
- Name string
- The name which should be used for this destination. This name should be unique across all destinations regardless of type within the Data Collection Rule.
- monitor
Account StringId - The resource ID of the Monitor Account.
- name String
- The name which should be used for this destination. This name should be unique across all destinations regardless of type within the Data Collection Rule.
- monitor
Account stringId - The resource ID of the Monitor Account.
- name string
- The name which should be used for this destination. This name should be unique across all destinations regardless of type within the Data Collection Rule.
- monitor_
account_ strid - The resource ID of the Monitor Account.
- name str
- The name which should be used for this destination. This name should be unique across all destinations regardless of type within the Data Collection Rule.
- monitor
Account StringId - The resource ID of the Monitor Account.
- name String
- The name which should be used for this destination. This name should be unique across all destinations regardless of type within the Data Collection Rule.
DataCollectionRuleDestinationsStorageBlob, DataCollectionRuleDestinationsStorageBlobArgs
- Container
Name string - The Storage Container name.
- Name string
- The name which should be used for this destination. This name should be unique across all destinations regardless of type within the Data Collection Rule.
- Storage
Account stringId - The resource ID of the Storage Account.
- Container
Name string - The Storage Container name.
- Name string
- The name which should be used for this destination. This name should be unique across all destinations regardless of type within the Data Collection Rule.
- Storage
Account stringId - The resource ID of the Storage Account.
- container
Name String - The Storage Container name.
- name String
- The name which should be used for this destination. This name should be unique across all destinations regardless of type within the Data Collection Rule.
- storage
Account StringId - The resource ID of the Storage Account.
- container
Name string - The Storage Container name.
- name string
- The name which should be used for this destination. This name should be unique across all destinations regardless of type within the Data Collection Rule.
- storage
Account stringId - The resource ID of the Storage Account.
- container_
name str - The Storage Container name.
- name str
- The name which should be used for this destination. This name should be unique across all destinations regardless of type within the Data Collection Rule.
- storage_
account_ strid - The resource ID of the Storage Account.
- container
Name String - The Storage Container name.
- name String
- The name which should be used for this destination. This name should be unique across all destinations regardless of type within the Data Collection Rule.
- storage
Account StringId - The resource ID of the Storage Account.
DataCollectionRuleDestinationsStorageBlobDirect, DataCollectionRuleDestinationsStorageBlobDirectArgs
- Container
Name string - The Storage Container name.
- Name string
- The name which should be used for this destination. This name should be unique across all destinations regardless of type within the Data Collection Rule.
- Storage
Account stringId - The resource ID of the Storage Account.
- Container
Name string - The Storage Container name.
- Name string
- The name which should be used for this destination. This name should be unique across all destinations regardless of type within the Data Collection Rule.
- Storage
Account stringId - The resource ID of the Storage Account.
- container
Name String - The Storage Container name.
- name String
- The name which should be used for this destination. This name should be unique across all destinations regardless of type within the Data Collection Rule.
- storage
Account StringId - The resource ID of the Storage Account.
- container
Name string - The Storage Container name.
- name string
- The name which should be used for this destination. This name should be unique across all destinations regardless of type within the Data Collection Rule.
- storage
Account stringId - The resource ID of the Storage Account.
- container_
name str - The Storage Container name.
- name str
- The name which should be used for this destination. This name should be unique across all destinations regardless of type within the Data Collection Rule.
- storage_
account_ strid - The resource ID of the Storage Account.
- container
Name String - The Storage Container name.
- name String
- The name which should be used for this destination. This name should be unique across all destinations regardless of type within the Data Collection Rule.
- storage
Account StringId - The resource ID of the Storage Account.
DataCollectionRuleDestinationsStorageTableDirect, DataCollectionRuleDestinationsStorageTableDirectArgs
- Name string
- The name which should be used for this destination. This name should be unique across all destinations regardless of type within the Data Collection Rule.
- Storage
Account stringId - The resource ID of the Storage Account.
- Table
Name string - The Storage Table name.
- Name string
- The name which should be used for this destination. This name should be unique across all destinations regardless of type within the Data Collection Rule.
- Storage
Account stringId - The resource ID of the Storage Account.
- Table
Name string - The Storage Table name.
- name String
- The name which should be used for this destination. This name should be unique across all destinations regardless of type within the Data Collection Rule.
- storage
Account StringId - The resource ID of the Storage Account.
- table
Name String - The Storage Table name.
- name string
- The name which should be used for this destination. This name should be unique across all destinations regardless of type within the Data Collection Rule.
- storage
Account stringId - The resource ID of the Storage Account.
- table
Name string - The Storage Table name.
- name str
- The name which should be used for this destination. This name should be unique across all destinations regardless of type within the Data Collection Rule.
- storage_
account_ strid - The resource ID of the Storage Account.
- table_
name str - The Storage Table name.
- name String
- The name which should be used for this destination. This name should be unique across all destinations regardless of type within the Data Collection Rule.
- storage
Account StringId - The resource ID of the Storage Account.
- table
Name String - The Storage Table name.
DataCollectionRuleIdentity, DataCollectionRuleIdentityArgs
- Type string
- Specifies the type of Managed Service Identity that should be configured on this Data Collection Rule. Possible values are
SystemAssigned
andUserAssigned
. - Identity
Ids List<string> A list of User Assigned Managed Identity IDs to be assigned to this Data Collection Rule. Currently, up to 1 identity is supported.
NOTE: This is required when
type
is set toUserAssigned
.- Principal
Id string - The Principal ID associated with this Managed Service Identity.
- Tenant
Id string - The Tenant ID associated with this Managed Service Identity.
- Type string
- Specifies the type of Managed Service Identity that should be configured on this Data Collection Rule. Possible values are
SystemAssigned
andUserAssigned
. - Identity
Ids []string A list of User Assigned Managed Identity IDs to be assigned to this Data Collection Rule. Currently, up to 1 identity is supported.
NOTE: This is required when
type
is set toUserAssigned
.- Principal
Id string - The Principal ID associated with this Managed Service Identity.
- Tenant
Id string - The Tenant ID associated with this Managed Service Identity.
- type String
- Specifies the type of Managed Service Identity that should be configured on this Data Collection Rule. Possible values are
SystemAssigned
andUserAssigned
. - identity
Ids List<String> A list of User Assigned Managed Identity IDs to be assigned to this Data Collection Rule. Currently, up to 1 identity is supported.
NOTE: This is required when
type
is set toUserAssigned
.- principal
Id String - The Principal ID associated with this Managed Service Identity.
- tenant
Id String - The Tenant ID associated with this Managed Service Identity.
- type string
- Specifies the type of Managed Service Identity that should be configured on this Data Collection Rule. Possible values are
SystemAssigned
andUserAssigned
. - identity
Ids string[] A list of User Assigned Managed Identity IDs to be assigned to this Data Collection Rule. Currently, up to 1 identity is supported.
NOTE: This is required when
type
is set toUserAssigned
.- principal
Id string - The Principal ID associated with this Managed Service Identity.
- tenant
Id string - The Tenant ID associated with this Managed Service Identity.
- type str
- Specifies the type of Managed Service Identity that should be configured on this Data Collection Rule. Possible values are
SystemAssigned
andUserAssigned
. - identity_
ids Sequence[str] A list of User Assigned Managed Identity IDs to be assigned to this Data Collection Rule. Currently, up to 1 identity is supported.
NOTE: This is required when
type
is set toUserAssigned
.- principal_
id str - The Principal ID associated with this Managed Service Identity.
- tenant_
id str - The Tenant ID associated with this Managed Service Identity.
- type String
- Specifies the type of Managed Service Identity that should be configured on this Data Collection Rule. Possible values are
SystemAssigned
andUserAssigned
. - identity
Ids List<String> A list of User Assigned Managed Identity IDs to be assigned to this Data Collection Rule. Currently, up to 1 identity is supported.
NOTE: This is required when
type
is set toUserAssigned
.- principal
Id String - The Principal ID associated with this Managed Service Identity.
- tenant
Id String - The Tenant ID associated with this Managed Service Identity.
DataCollectionRuleStreamDeclaration, DataCollectionRuleStreamDeclarationArgs
- Columns
List<Data
Collection Rule Stream Declaration Column> - One or more
column
blocks as defined above. - Stream
Name string - The name of the custom stream. This name should be unique across all
stream_declaration
blocks and must begin with a prefix ofCustom-
.
- Columns
[]Data
Collection Rule Stream Declaration Column - One or more
column
blocks as defined above. - Stream
Name string - The name of the custom stream. This name should be unique across all
stream_declaration
blocks and must begin with a prefix ofCustom-
.
- columns
List<Data
Collection Rule Stream Declaration Column> - One or more
column
blocks as defined above. - stream
Name String - The name of the custom stream. This name should be unique across all
stream_declaration
blocks and must begin with a prefix ofCustom-
.
- columns
Data
Collection Rule Stream Declaration Column[] - One or more
column
blocks as defined above. - stream
Name string - The name of the custom stream. This name should be unique across all
stream_declaration
blocks and must begin with a prefix ofCustom-
.
- columns
Sequence[Data
Collection Rule Stream Declaration Column] - One or more
column
blocks as defined above. - stream_
name str - The name of the custom stream. This name should be unique across all
stream_declaration
blocks and must begin with a prefix ofCustom-
.
- columns List<Property Map>
- One or more
column
blocks as defined above. - stream
Name String - The name of the custom stream. This name should be unique across all
stream_declaration
blocks and must begin with a prefix ofCustom-
.
DataCollectionRuleStreamDeclarationColumn, DataCollectionRuleStreamDeclarationColumnArgs
Import
Data Collection Rules can be imported using the resource id
, e.g.
$ pulumi import azure:monitoring/dataCollectionRule:DataCollectionRule example /subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/group1/providers/Microsoft.Insights/dataCollectionRules/rule1
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
azurerm
Terraform Provider.