DataCollectionRulesOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

MonitorManagementClient's

<xref:data_collection_rules> attribute.

Constructor

DataCollectionRulesOperations(*args, **kwargs)

Methods

create	Creates or updates a data collection rule. Creates or updates a data collection rule.
delete	Deletes a data collection rule. Deletes a data collection rule.
get	Returns the specified data collection rule. Returns the specified data collection rule.
list_by_resource_group	Lists all data collection rules in the specified resource group. Lists all data collection rules in the specified resource group.
list_by_subscription	Lists all data collection rules in the specified subscription. Lists all data collection rules in the specified subscription.
update	Updates part of a data collection rule. Updates part of a data collection rule.

create

Creates or updates a data collection rule.

Creates or updates a data collection rule.

create(resource_group_name: str, data_collection_rule_name: str, body: _models.DataCollectionRuleResource | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> _models.DataCollectionRuleResource

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
data_collection_rule_name Required	str The name of the data collection rule. The name is case insensitive. Required.
body	DataCollectionRuleResource or IO[bytes] The payload. Is either a DataCollectionRuleResource type or a IO[bytes] type. Default value is None. Default value: None

Returns

Type	Description
DataCollectionRuleResource	DataCollectionRuleResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

delete

Deletes a data collection rule.

Deletes a data collection rule.

delete(resource_group_name: str, data_collection_rule_name: str, delete_associations: bool = False, **kwargs: Any) -> None

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
data_collection_rule_name Required	str The name of the data collection rule. The name is case insensitive. Required.
delete_associations	bool If set to 'true' then all associations of this data collection rule will also be deleted. Default value is False. Default value: False

Returns

Type	Description
None	None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Returns the specified data collection rule.

Returns the specified data collection rule.

get(resource_group_name: str, data_collection_rule_name: str, **kwargs: Any) -> DataCollectionRuleResource

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
data_collection_rule_name Required	str The name of the data collection rule. The name is case insensitive. Required.

Returns

Type	Description
DataCollectionRuleResource	DataCollectionRuleResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_resource_group

Lists all data collection rules in the specified resource group.

Lists all data collection rules in the specified resource group.

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> ItemPaged[DataCollectionRuleResource]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.

Returns

Type	Description
ItemPaged[DataCollectionRuleResource]	An iterator like instance of either DataCollectionRuleResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_subscription

Lists all data collection rules in the specified subscription.

Lists all data collection rules in the specified subscription.

list_by_subscription(**kwargs: Any) -> ItemPaged[DataCollectionRuleResource]

Returns

Type	Description
ItemPaged[DataCollectionRuleResource]	An iterator like instance of either DataCollectionRuleResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

update

Updates part of a data collection rule.

Updates part of a data collection rule.

update(resource_group_name: str, data_collection_rule_name: str, body: _models.ResourceForUpdate | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> _models.DataCollectionRuleResource

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
data_collection_rule_name Required	str The name of the data collection rule. The name is case insensitive. Required.
body	ResourceForUpdate or IO[bytes] The payload. Is either a ResourceForUpdate type or a IO[bytes] type. Default value is None. Default value: None

Returns

Type	Description
DataCollectionRuleResource	DataCollectionRuleResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.monitor.models' from 'C:\\ToolCache\\Python\\3.12.10\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv181\\Lib\\site-packages\\azure\\mgmt\\monitor\\models\\__init__.py'>