-
Notifications
You must be signed in to change notification settings - Fork 238
/
azure.mgmt.web.v2019_08_01.models.AppServiceEnvironmentResource.yml
390 lines (355 loc) · 12.2 KB
/
azure.mgmt.web.v2019_08_01.models.AppServiceEnvironmentResource.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
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
### YamlMime:PythonClass
uid: azure.mgmt.web.v2019_08_01.models.AppServiceEnvironmentResource
name: AppServiceEnvironmentResource
fullName: azure.mgmt.web.v2019_08_01.models.AppServiceEnvironmentResource
module: azure.mgmt.web.v2019_08_01.models
inheritances:
- azure.mgmt.web.v2019_08_01.models._models_py3.Resource
summary: 'App Service Environment ARM resource.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to server.'
constructor:
syntax: 'AppServiceEnvironmentResource(*, location: str, kind: str | None = None,
tags: Dict[str, str] | None = None, name_properties_name: str | None = None, location_properties_location:
str | None = None, vnet_name: str | None = None, vnet_resource_group_name: str
| None = None, vnet_subnet_name: str | None = None, virtual_network: _models.VirtualNetworkProfile
| None = None, internal_load_balancing_mode: str | _models.InternalLoadBalancingMode
| None = None, multi_size: str | None = None, multi_role_count: int | None = None,
worker_pools: List[_models.WorkerPool] | None = None, ipssl_address_count: int
| None = None, dns_suffix: str | None = None, network_access_control_list: List[_models.NetworkAccessControlEntry]
| None = None, front_end_scale_factor: int | None = None, api_management_account_id:
str | None = None, suspended: bool | None = None, dynamic_cache_enabled: bool
| None = None, cluster_settings: List[_models.NameValuePair] | None = None, user_whitelisted_ip_ranges:
List[str] | None = None, has_linux_workers: bool | None = None, ssl_cert_key_vault_id:
str | None = None, ssl_cert_key_vault_secret_name: str | None = None, **kwargs:
Any)'
keywordOnlyParameters:
- name: kind
description: Kind of resource.
types:
- <xref:str>
- name: location
description: Resource Location. Required.
types:
- <xref:str>
- name: tags
description: Resource tags.
types:
- <xref:dict>[<xref:str>, <xref:str>]
- name: name_properties_name
description: Name of the App Service Environment.
types:
- <xref:str>
- name: location_properties_location
description: Location of the App Service Environment, e.g. "West US".
types:
- <xref:str>
- name: vnet_name
description: Name of the Virtual Network for the App Service Environment.
types:
- <xref:str>
- name: vnet_resource_group_name
description: Resource group of the Virtual Network.
types:
- <xref:str>
- name: vnet_subnet_name
description: Subnet of the Virtual Network.
types:
- <xref:str>
- name: virtual_network
description: Description of the Virtual Network.
types:
- <xref:azure.mgmt.web.v2019_08_01.models.VirtualNetworkProfile>
- name: internal_load_balancing_mode
description: 'Specifies which endpoints to serve internally in the
Virtual Network for the App Service Environment. Known values are: "None", "Web",
and
"Publishing".'
types:
- <xref:str>
- <xref:azure.mgmt.web.v2019_08_01.models.InternalLoadBalancingMode>
- name: multi_size
description: Front-end VM size, e.g. "Medium", "Large".
types:
- <xref:str>
- name: multi_role_count
description: Number of front-end instances.
types:
- <xref:int>
- name: worker_pools
description: 'Description of worker pools with worker size IDs, VM sizes, and
number
of workers in each pool.'
types:
- <xref:list>[<xref:azure.mgmt.web.v2019_08_01.models.WorkerPool>]
- name: ipssl_address_count
description: 'Number of IP SSL addresses reserved for the App Service
Environment.'
types:
- <xref:int>
- name: dns_suffix
description: DNS suffix of the App Service Environment.
types:
- <xref:str>
- name: network_access_control_list
description: 'Access control list for controlling traffic to the App
Service Environment.'
types:
- <xref:list>[<xref:azure.mgmt.web.v2019_08_01.models.NetworkAccessControlEntry>]
- name: front_end_scale_factor
description: Scale factor for front-ends.
types:
- <xref:int>
- name: api_management_account_id
description: 'API Management Account associated with the App Service
Environment.'
types:
- <xref:str>
- name: suspended
description: "`<code>true</code>` if the App Service Environment is suspended;\n\
otherwise, `<code>false</code>`. The environment can be suspended, e.g. when\
\ the\nmanagement endpoint is no longer available\n\n (most likely because\
\ NSG blocked the incoming traffic)."
types:
- <xref:bool>
- name: dynamic_cache_enabled
description: 'True/false indicating whether the App Service Environment is
suspended. The environment can be suspended e.g. when the management endpoint
is no longer
available
(most likely because NSG blocked the incoming traffic).'
types:
- <xref:bool>
- name: cluster_settings
description: 'Custom settings for changing the behavior of the App Service
Environment.'
types:
- <xref:list>[<xref:azure.mgmt.web.v2019_08_01.models.NameValuePair>]
- name: user_whitelisted_ip_ranges
description: User added list of IP Ranges allowed on ASE db.
types:
- <xref:list>[<xref:str>]
- name: has_linux_workers
description: Flag that displays whether an ASE has linux workers or not.
types:
- <xref:bool>
- name: ssl_cert_key_vault_id
description: 'Key Vault ID for ILB App Service Environment default SSL
certificate.'
types:
- <xref:str>
- name: ssl_cert_key_vault_secret_name
description: 'Key Vault Secret Name for ILB App Service Environment
default SSL certificate.'
types:
- <xref:str>
variables:
- description: Resource Id.
name: id
types:
- <xref:str>
- description: Resource Name.
name: name
types:
- <xref:str>
- description: Kind of resource.
name: kind
types:
- <xref:str>
- description: Resource Location. Required.
name: location
types:
- <xref:str>
- description: Resource type.
name: type
types:
- <xref:str>
- description: Resource tags.
name: tags
types:
- <xref:dict>[<xref:str>, <xref:str>]
- description: Name of the App Service Environment.
name: name_properties_name
types:
- <xref:str>
- description: Location of the App Service Environment, e.g. "West US".
name: location_properties_location
types:
- <xref:str>
- description: 'Provisioning state of the App Service Environment. Known values are:
"Succeeded", "Failed", "Canceled", "InProgress", and "Deleting".'
name: provisioning_state
types:
- <xref:str>
- <xref:azure.mgmt.web.v2019_08_01.models.ProvisioningState>
- description: 'Current status of the App Service Environment. Known values are: "Preparing",
"Ready", "Scaling", and "Deleting".'
name: status
types:
- <xref:str>
- <xref:azure.mgmt.web.v2019_08_01.models.HostingEnvironmentStatus>
- description: Name of the Virtual Network for the App Service Environment.
name: vnet_name
types:
- <xref:str>
- description: Resource group of the Virtual Network.
name: vnet_resource_group_name
types:
- <xref:str>
- description: Subnet of the Virtual Network.
name: vnet_subnet_name
types:
- <xref:str>
- description: Description of the Virtual Network.
name: virtual_network
types:
- <xref:azure.mgmt.web.v2019_08_01.models.VirtualNetworkProfile>
- description: 'Specifies which endpoints to serve internally in the
Virtual Network for the App Service Environment. Known values are: "None", "Web",
and
"Publishing".'
name: internal_load_balancing_mode
types:
- <xref:str>
- <xref:azure.mgmt.web.v2019_08_01.models.InternalLoadBalancingMode>
- description: Front-end VM size, e.g. "Medium", "Large".
name: multi_size
types:
- <xref:str>
- description: Number of front-end instances.
name: multi_role_count
types:
- <xref:int>
- description: 'Description of worker pools with worker size IDs, VM sizes, and number
of
workers in each pool.'
name: worker_pools
types:
- <xref:list>[<xref:azure.mgmt.web.v2019_08_01.models.WorkerPool>]
- description: Number of IP SSL addresses reserved for the App Service Environment.
name: ipssl_address_count
types:
- <xref:int>
- description: 'Edition of the metadata database for the App Service Environment,
e.g.
"Standard".'
name: database_edition
types:
- <xref:str>
- description: 'Service objective of the metadata database for the App
Service Environment, e.g. "S0".'
name: database_service_objective
types:
- <xref:str>
- description: Number of upgrade domains of the App Service Environment.
name: upgrade_domains
types:
- <xref:int>
- description: Subscription of the App Service Environment.
name: subscription_id
types:
- <xref:str>
- description: DNS suffix of the App Service Environment.
name: dns_suffix
types:
- <xref:str>
- description: Last deployment action on the App Service Environment.
name: last_action
types:
- <xref:str>
- description: Result of the last deployment action on the App Service Environment.
name: last_action_result
types:
- <xref:str>
- description: 'List of comma separated strings describing which VM sizes are
allowed for front-ends.'
name: allowed_multi_sizes
types:
- <xref:str>
- description: 'List of comma separated strings describing which VM sizes are
allowed for workers.'
name: allowed_worker_sizes
types:
- <xref:str>
- description: Maximum number of VMs in the App Service Environment.
name: maximum_number_of_machines
types:
- <xref:int>
- description: Description of IP SSL mapping for the App Service Environment.
name: vip_mappings
types:
- <xref:list>[<xref:azure.mgmt.web.v2019_08_01.models.VirtualIPMapping>]
- description: Current total, used, and available worker capacities.
name: environment_capacities
types:
- <xref:list>[<xref:azure.mgmt.web.v2019_08_01.models.StampCapacity>]
- description: 'Access control list for controlling traffic to the App
Service Environment.'
name: network_access_control_list
types:
- <xref:list>[<xref:azure.mgmt.web.v2019_08_01.models.NetworkAccessControlEntry>]
- description: 'True/false indicating whether the App Service Environment is
healthy.'
name: environment_is_healthy
types:
- <xref:bool>
- description: 'Detailed message about with results of the last check of the App
Service Environment.'
name: environment_status
types:
- <xref:str>
- description: Resource group of the App Service Environment.
name: resource_group
types:
- <xref:str>
- description: Scale factor for front-ends.
name: front_end_scale_factor
types:
- <xref:int>
- description: Default Scale Factor for FrontEnds.
name: default_front_end_scale_factor
types:
- <xref:int>
- description: 'API Management Account associated with the App Service
Environment.'
name: api_management_account_id
types:
- <xref:str>
- description: "`<code>true</code>` if the App Service Environment is suspended;\n\
otherwise, `<code>false</code>`. The environment can be suspended, e.g. when the\n\
management endpoint is no longer available\n\n (most likely because NSG blocked\
\ the incoming traffic)."
name: suspended
types:
- <xref:bool>
- description: 'True/false indicating whether the App Service Environment is
suspended. The environment can be suspended e.g. when the management endpoint
is no longer
available
(most likely because NSG blocked the incoming traffic).'
name: dynamic_cache_enabled
types:
- <xref:bool>
- description: 'Custom settings for changing the behavior of the App Service
Environment.'
name: cluster_settings
types:
- <xref:list>[<xref:azure.mgmt.web.v2019_08_01.models.NameValuePair>]
- description: User added list of IP Ranges allowed on ASE db.
name: user_whitelisted_ip_ranges
types:
- <xref:list>[<xref:str>]
- description: Flag that displays whether an ASE has linux workers or not.
name: has_linux_workers
types:
- <xref:bool>
- description: 'Key Vault ID for ILB App Service Environment default SSL
certificate.'
name: ssl_cert_key_vault_id
types:
- <xref:str>
- description: 'Key Vault Secret Name for ILB App Service Environment
default SSL certificate.'
name: ssl_cert_key_vault_secret_name
types:
- <xref:str>