ScheduledQueryRulesOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

MonitorManagementClient's

<xref:scheduled_query_rules> attribute.

Inheritance

builtins.object

ScheduledQueryRulesOperations

Constructor

ScheduledQueryRulesOperations(*args, **kwargs)

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.

create_or_update(resource_group_name: str, rule_name: str, parameters: _models.ScheduledQueryRuleResource, *, content_type: str = 'application/json', **kwargs: Any) -> _models.ScheduledQueryRuleResource

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
rule_name Required	str The name of the rule. Required.
parameters Required	ScheduledQueryRuleResource or IO The parameters of the rule to create or update. Is either a ScheduledQueryRuleResource type or a IO type. Required.

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

Exceptions

Type	Description
HttpResponseError

delete

Deletes a scheduled query rule.

delete(resource_group_name: str, 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.
rule_name Required	str The name of the rule. 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

Retrieve an scheduled query rule definition.

get(resource_group_name: str, rule_name: str, **kwargs: Any) -> ScheduledQueryRuleResource

Parameters

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

Keyword-Only Parameters

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

Returns

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

Exceptions

Type	Description
HttpResponseError

list_by_resource_group

Retrieve scheduled query rule definitions in a resource group.

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

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[ScheduledQueryRuleResource]	An iterator like instance of either ScheduledQueryRuleResource or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_subscription

Retrieve a scheduled query rule definitions in a subscription.

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

Keyword-Only Parameters

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

Returns

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

Exceptions

Type	Description
HttpResponseError

update

Update a scheduled query rule.

update(resource_group_name: str, rule_name: str, parameters: _models.ScheduledQueryRuleResourcePatch, *, content_type: str = 'application/json', **kwargs: Any) -> _models.ScheduledQueryRuleResource

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
rule_name Required	str The name of the rule. Required.
parameters Required	ScheduledQueryRuleResourcePatch or IO The parameters of the rule to update. Is either a ScheduledQueryRuleResourcePatch type or a IO type. Required.

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

Exceptions

Type	Description
HttpResponseError

Attributes

models

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