-
Notifications
You must be signed in to change notification settings - Fork 234
/
azure.mgmt.devtestlabs.operations.FormulasOperations.yml
250 lines (245 loc) · 7.9 KB
/
azure.mgmt.devtestlabs.operations.FormulasOperations.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
### YamlMime:PythonClass
uid: azure.mgmt.devtestlabs.operations.FormulasOperations
name: FormulasOperations
fullName: azure.mgmt.devtestlabs.operations.FormulasOperations
module: azure.mgmt.devtestlabs.operations
inheritances:
- builtins.object
summary: 'FormulasOperations 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: FormulasOperations(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.devtestlabs.operations.FormulasOperations.begin_create_or_update
name: begin_create_or_update
summary: Create or replace an existing formula. This operation can take a while
to complete.
signature: 'begin_create_or_update(resource_group_name: str, lab_name: str, name:
str, formula: ''_models.Formula'', **kwargs: Any) -> LROPoller[''_models.Formula'']'
parameters:
- name: resource_group_name
description: The name of the resource group.
isRequired: true
types:
- <xref:str>
- name: lab_name
description: The name of the lab.
isRequired: true
types:
- <xref:str>
- name: name
description: The name of the formula.
isRequired: true
types:
- <xref:str>
- name: formula
description: A formula for creating a VM, specifying an image base and other parameters.
isRequired: true
types:
- <xref:azure.mgmt.devtestlabs.models.Formula>
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: 'True for ARMPolling, False for no polling, or a
polling object for 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 Formula or the result
of cls(response)
types:
- <xref:azure.core.polling.LROPoller>[<xref:azure.mgmt.devtestlabs.models.Formula>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.devtestlabs.operations.FormulasOperations.delete
name: delete
summary: Delete formula.
signature: 'delete(resource_group_name: str, lab_name: str, name: str, **kwargs:
Any) -> None'
parameters:
- name: resource_group_name
description: The name of the resource group.
isRequired: true
types:
- <xref:str>
- name: lab_name
description: The name of the lab.
isRequired: true
types:
- <xref:str>
- name: name
description: The name of the formula.
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.devtestlabs.operations.FormulasOperations.get
name: get
summary: Get formula.
signature: 'get(resource_group_name: str, lab_name: str, name: str, expand: str
| None = None, **kwargs: Any) -> _models.Formula'
parameters:
- name: resource_group_name
description: The name of the resource group.
isRequired: true
types:
- <xref:str>
- name: lab_name
description: The name of the lab.
isRequired: true
types:
- <xref:str>
- name: name
description: The name of the formula.
isRequired: true
types:
- <xref:str>
- name: expand
description: 'Specify the $expand query. Example: ''properties($select=description)''.'
defaultValue: None
types:
- <xref:str>
keywordOnlyParameters:
- name: cls
description: A custom type or function that will be passed the direct response
types:
- <xref:callable>
return:
description: Formula, or the result of cls(response)
types:
- <xref:azure.mgmt.devtestlabs.models.Formula>
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.devtestlabs.operations.FormulasOperations.list
name: list
summary: List formulas in a given lab.
signature: 'list(resource_group_name: str, lab_name: str, expand: str | None = None,
filter: str | None = None, top: int | None = None, orderby: str | None = None,
**kwargs: Any) -> Iterable[''_models.FormulaList'']'
parameters:
- name: resource_group_name
description: The name of the resource group.
isRequired: true
types:
- <xref:str>
- name: lab_name
description: The name of the lab.
isRequired: true
types:
- <xref:str>
- name: expand
description: 'Specify the $expand query. Example: ''properties($select=description)''.'
defaultValue: None
types:
- <xref:str>
- name: filter
description: 'The filter to apply to the operation. Example: ''$filter=contains(name,''myName'').'
defaultValue: None
types:
- <xref:str>
- name: top
description: 'The maximum number of resources to return from the operation. Example:
''$top=10''.'
defaultValue: None
types:
- <xref:int>
- name: orderby
description: 'The ordering expression for the results, using OData notation. Example:
''$orderby=name desc''.'
defaultValue: None
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 FormulaList or the result of
cls(response)
types:
- <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.devtestlabs.models.FormulaList>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.devtestlabs.operations.FormulasOperations.update
name: update
summary: Allows modifying tags of formulas. All other properties will be ignored.
signature: 'update(resource_group_name: str, lab_name: str, name: str, formula:
''_models.FormulaFragment'', **kwargs: Any) -> _models.Formula'
parameters:
- name: resource_group_name
description: The name of the resource group.
isRequired: true
types:
- <xref:str>
- name: lab_name
description: The name of the lab.
isRequired: true
types:
- <xref:str>
- name: name
description: The name of the formula.
isRequired: true
types:
- <xref:str>
- name: formula
description: A formula for creating a VM, specifying an image base and other parameters.
isRequired: true
types:
- <xref:azure.mgmt.devtestlabs.models.FormulaFragment>
keywordOnlyParameters:
- name: cls
description: A custom type or function that will be passed the direct response
types:
- <xref:callable>
return:
description: Formula, or the result of cls(response)
types:
- <xref:azure.mgmt.devtestlabs.models.Formula>
exceptions:
- type: azure.core.exceptions.HttpResponseError
attributes:
- uid: azure.mgmt.devtestlabs.operations.FormulasOperations.models
name: models
signature: models = <module 'azure.mgmt.devtestlabs.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\devtestlabs\\models\\__init__.py'>