-
Notifications
You must be signed in to change notification settings - Fork 240
/
azure.mgmt.sql.operations.WorkloadClassifiersOperations.yml
260 lines (247 loc) · 8.71 KB
/
azure.mgmt.sql.operations.WorkloadClassifiersOperations.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
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
### YamlMime:PythonClass
uid: azure.mgmt.sql.operations.WorkloadClassifiersOperations
name: WorkloadClassifiersOperations
fullName: azure.mgmt.sql.operations.WorkloadClassifiersOperations
module: azure.mgmt.sql.operations
inheritances:
- builtins.object
summary: 'WorkloadClassifiersOperations 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.'
constructor:
syntax: WorkloadClassifiersOperations(client, config, serializer, deserializer)
parameters:
- name: client
description: Client for service requests.
isRequired: true
- name: config
description: Configuration of service client.
isRequired: true
- name: serializer
description: An object model serializer.
isRequired: true
- name: deserializer
description: An object model deserializer.
isRequired: true
variables:
- description: Alias to model classes used in this operation group.
name: models
methods:
- uid: azure.mgmt.sql.operations.WorkloadClassifiersOperations.begin_create_or_update
name: begin_create_or_update
summary: Creates or updates a workload classifier.
signature: 'begin_create_or_update(resource_group_name: str, server_name: str, database_name:
str, workload_group_name: str, workload_classifier_name: str, parameters: ''_models.WorkloadClassifier'',
**kwargs: Any) -> LROPoller[''_models.WorkloadClassifier'']'
parameters:
- name: resource_group_name
description: 'The name of the resource group that contains the resource. You can
obtain this value from the Azure Resource Manager API or the portal.'
isRequired: true
types:
- <xref:str>
- name: server_name
description: The name of the server.
isRequired: true
types:
- <xref:str>
- name: database_name
description: The name of the database.
isRequired: true
types:
- <xref:str>
- name: workload_group_name
description: 'The name of the workload group from which to receive the classifier
from.'
isRequired: true
types:
- <xref:str>
- name: workload_classifier_name
description: The name of the workload classifier to create/update.
isRequired: true
types:
- <xref:str>
- name: parameters
description: The properties of the workload classifier.
isRequired: true
types:
- <xref:azure.mgmt.sql.models.WorkloadClassifier>
keywordOnlyParameters:
- name: cls
description: A custom type or function that will be passed the direct response
types:
- <xref:callable>
- name: continuation_token
description: A continuation token to restart a poller from a saved state.
types:
- <xref:str>
- name: polling
description: 'By default, your polling method will be ARMPolling.
Pass in False for this operation to not poll, or pass in your own initialized
polling object for a personal polling strategy.'
types:
- <xref:bool>
- <xref:azure.core.polling.PollingMethod>
- name: polling_interval
description: Default waiting time between two polls for LRO operations if no Retry-After
header is present.
types:
- <xref:int>
return:
description: An instance of LROPoller that returns either WorkloadClassifier or
the result of cls(response)
types:
- <xref:azure.core.polling.LROPoller>[<xref:azure.mgmt.sql.models.WorkloadClassifier>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.sql.operations.WorkloadClassifiersOperations.begin_delete
name: begin_delete
summary: Deletes a workload classifier.
signature: 'begin_delete(resource_group_name: str, server_name: str, database_name:
str, workload_group_name: str, workload_classifier_name: str, **kwargs: Any) ->
LROPoller[None]'
parameters:
- name: resource_group_name
description: 'The name of the resource group that contains the resource. You can
obtain this value from the Azure Resource Manager API or the portal.'
isRequired: true
types:
- <xref:str>
- name: server_name
description: The name of the server.
isRequired: true
types:
- <xref:str>
- name: database_name
description: The name of the database.
isRequired: true
types:
- <xref:str>
- name: workload_group_name
description: 'The name of the workload group from which to receive the classifier
from.'
isRequired: true
types:
- <xref:str>
- name: workload_classifier_name
description: The name of the workload classifier to delete.
isRequired: true
types:
- <xref:str>
keywordOnlyParameters:
- name: cls
description: A custom type or function that will be passed the direct response
types:
- <xref:callable>
- name: continuation_token
description: A continuation token to restart a poller from a saved state.
types:
- <xref:str>
- name: polling
description: 'By default, your polling method will be ARMPolling.
Pass in False for this operation to not poll, or pass in your own initialized
polling object for a personal polling strategy.'
types:
- <xref:bool>
- <xref:azure.core.polling.PollingMethod>
- name: polling_interval
description: Default waiting time between two polls for LRO operations if no Retry-After
header is present.
types:
- <xref:int>
return:
description: An instance of LROPoller that returns either None or the result of
cls(response)
types:
- <xref:azure.core.polling.LROPoller>[<xref:None>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.sql.operations.WorkloadClassifiersOperations.get
name: get
summary: Gets a workload classifier.
signature: 'get(resource_group_name: str, server_name: str, database_name: str,
workload_group_name: str, workload_classifier_name: str, **kwargs: Any) -> _models.WorkloadClassifier'
parameters:
- name: resource_group_name
description: 'The name of the resource group that contains the resource. You can
obtain this value from the Azure Resource Manager API or the portal.'
isRequired: true
types:
- <xref:str>
- name: server_name
description: The name of the server.
isRequired: true
types:
- <xref:str>
- name: database_name
description: The name of the database.
isRequired: true
types:
- <xref:str>
- name: workload_group_name
description: 'The name of the workload group from which to receive the classifier
from.'
isRequired: true
types:
- <xref:str>
- name: workload_classifier_name
description: The name of the workload classifier.
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: WorkloadClassifier, or the result of cls(response)
types:
- <xref:azure.mgmt.sql.models.WorkloadClassifier>
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.sql.operations.WorkloadClassifiersOperations.list_by_workload_group
name: list_by_workload_group
summary: Gets the list of workload classifiers for a workload group.
signature: 'list_by_workload_group(resource_group_name: str, server_name: str, database_name:
str, workload_group_name: str, **kwargs: Any) -> Iterable[''_models.WorkloadClassifierListResult'']'
parameters:
- name: resource_group_name
description: 'The name of the resource group that contains the resource. You can
obtain this value from the Azure Resource Manager API or the portal.'
isRequired: true
types:
- <xref:str>
- name: server_name
description: The name of the server.
isRequired: true
types:
- <xref:str>
- name: database_name
description: The name of the database.
isRequired: true
types:
- <xref:str>
- name: workload_group_name
description: 'The name of the workload group from which to receive the
classifiers from.'
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 WorkloadClassifierListResult
or the result of cls(response)
types:
- <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.sql.models.WorkloadClassifierListResult>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
attributes:
- uid: azure.mgmt.sql.operations.WorkloadClassifiersOperations.models
name: models
signature: models = <module 'azure.mgmt.sql.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\sql\\models\\__init__.py'>