ScheduledQueryRulesOperations Class

ScheduledQueryRulesOperations 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
ScheduledQueryRulesOperations

Constructor

ScheduledQueryRulesOperations(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_or_update

Creates or updates a scheduled query rule.

delete

Deletes a scheduled query rule.

get

Retrieve an scheduled query rule definition.

list_by_resource_group

Retrieve scheduled query rule definitions in a resource group.

list_by_subscription

Retrieve a scheduled query rule definitions in a subscription.

update

Update a scheduled query rule.

create_or_update

Creates or updates a scheduled query rule.

async create_or_update(resource_group_name: str, rule_name: str, parameters: azure.mgmt.monitor.v2020_05_01_preview.models._models_py3.ScheduledQueryRuleResource, **kwargs: Any) -> azure.mgmt.monitor.v2020_05_01_preview.models._models_py3.ScheduledQueryRuleResource

Parameters

resource_group_name
str
Required

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

rule_name
str
Required

The name of the rule.

parameters
<xref:$>(<xref:python-base-namespace>)ScheduledQueryRuleResource
Required

The parameters of the rule to create or update.

cls
callable

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

Returns

ScheduledQueryRuleResource, or the result of cls(response)

Return type

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

Exceptions

delete

Deletes a scheduled query rule.

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

Parameters

resource_group_name
str
Required

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

rule_name
str
Required

The name of the rule.

cls
callable

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

Returns

None, or the result of cls(response)

Return type

Exceptions

get

Retrieve an scheduled query rule definition.

async get(resource_group_name: str, rule_name: str, **kwargs: Any) -> azure.mgmt.monitor.v2020_05_01_preview.models._models_py3.ScheduledQueryRuleResource

Parameters

resource_group_name
str
Required

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

rule_name
str
Required

The name of the rule.

cls
callable

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

Returns

ScheduledQueryRuleResource, or the result of cls(response)

Return type

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

Exceptions

list_by_resource_group

Retrieve scheduled query rule definitions in a resource group.

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.monitor.v2020_05_01_preview.models._models_py3.ScheduledQueryRuleResourceCollection]

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 ScheduledQueryRuleResourceCollection or the result of cls(response)

Return type

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

Exceptions

list_by_subscription

Retrieve a scheduled query rule definitions in a subscription.

list_by_subscription(**kwargs: Any) -> AsyncIterable[azure.mgmt.monitor.v2020_05_01_preview.models._models_py3.ScheduledQueryRuleResourceCollection]

Parameters

cls
callable

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

Returns

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

Return type

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

Exceptions

update

Update a scheduled query rule.

async update(resource_group_name: str, rule_name: str, parameters: azure.mgmt.monitor.v2020_05_01_preview.models._models_py3.ScheduledQueryRuleResourcePatch, **kwargs: Any) -> azure.mgmt.monitor.v2020_05_01_preview.models._models_py3.ScheduledQueryRuleResource

Parameters

resource_group_name
str
Required

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

rule_name
str
Required

The name of the rule.

parameters
<xref:$>(<xref:python-base-namespace>)ScheduledQueryRuleResourcePatch
Required

The parameters of the rule to update.

cls
callable

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

Returns

ScheduledQueryRuleResource, or the result of cls(response)

Return type

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

Exceptions

Attributes

models

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