DataCollectionRuleResource Class

Definition of ARM tracked top level resource.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Constructor

DataCollectionRuleResource(*, location: str, tags: Dict[str, str] | None = None, kind: str | _models.KnownDataCollectionRuleResourceKind | None = None, identity: _models.DataCollectionRuleResourceIdentity | None = None, description: str | None = None, data_collection_endpoint_id: str | None = None, references: _models.DataCollectionRuleReferences | None = None, agent_settings: _models.DataCollectionRuleAgentSettings | None = None, stream_declarations: Dict[str, _models.StreamDeclaration] | None = None, data_sources: _models.DataCollectionRuleDataSources | None = None, destinations: _models.DataCollectionRuleDestinations | None = None, data_flows: List[_models.DataFlow] | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
location	str The geo-location where the resource lives. Required.
tags	dict[str, str] Resource tags. Default value: None
kind	str or KnownDataCollectionRuleResourceKind The kind of the resource. Known values are: "Linux" and "Windows". Default value: None
identity	DataCollectionRuleResourceIdentity Managed service identity of the resource. Default value: None
description	str Description of the data collection rule. Default value: None
data_collection_endpoint_id	str The resource ID of the data collection endpoint that this rule can be used with. Default value: None
references	DataCollectionRuleReferences Defines all the references that may be used in other sections of the DCR. Default value: None
agent_settings	DataCollectionRuleAgentSettings Agent settings used to modify agent behavior on a given host. Default value: None
stream_declarations	dict[str, StreamDeclaration] Declaration of custom streams used in this rule. Default value: None
data_sources	DataCollectionRuleDataSources The specification of data sources. This property is optional and can be omitted if the rule is meant to be used via direct calls to the provisioned endpoint. Default value: None
destinations	DataCollectionRuleDestinations The specification of destinations. Default value: None
data_flows	list[DataFlow] The specification of data flows. Default value: None

Variables

Name	Description
location	str The geo-location where the resource lives. Required.
tags	dict[str, str] Resource tags.
kind	str or KnownDataCollectionRuleResourceKind The kind of the resource. Known values are: "Linux" and "Windows".
identity	DataCollectionRuleResourceIdentity Managed service identity of the resource.
id	str Fully qualified ID of the resource.
name	str The name of the resource.
type	str The type of the resource.
etag	str Resource entity tag (ETag).
system_data	DataCollectionRuleResourceSystemData Metadata pertaining to creation and last modification of the resource.
description	str Description of the data collection rule.
immutable_id	str The immutable ID of this data collection rule. This property is READ-ONLY.
data_collection_endpoint_id	str The resource ID of the data collection endpoint that this rule can be used with.
metadata	DataCollectionRuleMetadata Metadata about the resource.
endpoints	DataCollectionRuleEndpoints Defines the ingestion endpoints to send data to via this rule.
references	DataCollectionRuleReferences Defines all the references that may be used in other sections of the DCR.
agent_settings	DataCollectionRuleAgentSettings Agent settings used to modify agent behavior on a given host.
stream_declarations	dict[str, StreamDeclaration] Declaration of custom streams used in this rule.
data_sources	DataCollectionRuleDataSources The specification of data sources. This property is optional and can be omitted if the rule is meant to be used via direct calls to the provisioned endpoint.
destinations	DataCollectionRuleDestinations The specification of destinations.
data_flows	list[DataFlow] The specification of data flows.
provisioning_state	str or KnownDataCollectionRuleProvisioningState The resource provisioning state. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Canceled", and "Failed".