DataCollectionRulesOperations Class

Varning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

MonitorManagementClient's

<xref:data_collection_rules> attribute.

Constructor

Python

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.

Python

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 Required	DataCollectionRuleResource or IO The payload. Is either a DataCollectionRuleResource type or a IO type. Default value is None.

Keyword-Only Parameters

Name	Description
content_type	str Body Parameter content-type. Known values are: 'application/json'. Default value is None.
cls	callable A custom type or function that will be passed the direct response

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.

Python

delete(resource_group_name: str, data_collection_rule_name: str, **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.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

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.

Python

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.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

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.

Python

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

Parameters

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

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

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.

Python

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

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

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.

Python

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 Required	ResourceForUpdate or IO The payload. Is either a ResourceForUpdate type or a IO type. Default value is None.

Keyword-Only Parameters

Name	Description
content_type	str Body Parameter content-type. Known values are: 'application/json'. Default value is None.
cls	callable A custom type or function that will be passed the direct response

Returns

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

Exceptions

Type	Description
HttpResponseError

Attributes

models

Python

models = <module 'azure.mgmt.monitor.v2019_11_01_preview.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.10\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv164\\Lib\\site-packages\\azure\\mgmt\\monitor\\v2019_11_01_preview\\models\\__init__.py'>