Azure Native

Pulumi Official
Package maintained by Pulumi
v1.68.1 published on Monday, Aug 15, 2022 by Pulumi

getDataCollectionRule

Definition of ARM tracked top level resource. API Version: 2019-11-01-preview.

Using getDataCollectionRule

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

function getDataCollectionRule(args: GetDataCollectionRuleArgs, opts?: InvokeOptions): Promise<GetDataCollectionRuleResult>
function getDataCollectionRuleOutput(args: GetDataCollectionRuleOutputArgs, opts?: InvokeOptions): Output<GetDataCollectionRuleResult>
def get_data_collection_rule(data_collection_rule_name: Optional[str] = None,
                             resource_group_name: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetDataCollectionRuleResult
def get_data_collection_rule_output(data_collection_rule_name: Optional[pulumi.Input[str]] = None,
                             resource_group_name: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetDataCollectionRuleResult]
func LookupDataCollectionRule(ctx *Context, args *LookupDataCollectionRuleArgs, opts ...InvokeOption) (*LookupDataCollectionRuleResult, error)
func LookupDataCollectionRuleOutput(ctx *Context, args *LookupDataCollectionRuleOutputArgs, opts ...InvokeOption) LookupDataCollectionRuleResultOutput

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

public static class GetDataCollectionRule 
{
    public static Task<GetDataCollectionRuleResult> InvokeAsync(GetDataCollectionRuleArgs args, InvokeOptions? opts = null)
    public static Output<GetDataCollectionRuleResult> Invoke(GetDataCollectionRuleInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetDataCollectionRuleResult> getDataCollectionRule(GetDataCollectionRuleArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: azure-native:insights:getDataCollectionRule
  Arguments:
    # Arguments dictionary

The following arguments are supported:

DataCollectionRuleName string

The name of the data collection rule. The name is case insensitive.

ResourceGroupName string

The name of the resource group. The name is case insensitive.

DataCollectionRuleName string

The name of the data collection rule. The name is case insensitive.

ResourceGroupName string

The name of the resource group. The name is case insensitive.

dataCollectionRuleName String

The name of the data collection rule. The name is case insensitive.

resourceGroupName String

The name of the resource group. The name is case insensitive.

dataCollectionRuleName string

The name of the data collection rule. The name is case insensitive.

resourceGroupName string

The name of the resource group. The name is case insensitive.

data_collection_rule_name str

The name of the data collection rule. The name is case insensitive.

resource_group_name str

The name of the resource group. The name is case insensitive.

dataCollectionRuleName String

The name of the data collection rule. The name is case insensitive.

resourceGroupName String

The name of the resource group. The name is case insensitive.

getDataCollectionRule Result

The following output properties are available:

Etag string

Resource entity tag (ETag).

Id string

Fully qualified ID of the resource.

ImmutableId string

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

Location string

The geo-location where the resource lives.

Name string

The name of the resource.

ProvisioningState string

The resource provisioning state.

Type string

The type of the resource.

DataFlows List<Pulumi.AzureNative.Insights.Outputs.DataFlowResponse>

The specification of data flows.

DataSources Pulumi.AzureNative.Insights.Outputs.DataCollectionRuleResponseDataSources

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

Description string

Description of the data collection rule.

Destinations Pulumi.AzureNative.Insights.Outputs.DataCollectionRuleResponseDestinations

The specification of destinations.

Kind string

The kind of the resource.

Tags Dictionary<string, string>

Resource tags.

Etag string

Resource entity tag (ETag).

Id string

Fully qualified ID of the resource.

ImmutableId string

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

Location string

The geo-location where the resource lives.

Name string

The name of the resource.

ProvisioningState string

The resource provisioning state.

Type string

The type of the resource.

DataFlows []DataFlowResponse

The specification of data flows.

DataSources DataCollectionRuleResponseDataSources

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

Description string

Description of the data collection rule.

Destinations DataCollectionRuleResponseDestinations

The specification of destinations.

Kind string

The kind of the resource.

Tags map[string]string

Resource tags.

etag String

Resource entity tag (ETag).

id String

Fully qualified ID of the resource.

immutableId String

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

location String

The geo-location where the resource lives.

name String

The name of the resource.

provisioningState String

The resource provisioning state.

type String

The type of the resource.

dataFlows List<DataFlowResponse>

The specification of data flows.

dataSources DataCollectionRuleResponseDataSources

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

description String

Description of the data collection rule.

destinations DataCollectionRuleResponseDestinations

The specification of destinations.

kind String

The kind of the resource.

tags Map<String,String>

Resource tags.

etag string

Resource entity tag (ETag).

id string

Fully qualified ID of the resource.

immutableId string

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

location string

The geo-location where the resource lives.

name string

The name of the resource.

provisioningState string

The resource provisioning state.

type string

The type of the resource.

dataFlows DataFlowResponse[]

The specification of data flows.

dataSources DataCollectionRuleResponseDataSources

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

description string

Description of the data collection rule.

destinations DataCollectionRuleResponseDestinations

The specification of destinations.

kind string

The kind of the resource.

tags {[key: string]: string}

Resource tags.

etag str

Resource entity tag (ETag).

id str

Fully qualified ID of the resource.

immutable_id str

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

location str

The geo-location where the resource lives.

name str

The name of the resource.

provisioning_state str

The resource provisioning state.

type str

The type of the resource.

data_flows Sequence[DataFlowResponse]

The specification of data flows.

data_sources DataCollectionRuleResponseDataSources

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

description str

Description of the data collection rule.

destinations DataCollectionRuleResponseDestinations

The specification of destinations.

kind str

The kind of the resource.

tags Mapping[str, str]

Resource tags.

etag String

Resource entity tag (ETag).

id String

Fully qualified ID of the resource.

immutableId String

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

location String

The geo-location where the resource lives.

name String

The name of the resource.

provisioningState String

The resource provisioning state.

type String

The type of the resource.

dataFlows List<Property Map>

The specification of data flows.

dataSources Property Map

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

description String

Description of the data collection rule.

destinations Property Map

The specification of destinations.

kind String

The kind of the resource.

tags Map<String>

Resource tags.

Supporting Types

DataCollectionRuleResponseDataSources

Extensions List<Pulumi.AzureNative.Insights.Inputs.ExtensionDataSourceResponse>

The list of Azure VM extension data source configurations.

PerformanceCounters List<Pulumi.AzureNative.Insights.Inputs.PerfCounterDataSourceResponse>

The list of performance counter data source configurations.

Syslog List<Pulumi.AzureNative.Insights.Inputs.SyslogDataSourceResponse>

The list of Syslog data source configurations.

WindowsEventLogs List<Pulumi.AzureNative.Insights.Inputs.WindowsEventLogDataSourceResponse>

The list of Windows Event Log data source configurations.

Extensions []ExtensionDataSourceResponse

The list of Azure VM extension data source configurations.

PerformanceCounters []PerfCounterDataSourceResponse

The list of performance counter data source configurations.

Syslog []SyslogDataSourceResponse

The list of Syslog data source configurations.

WindowsEventLogs []WindowsEventLogDataSourceResponse

The list of Windows Event Log data source configurations.

extensions List<ExtensionDataSourceResponse>

The list of Azure VM extension data source configurations.

performanceCounters List<PerfCounterDataSourceResponse>

The list of performance counter data source configurations.

syslog List<SyslogDataSourceResponse>

The list of Syslog data source configurations.

windowsEventLogs List<WindowsEventLogDataSourceResponse>

The list of Windows Event Log data source configurations.

extensions ExtensionDataSourceResponse[]

The list of Azure VM extension data source configurations.

performanceCounters PerfCounterDataSourceResponse[]

The list of performance counter data source configurations.

syslog SyslogDataSourceResponse[]

The list of Syslog data source configurations.

windowsEventLogs WindowsEventLogDataSourceResponse[]

The list of Windows Event Log data source configurations.

extensions Sequence[ExtensionDataSourceResponse]

The list of Azure VM extension data source configurations.

performance_counters Sequence[PerfCounterDataSourceResponse]

The list of performance counter data source configurations.

syslog Sequence[SyslogDataSourceResponse]

The list of Syslog data source configurations.

windows_event_logs Sequence[WindowsEventLogDataSourceResponse]

The list of Windows Event Log data source configurations.

extensions List<Property Map>

The list of Azure VM extension data source configurations.

performanceCounters List<Property Map>

The list of performance counter data source configurations.

syslog List<Property Map>

The list of Syslog data source configurations.

windowsEventLogs List<Property Map>

The list of Windows Event Log data source configurations.

DataCollectionRuleResponseDestinations

azureMonitorMetrics Property Map

Azure Monitor Metrics destination.

logAnalytics List<Property Map>

List of Log Analytics destinations.

DataFlowResponse

Destinations List<string>

List of destinations for this data flow.

Streams List<string>

List of streams for this data flow.

Destinations []string

List of destinations for this data flow.

Streams []string

List of streams for this data flow.

destinations List<String>

List of destinations for this data flow.

streams List<String>

List of streams for this data flow.

destinations string[]

List of destinations for this data flow.

streams string[]

List of streams for this data flow.

destinations Sequence[str]

List of destinations for this data flow.

streams Sequence[str]

List of streams for this data flow.

destinations List<String>

List of destinations for this data flow.

streams List<String>

List of streams for this data flow.

DestinationsSpecResponseAzureMonitorMetrics

Name string

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

Name string

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

name String

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

name string

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

name str

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

name String

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

ExtensionDataSourceResponse

ExtensionName string

The name of the VM extension.

ExtensionSettings object

The extension settings. The format is specific for particular extension.

InputDataSources List<string>

The list of data sources this extension needs data from.

Name string

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

Streams List<string>

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.

ExtensionName string

The name of the VM extension.

ExtensionSettings interface{}

The extension settings. The format is specific for particular extension.

InputDataSources []string

The list of data sources this extension needs data from.

Name string

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

Streams []string

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.

extensionName String

The name of the VM extension.

extensionSettings Object

The extension settings. The format is specific for particular extension.

inputDataSources List<String>

The list of data sources this extension needs data from.

name String

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

streams List<String>

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.

extensionName string

The name of the VM extension.

extensionSettings any

The extension settings. The format is specific for particular extension.

inputDataSources string[]

The list of data sources this extension needs data from.

name string

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

streams string[]

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.

extension_name str

The name of the VM extension.

extension_settings Any

The extension settings. The format is specific for particular extension.

input_data_sources Sequence[str]

The list of data sources this extension needs data from.

name str

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

streams Sequence[str]

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.

extensionName String

The name of the VM extension.

extensionSettings Any

The extension settings. The format is specific for particular extension.

inputDataSources List<String>

The list of data sources this extension needs data from.

name String

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

streams List<String>

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.

LogAnalyticsDestinationResponse

WorkspaceId string

The Customer ID of the Log Analytics workspace.

Name string

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

WorkspaceResourceId string

The resource ID of the Log Analytics workspace.

WorkspaceId string

The Customer ID of the Log Analytics workspace.

Name string

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

WorkspaceResourceId string

The resource ID of the Log Analytics workspace.

workspaceId String

The Customer ID of the Log Analytics workspace.

name String

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

workspaceResourceId String

The resource ID of the Log Analytics workspace.

workspaceId string

The Customer ID of the Log Analytics workspace.

name string

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

workspaceResourceId string

The resource ID of the Log Analytics workspace.

workspace_id str

The Customer ID of the Log Analytics workspace.

name str

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

workspace_resource_id str

The resource ID of the Log Analytics workspace.

workspaceId String

The Customer ID of the Log Analytics workspace.

name String

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

workspaceResourceId String

The resource ID of the Log Analytics workspace.

PerfCounterDataSourceResponse

CounterSpecifiers List<string>

A list of specifier names of the performance counters you want to collect. Use a wildcard (*) to collect a counter for all instances. To get a list of performance counters on Windows, run the command 'typeperf'.

Name string

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

SamplingFrequencyInSeconds int

The number of seconds between consecutive counter measurements (samples).

Streams List<string>

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.

CounterSpecifiers []string

A list of specifier names of the performance counters you want to collect. Use a wildcard (*) to collect a counter for all instances. To get a list of performance counters on Windows, run the command 'typeperf'.

Name string

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

SamplingFrequencyInSeconds int

The number of seconds between consecutive counter measurements (samples).

Streams []string

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.

counterSpecifiers List<String>

A list of specifier names of the performance counters you want to collect. Use a wildcard (*) to collect a counter for all instances. To get a list of performance counters on Windows, run the command 'typeperf'.

name String

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

samplingFrequencyInSeconds Integer

The number of seconds between consecutive counter measurements (samples).

streams List<String>

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.

counterSpecifiers string[]

A list of specifier names of the performance counters you want to collect. Use a wildcard (*) to collect a counter for all instances. To get a list of performance counters on Windows, run the command 'typeperf'.

name string

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

samplingFrequencyInSeconds number

The number of seconds between consecutive counter measurements (samples).

streams string[]

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.

counter_specifiers Sequence[str]

A list of specifier names of the performance counters you want to collect. Use a wildcard (*) to collect a counter for all instances. To get a list of performance counters on Windows, run the command 'typeperf'.

name str

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

sampling_frequency_in_seconds int

The number of seconds between consecutive counter measurements (samples).

streams Sequence[str]

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.

counterSpecifiers List<String>

A list of specifier names of the performance counters you want to collect. Use a wildcard (*) to collect a counter for all instances. To get a list of performance counters on Windows, run the command 'typeperf'.

name String

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

samplingFrequencyInSeconds Number

The number of seconds between consecutive counter measurements (samples).

streams List<String>

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.

SyslogDataSourceResponse

FacilityNames List<string>

The list of facility names.

LogLevels List<string>

The log levels to collect.

Name string

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

Streams List<string>

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.

FacilityNames []string

The list of facility names.

LogLevels []string

The log levels to collect.

Name string

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

Streams []string

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.

facilityNames List<String>

The list of facility names.

logLevels List<String>

The log levels to collect.

name String

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

streams List<String>

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.

facilityNames string[]

The list of facility names.

logLevels string[]

The log levels to collect.

name string

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

streams string[]

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.

facility_names Sequence[str]

The list of facility names.

log_levels Sequence[str]

The log levels to collect.

name str

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

streams Sequence[str]

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.

facilityNames List<String>

The list of facility names.

logLevels List<String>

The log levels to collect.

name String

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

streams List<String>

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.

WindowsEventLogDataSourceResponse

Name string

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

Streams List<string>

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.

XPathQueries List<string>

A list of Windows Event Log queries in XPATH format.

Name string

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

Streams []string

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.

XPathQueries []string

A list of Windows Event Log queries in XPATH format.

name String

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

streams List<String>

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.

xPathQueries List<String>

A list of Windows Event Log queries in XPATH format.

name string

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

streams string[]

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.

xPathQueries string[]

A list of Windows Event Log queries in XPATH format.

name str

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

streams Sequence[str]

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.

x_path_queries Sequence[str]

A list of Windows Event Log queries in XPATH format.

name String

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

streams List<String>

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.

xPathQueries List<String>

A list of Windows Event Log queries in XPATH format.

Package Details

Repository
https://github.com/pulumi/pulumi-azure-native
License
Apache-2.0