-
Notifications
You must be signed in to change notification settings - Fork 232
/
azure.mgmt.monitor.v2016_03_01.operations.AlertRulesOperations.yml
204 lines (194 loc) · 7.26 KB
/
azure.mgmt.monitor.v2016_03_01.operations.AlertRulesOperations.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
### YamlMime:PythonClass
uid: azure.mgmt.monitor.v2016_03_01.operations.AlertRulesOperations
name: AlertRulesOperations
fullName: azure.mgmt.monitor.v2016_03_01.operations.AlertRulesOperations
module: azure.mgmt.monitor.v2016_03_01.operations
inheritances:
- builtins.object
summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\
\ you should access the following operations through\n>\n> <xref:azure.mgmt.monitor.v2016_03_01.MonitorManagementClient>'s\n\
>\n> <xref:alert_rules> attribute.\n>"
constructor:
syntax: AlertRulesOperations(*args, **kwargs)
methods:
- uid: azure.mgmt.monitor.v2016_03_01.operations.AlertRulesOperations.create_or_update
name: create_or_update
summary: Creates or updates a classic metric alert rule.
signature: 'create_or_update(resource_group_name: str, rule_name: str, parameters:
_models.AlertRuleResource, *, content_type: str = ''application/json'', **kwargs:
Any) -> _models.AlertRuleResource'
parameters:
- name: resource_group_name
description: 'The name of the resource group. The name is case insensitive.
Required.'
isRequired: true
types:
- <xref:str>
- name: rule_name
description: The name of the rule. Required.
isRequired: true
types:
- <xref:str>
- name: parameters
description: 'The parameters of the rule to create or update. Is either a
AlertRuleResource type or a IO type. Required.'
isRequired: true
types:
- <xref:azure.mgmt.monitor.v2016_03_01.models.AlertRuleResource>
- <xref:typing.IO>
keywordOnlyParameters:
- name: content_type
description: 'Body Parameter content-type. Known values are: ''application/json''.
Default value is None.'
types:
- <xref:str>
- name: cls
description: A custom type or function that will be passed the direct response
types:
- <xref:callable>
return:
description: AlertRuleResource or the result of cls(response)
types:
- <xref:azure.mgmt.monitor.v2016_03_01.models.AlertRuleResource>
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.monitor.v2016_03_01.operations.AlertRulesOperations.delete
name: delete
summary: Deletes a classic metric alert rule.
signature: 'delete(resource_group_name: str, rule_name: str, **kwargs: Any) -> None'
parameters:
- name: resource_group_name
description: 'The name of the resource group. The name is case insensitive.
Required.'
isRequired: true
types:
- <xref:str>
- name: rule_name
description: The name of the rule. Required.
isRequired: true
types:
- <xref:str>
keywordOnlyParameters:
- name: cls
description: A custom type or function that will be passed the direct response
types:
- <xref:callable>
return:
description: None or the result of cls(response)
types:
- <xref:None>
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.monitor.v2016_03_01.operations.AlertRulesOperations.get
name: get
summary: Gets a classic metric alert rule.
signature: 'get(resource_group_name: str, rule_name: str, **kwargs: Any) -> AlertRuleResource'
parameters:
- name: resource_group_name
description: 'The name of the resource group. The name is case insensitive.
Required.'
isRequired: true
types:
- <xref:str>
- name: rule_name
description: The name of the rule. Required.
isRequired: true
types:
- <xref:str>
keywordOnlyParameters:
- name: cls
description: A custom type or function that will be passed the direct response
types:
- <xref:callable>
return:
description: AlertRuleResource or the result of cls(response)
types:
- <xref:azure.mgmt.monitor.v2016_03_01.models.AlertRuleResource>
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.monitor.v2016_03_01.operations.AlertRulesOperations.list_by_resource_group
name: list_by_resource_group
summary: List the classic metric alert rules within a resource group.
signature: 'list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[AlertRuleResource]'
parameters:
- name: resource_group_name
description: 'The name of the resource group. The name is case insensitive.
Required.'
isRequired: true
types:
- <xref:str>
keywordOnlyParameters:
- name: cls
description: A custom type or function that will be passed the direct response
types:
- <xref:callable>
return:
description: An iterator like instance of either AlertRuleResource or the result
of cls(response)
types:
- <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.monitor.v2016_03_01.models.AlertRuleResource>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.monitor.v2016_03_01.operations.AlertRulesOperations.list_by_subscription
name: list_by_subscription
summary: List the classic metric alert rules within a subscription.
signature: 'list_by_subscription(**kwargs: Any) -> Iterable[AlertRuleResource]'
keywordOnlyParameters:
- name: cls
description: A custom type or function that will be passed the direct response
types:
- <xref:callable>
return:
description: An iterator like instance of either AlertRuleResource or the result
of cls(response)
types:
- <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.monitor.v2016_03_01.models.AlertRuleResource>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.monitor.v2016_03_01.operations.AlertRulesOperations.update
name: update
summary: 'Updates an existing classic metric AlertRuleResource. To update other
fields use the
CreateOrUpdate method.'
signature: 'update(resource_group_name: str, rule_name: str, alert_rules_resource:
_models.AlertRuleResourcePatch, *, content_type: str = ''application/json'', **kwargs:
Any) -> _models.AlertRuleResource'
parameters:
- name: resource_group_name
description: 'The name of the resource group. The name is case insensitive.
Required.'
isRequired: true
types:
- <xref:str>
- name: rule_name
description: The name of the rule. Required.
isRequired: true
types:
- <xref:str>
- name: alert_rules_resource
description: 'Parameters supplied to the operation. Is either a
AlertRuleResourcePatch type or a IO type. Required.'
isRequired: true
types:
- <xref:azure.mgmt.monitor.v2016_03_01.models.AlertRuleResourcePatch>
- <xref:typing.IO>
keywordOnlyParameters:
- name: content_type
description: 'Body Parameter content-type. Known values are: ''application/json''.
Default value is None.'
types:
- <xref:str>
- name: cls
description: A custom type or function that will be passed the direct response
types:
- <xref:callable>
return:
description: AlertRuleResource or the result of cls(response)
types:
- <xref:azure.mgmt.monitor.v2016_03_01.models.AlertRuleResource>
exceptions:
- type: azure.core.exceptions.HttpResponseError
attributes:
- uid: azure.mgmt.monitor.v2016_03_01.operations.AlertRulesOperations.models
name: models
signature: models = <module 'azure.mgmt.monitor.v2016_03_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\monitor\\v2016_03_01\\models\\__init__.py'>