@@ -5,60 +5,50 @@ fullName: azure.mgmt.appplatform.v2020_07_01.aio.operations.AppsOperations
5
5
module : azure.mgmt.appplatform.v2020_07_01.aio.operations
6
6
inheritances :
7
7
- builtins.object
8
- summary : ' AppsOperations async operations.
9
-
10
-
11
- You should not instantiate this class directly. Instead, you should create a Client
12
- instance that
13
-
14
- instantiates it for you and attaches it as an attribute.'
8
+ summary : " > [!WARNING]\n > DO NOT instantiate this class directly.\n >\n > \n >\n > Instead,\
9
+ \ you should access the following operations through\n >\n > <xref:azure.mgmt.appplatform.v2020_07_01.aio.AppPlatformManagementClient>'s\n \
10
+ >\n > <xref:apps> attribute.\n >"
15
11
constructor :
16
- syntax : AppsOperations(client, config, serializer, deserializer)
17
- parameters :
18
- - name : client
19
- description : Client for service requests.
20
- isRequired : true
21
- - name : config
22
- description : Configuration of service client.
23
- isRequired : true
24
- - name : serializer
25
- description : An object model serializer.
26
- isRequired : true
27
- - name : deserializer
28
- description : An object model deserializer.
29
- isRequired : true
30
- variables :
31
- - description : Alias to model classes used in this operation group.
32
- name : models
12
+ syntax : AppsOperations(*args, **kwargs)
33
13
methods :
34
14
- uid : azure.mgmt.appplatform.v2020_07_01.aio.operations.AppsOperations.begin_create_or_update
35
15
name : begin_create_or_update
36
16
summary : Create a new App or update an exiting App.
37
17
signature : ' async begin_create_or_update(resource_group_name: str, service_name:
38
- str, app_name: str, app_resource: AppResource, **kwargs: Any) -> AsyncLROPoller[AppResource]'
18
+ str, app_name: str, app_resource: _models.AppResource, *, content_type: str =
19
+ '' application/json'' , **kwargs: Any) -> AsyncLROPoller[_models.AppResource]'
39
20
parameters :
40
21
- name : resource_group_name
41
22
description : ' The name of the resource group that contains the resource. You can
42
23
43
- obtain this value from the Azure Resource Manager API or the portal.'
24
+ obtain this value from the Azure Resource Manager API or the portal. Required. '
44
25
isRequired : true
45
26
types :
46
27
- <xref:str>
47
28
- name : service_name
48
- description : The name of the Service resource.
29
+ description : The name of the Service resource. Required.
49
30
isRequired : true
50
31
types :
51
32
- <xref:str>
52
33
- name : app_name
53
- description : The name of the App resource.
34
+ description : The name of the App resource. Required.
54
35
isRequired : true
55
36
types :
56
37
- <xref:str>
57
38
- name : app_resource
58
- description : Parameters for the create or update operation.
39
+ description : ' Parameters for the create or update operation. Is either a AppResource
40
+
41
+ type or a IO type. Required.'
59
42
isRequired : true
60
43
types :
61
44
- <xref:azure.mgmt.appplatform.v2020_07_01.models.AppResource>
45
+ - <xref:IO>
46
+ - name : content_type
47
+ description : ' Body Parameter content-type. Known values are: '' application/json'' .
48
+
49
+ Default value is None.'
50
+ types :
51
+ - <xref:str>
62
52
- name : cls
63
53
description : A custom type or function that will be passed the direct response
64
54
types :
@@ -102,17 +92,17 @@ methods:
102
92
- name : resource_group_name
103
93
description : ' The name of the resource group that contains the resource. You can
104
94
105
- obtain this value from the Azure Resource Manager API or the portal.'
95
+ obtain this value from the Azure Resource Manager API or the portal. Required. '
106
96
isRequired : true
107
97
types :
108
98
- <xref:str>
109
99
- name : service_name
110
- description : The name of the Service resource.
100
+ description : The name of the Service resource. Required.
111
101
isRequired : true
112
102
types :
113
103
- <xref:str>
114
104
- name : app_name
115
- description : The name of the App resource.
105
+ description : The name of the App resource. Required.
116
106
isRequired : true
117
107
types :
118
108
- <xref:str>
@@ -152,30 +142,41 @@ methods:
152
142
name : begin_update
153
143
summary : Operation to update an exiting App.
154
144
signature : ' async begin_update(resource_group_name: str, service_name: str, app_name:
155
- str, app_resource: AppResource, **kwargs: Any) -> AsyncLROPoller[AppResource]'
145
+ str, app_resource: _models.AppResource, *, content_type: str = '' application/json'' ,
146
+ **kwargs: Any) -> AsyncLROPoller[_models.AppResource]'
156
147
parameters :
157
148
- name : resource_group_name
158
149
description : ' The name of the resource group that contains the resource. You can
159
150
160
- obtain this value from the Azure Resource Manager API or the portal.'
151
+ obtain this value from the Azure Resource Manager API or the portal. Required. '
161
152
isRequired : true
162
153
types :
163
154
- <xref:str>
164
155
- name : service_name
165
- description : The name of the Service resource.
156
+ description : The name of the Service resource. Required.
166
157
isRequired : true
167
158
types :
168
159
- <xref:str>
169
160
- name : app_name
170
- description : The name of the App resource.
161
+ description : The name of the App resource. Required.
171
162
isRequired : true
172
163
types :
173
164
- <xref:str>
174
165
- name : app_resource
175
- description : Parameters for the update operation.
166
+ description : ' Parameters for the update operation. Is either a AppResource type
167
+ or a IO
168
+
169
+ type. Required.'
176
170
isRequired : true
177
171
types :
178
172
- <xref:azure.mgmt.appplatform.v2020_07_01.models.AppResource>
173
+ - <xref:IO>
174
+ - name : content_type
175
+ description : ' Body Parameter content-type. Known values are: '' application/json'' .
176
+
177
+ Default value is None.'
178
+ types :
179
+ - <xref:str>
179
180
- name : cls
180
181
description : A custom type or function that will be passed the direct response
181
182
types :
@@ -219,17 +220,17 @@ methods:
219
220
- name : resource_group_name
220
221
description : ' The name of the resource group that contains the resource. You can
221
222
222
- obtain this value from the Azure Resource Manager API or the portal.'
223
+ obtain this value from the Azure Resource Manager API or the portal. Required. '
223
224
isRequired : true
224
225
types :
225
226
- <xref:str>
226
227
- name : service_name
227
- description : The name of the Service resource.
228
+ description : The name of the Service resource. Required.
228
229
isRequired : true
229
230
types :
230
231
- <xref:str>
231
232
- name : app_name
232
- description : The name of the App resource.
233
+ description : The name of the App resource. Required.
233
234
isRequired : true
234
235
types :
235
236
- <xref:str>
@@ -243,7 +244,7 @@ methods:
243
244
types :
244
245
- <xref:callable>
245
246
return :
246
- description : AppResource, or the result of cls(response)
247
+ description : AppResource or the result of cls(response)
247
248
types :
248
249
- <xref:azure.mgmt.appplatform.v2020_07_01.models.AppResource>
249
250
exceptions :
@@ -258,17 +259,17 @@ methods:
258
259
- name : resource_group_name
259
260
description : ' The name of the resource group that contains the resource. You can
260
261
261
- obtain this value from the Azure Resource Manager API or the portal.'
262
+ obtain this value from the Azure Resource Manager API or the portal. Required. '
262
263
isRequired : true
263
264
types :
264
265
- <xref:str>
265
266
- name : service_name
266
- description : The name of the Service resource.
267
+ description : The name of the Service resource. Required.
267
268
isRequired : true
268
269
types :
269
270
- <xref:str>
270
271
- name : app_name
271
- description : The name of the App resource.
272
+ description : The name of the App resource. Required.
272
273
isRequired : true
273
274
types :
274
275
- <xref:str>
@@ -277,7 +278,7 @@ methods:
277
278
types :
278
279
- <xref:callable>
279
280
return :
280
- description : ResourceUploadDefinition, or the result of cls(response)
281
+ description : ResourceUploadDefinition or the result of cls(response)
281
282
types :
282
283
- <xref:azure.mgmt.appplatform.v2020_07_01.models.ResourceUploadDefinition>
283
284
exceptions :
@@ -286,17 +287,17 @@ methods:
286
287
name : list
287
288
summary : Handles requests to list all resources in a Service.
288
289
signature : ' list(resource_group_name: str, service_name: str, **kwargs: Any) ->
289
- AsyncIterable[AppResourceCollection ]'
290
+ AsyncIterable[AppResource ]'
290
291
parameters :
291
292
- name : resource_group_name
292
293
description : ' The name of the resource group that contains the resource. You can
293
294
294
- obtain this value from the Azure Resource Manager API or the portal.'
295
+ obtain this value from the Azure Resource Manager API or the portal. Required. '
295
296
isRequired : true
296
297
types :
297
298
- <xref:str>
298
299
- name : service_name
299
- description : The name of the Service resource.
300
+ description : The name of the Service resource. Required.
300
301
isRequired : true
301
302
types :
302
303
- <xref:str>
@@ -305,48 +306,56 @@ methods:
305
306
types :
306
307
- <xref:callable>
307
308
return :
308
- description : ' An iterator like instance of either AppResourceCollection or the
309
- result of
310
-
311
- cls(response)'
309
+ description : An iterator like instance of either AppResource or the result of
310
+ cls(response)
312
311
types :
313
- - <xref:azure.core.async_paging.AsyncItemPaged>[<xref:azure.mgmt.appplatform.v2020_07_01.models.AppResourceCollection >]
312
+ - <xref:azure.core.async_paging.AsyncItemPaged>[<xref:azure.mgmt.appplatform.v2020_07_01.models.AppResource >]
314
313
exceptions :
315
314
- type : azure.core.exceptions.HttpResponseError
316
315
- uid : azure.mgmt.appplatform.v2020_07_01.aio.operations.AppsOperations.validate_domain
317
316
name : validate_domain
318
317
summary : Check the resource name is valid as well as not in use.
319
318
signature : ' async validate_domain(resource_group_name: str, service_name: str, app_name:
320
- str, validate_payload: CustomDomainValidatePayload, **kwargs: Any) -> CustomDomainValidateResult'
319
+ str, validate_payload: _models.CustomDomainValidatePayload, *, content_type: str
320
+ = '' application/json'' , **kwargs: Any) -> _models.CustomDomainValidateResult'
321
321
parameters :
322
322
- name : resource_group_name
323
323
description : ' The name of the resource group that contains the resource. You can
324
324
325
- obtain this value from the Azure Resource Manager API or the portal.'
325
+ obtain this value from the Azure Resource Manager API or the portal. Required. '
326
326
isRequired : true
327
327
types :
328
328
- <xref:str>
329
329
- name : service_name
330
- description : The name of the Service resource.
330
+ description : The name of the Service resource. Required.
331
331
isRequired : true
332
332
types :
333
333
- <xref:str>
334
334
- name : app_name
335
- description : The name of the App resource.
335
+ description : The name of the App resource. Required.
336
336
isRequired : true
337
337
types :
338
338
- <xref:str>
339
339
- name : validate_payload
340
- description : Custom domain payload to be validated.
340
+ description : ' Custom domain payload to be validated. Is either a
341
+
342
+ CustomDomainValidatePayload type or a IO type. Required.'
341
343
isRequired : true
342
344
types :
343
345
- <xref:azure.mgmt.appplatform.v2020_07_01.models.CustomDomainValidatePayload>
346
+ - <xref:IO>
347
+ - name : content_type
348
+ description : ' Body Parameter content-type. Known values are: '' application/json'' .
349
+
350
+ Default value is None.'
351
+ types :
352
+ - <xref:str>
344
353
- name : cls
345
354
description : A custom type or function that will be passed the direct response
346
355
types :
347
356
- <xref:callable>
348
357
return :
349
- description : CustomDomainValidateResult, or the result of cls(response)
358
+ description : CustomDomainValidateResult or the result of cls(response)
350
359
types :
351
360
- <xref:azure.mgmt.appplatform.v2020_07_01.models.CustomDomainValidateResult>
352
361
exceptions :
0 commit comments