DataCollectionRulesOperations Class

DataCollectionRulesOperations async operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance

builtins.object

DataCollectionRulesOperations

Constructor

DataCollectionRulesOperations(client, config, serializer, deserializer)

Parameters

client

Required

Client for service requests.

config

Required

Configuration of service client.

serializer

Required

An object model serializer.

deserializer

Required

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

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.

async create(resource_group_name: str, data_collection_rule_name: str, body: Optional[azure.mgmt.monitor.v2021_04_01.models._models_py3.DataCollectionRuleResource] = None, **kwargs: Any) -> azure.mgmt.monitor.v2021_04_01.models._models_py3.DataCollectionRuleResource

Parameters

resource_group_name

str

Required

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

data_collection_rule_name

str

Required

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

body

<xref:$>(<xref:python-base-namespace>)DataCollectionRuleResource

Required

The payload.

cls

callable

A custom type or function that will be passed the direct response

Returns

DataCollectionRuleResource, or the result of cls(response)

Return type

<xref:$>(<xref:python-base-namespace>)DataCollectionRuleResource

Exceptions

HttpResponseError

delete

Deletes a data collection rule.

Deletes a data collection rule.

async delete(resource_group_name: str, data_collection_rule_name: str, **kwargs: Any) -> None

Parameters

resource_group_name

str

Required

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

data_collection_rule_name

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

get

Returns the specified data collection rule.

Returns the specified data collection rule.

async get(resource_group_name: str, data_collection_rule_name: str, **kwargs: Any) -> azure.mgmt.monitor.v2021_04_01.models._models_py3.DataCollectionRuleResource

Parameters

resource_group_name

str

Required

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

data_collection_rule_name

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

DataCollectionRuleResource, or the result of cls(response)

Return type

<xref:$>(<xref:python-base-namespace>)DataCollectionRuleResource

Exceptions

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) -> AsyncIterable[azure.mgmt.monitor.v2021_04_01.models._models_py3.DataCollectionRuleResourceListResult]

Parameters

resource_group_name

str

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either DataCollectionRuleResourceListResult or the result of cls(response)

Return type

AsyncItemPaged[<xref:$>(<xref:python-base-namespace>)DataCollectionRuleResourceListResult]

Exceptions

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) -> AsyncIterable[azure.mgmt.monitor.v2021_04_01.models._models_py3.DataCollectionRuleResourceListResult]

Parameters

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either DataCollectionRuleResourceListResult or the result of cls(response)

Return type

AsyncItemPaged[<xref:$>(<xref:python-base-namespace>)DataCollectionRuleResourceListResult]

Exceptions

HttpResponseError

update

Updates part of a data collection rule.

Updates part of a data collection rule.

async update(resource_group_name: str, data_collection_rule_name: str, body: Optional[azure.mgmt.monitor.v2021_04_01.models._models_py3.ResourceForUpdate] = None, **kwargs: Any) -> azure.mgmt.monitor.v2021_04_01.models._models_py3.DataCollectionRuleResource

Parameters

resource_group_name

str

Required

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

data_collection_rule_name

str

Required

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

body

<xref:$>(<xref:python-base-namespace>)ResourceForUpdate

Required

The payload.

cls

callable

A custom type or function that will be passed the direct response

Returns

DataCollectionRuleResource, or the result of cls(response)

Return type

<xref:$>(<xref:python-base-namespace>)DataCollectionRuleResource

Exceptions

HttpResponseError

Attributes

models

models = <module 'azure.mgmt.monitor.v2021_04_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\monitor\\v2021_04_01\\models\\__init__.py'>