-
Notifications
You must be signed in to change notification settings - Fork 180
/
AppServiceEnvironment.yml
632 lines (614 loc) · 20.9 KB
/
AppServiceEnvironment.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
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
### YamlMime:TSType
name: AppServiceEnvironment
uid: '@azure/arm-appservice-profile-2020-09-01-hybrid.AppServiceEnvironment'
package: '@azure/arm-appservice-profile-2020-09-01-hybrid'
summary: Description of an App Service Environment.
fullName: AppServiceEnvironment
remarks: ''
isDeprecated: false
type: interface
properties:
- name: allowedMultiSizes
uid: >-
@azure/arm-appservice-profile-2020-09-01-hybrid.AppServiceEnvironment.allowedMultiSizes
package: '@azure/arm-appservice-profile-2020-09-01-hybrid'
summary: >-
List of comma separated strings describing which VM sizes are allowed for
front-ends.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: allowedMultiSizes
remarks: ''
isDeprecated: false
syntax:
content: 'allowedMultiSizes?: string'
return:
description: ''
type: string
- name: allowedWorkerSizes
uid: >-
@azure/arm-appservice-profile-2020-09-01-hybrid.AppServiceEnvironment.allowedWorkerSizes
package: '@azure/arm-appservice-profile-2020-09-01-hybrid'
summary: >-
List of comma separated strings describing which VM sizes are allowed for
workers.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: allowedWorkerSizes
remarks: ''
isDeprecated: false
syntax:
content: 'allowedWorkerSizes?: string'
return:
description: ''
type: string
- name: apiManagementAccountId
uid: >-
@azure/arm-appservice-profile-2020-09-01-hybrid.AppServiceEnvironment.apiManagementAccountId
package: '@azure/arm-appservice-profile-2020-09-01-hybrid'
summary: API Management Account associated with the App Service Environment.
fullName: apiManagementAccountId
remarks: ''
isDeprecated: false
syntax:
content: 'apiManagementAccountId?: string'
return:
description: ''
type: string
- name: clusterSettings
uid: >-
@azure/arm-appservice-profile-2020-09-01-hybrid.AppServiceEnvironment.clusterSettings
package: '@azure/arm-appservice-profile-2020-09-01-hybrid'
summary: Custom settings for changing the behavior of the App Service Environment.
fullName: clusterSettings
remarks: ''
isDeprecated: false
syntax:
content: 'clusterSettings?: NameValuePair[]'
return:
description: ''
type: >-
<xref
uid="@azure/arm-appservice-profile-2020-09-01-hybrid.NameValuePair"
/>[]
- name: databaseEdition
uid: >-
@azure/arm-appservice-profile-2020-09-01-hybrid.AppServiceEnvironment.databaseEdition
package: '@azure/arm-appservice-profile-2020-09-01-hybrid'
summary: >-
Edition of the metadata database for the App Service Environment, e.g.
"Standard".
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: databaseEdition
remarks: ''
isDeprecated: false
syntax:
content: 'databaseEdition?: string'
return:
description: ''
type: string
- name: databaseServiceObjective
uid: >-
@azure/arm-appservice-profile-2020-09-01-hybrid.AppServiceEnvironment.databaseServiceObjective
package: '@azure/arm-appservice-profile-2020-09-01-hybrid'
summary: >-
Service objective of the metadata database for the App Service
Environment, e.g. "S0".
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: databaseServiceObjective
remarks: ''
isDeprecated: false
syntax:
content: 'databaseServiceObjective?: string'
return:
description: ''
type: string
- name: defaultFrontEndScaleFactor
uid: >-
@azure/arm-appservice-profile-2020-09-01-hybrid.AppServiceEnvironment.defaultFrontEndScaleFactor
package: '@azure/arm-appservice-profile-2020-09-01-hybrid'
summary: >-
Default Scale Factor for FrontEnds.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: defaultFrontEndScaleFactor
remarks: ''
isDeprecated: false
syntax:
content: 'defaultFrontEndScaleFactor?: number'
return:
description: ''
type: number
- name: dnsSuffix
uid: >-
@azure/arm-appservice-profile-2020-09-01-hybrid.AppServiceEnvironment.dnsSuffix
package: '@azure/arm-appservice-profile-2020-09-01-hybrid'
summary: DNS suffix of the App Service Environment.
fullName: dnsSuffix
remarks: ''
isDeprecated: false
syntax:
content: 'dnsSuffix?: string'
return:
description: ''
type: string
- name: dynamicCacheEnabled
uid: >-
@azure/arm-appservice-profile-2020-09-01-hybrid.AppServiceEnvironment.dynamicCacheEnabled
package: '@azure/arm-appservice-profile-2020-09-01-hybrid'
summary: >-
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).
fullName: dynamicCacheEnabled
remarks: ''
isDeprecated: false
syntax:
content: 'dynamicCacheEnabled?: boolean'
return:
description: ''
type: boolean
- name: environmentCapacities
uid: >-
@azure/arm-appservice-profile-2020-09-01-hybrid.AppServiceEnvironment.environmentCapacities
package: '@azure/arm-appservice-profile-2020-09-01-hybrid'
summary: >-
Current total, used, and available worker capacities.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: environmentCapacities
remarks: ''
isDeprecated: false
syntax:
content: 'environmentCapacities?: StampCapacity[]'
return:
description: ''
type: >-
<xref
uid="@azure/arm-appservice-profile-2020-09-01-hybrid.StampCapacity"
/>[]
- name: environmentIsHealthy
uid: >-
@azure/arm-appservice-profile-2020-09-01-hybrid.AppServiceEnvironment.environmentIsHealthy
package: '@azure/arm-appservice-profile-2020-09-01-hybrid'
summary: >-
True/false indicating whether the App Service Environment is healthy.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: environmentIsHealthy
remarks: ''
isDeprecated: false
syntax:
content: 'environmentIsHealthy?: boolean'
return:
description: ''
type: boolean
- name: environmentStatus
uid: >-
@azure/arm-appservice-profile-2020-09-01-hybrid.AppServiceEnvironment.environmentStatus
package: '@azure/arm-appservice-profile-2020-09-01-hybrid'
summary: >-
Detailed message about with results of the last check of the App Service
Environment.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: environmentStatus
remarks: ''
isDeprecated: false
syntax:
content: 'environmentStatus?: string'
return:
description: ''
type: string
- name: frontEndScaleFactor
uid: >-
@azure/arm-appservice-profile-2020-09-01-hybrid.AppServiceEnvironment.frontEndScaleFactor
package: '@azure/arm-appservice-profile-2020-09-01-hybrid'
summary: Scale factor for front-ends.
fullName: frontEndScaleFactor
remarks: ''
isDeprecated: false
syntax:
content: 'frontEndScaleFactor?: number'
return:
description: ''
type: number
- name: hasLinuxWorkers
uid: >-
@azure/arm-appservice-profile-2020-09-01-hybrid.AppServiceEnvironment.hasLinuxWorkers
package: '@azure/arm-appservice-profile-2020-09-01-hybrid'
summary: Flag that displays whether an ASE has linux workers or not
fullName: hasLinuxWorkers
remarks: ''
isDeprecated: false
syntax:
content: 'hasLinuxWorkers?: boolean'
return:
description: ''
type: boolean
- name: internalLoadBalancingMode
uid: >-
@azure/arm-appservice-profile-2020-09-01-hybrid.AppServiceEnvironment.internalLoadBalancingMode
package: '@azure/arm-appservice-profile-2020-09-01-hybrid'
summary: >-
Specifies which endpoints to serve internally in the Virtual Network for
the App Service Environment.
fullName: internalLoadBalancingMode
remarks: ''
isDeprecated: false
syntax:
content: 'internalLoadBalancingMode?: InternalLoadBalancingMode'
return:
description: ''
type: >-
<xref
uid="@azure/arm-appservice-profile-2020-09-01-hybrid.InternalLoadBalancingMode"
/>
- name: ipsslAddressCount
uid: >-
@azure/arm-appservice-profile-2020-09-01-hybrid.AppServiceEnvironment.ipsslAddressCount
package: '@azure/arm-appservice-profile-2020-09-01-hybrid'
summary: Number of IP SSL addresses reserved for the App Service Environment.
fullName: ipsslAddressCount
remarks: ''
isDeprecated: false
syntax:
content: 'ipsslAddressCount?: number'
return:
description: ''
type: number
- name: lastAction
uid: >-
@azure/arm-appservice-profile-2020-09-01-hybrid.AppServiceEnvironment.lastAction
package: '@azure/arm-appservice-profile-2020-09-01-hybrid'
summary: >-
Last deployment action on the App Service Environment.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: lastAction
remarks: ''
isDeprecated: false
syntax:
content: 'lastAction?: string'
return:
description: ''
type: string
- name: lastActionResult
uid: >-
@azure/arm-appservice-profile-2020-09-01-hybrid.AppServiceEnvironment.lastActionResult
package: '@azure/arm-appservice-profile-2020-09-01-hybrid'
summary: >-
Result of the last deployment action on the App Service Environment.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: lastActionResult
remarks: ''
isDeprecated: false
syntax:
content: 'lastActionResult?: string'
return:
description: ''
type: string
- name: location
uid: >-
@azure/arm-appservice-profile-2020-09-01-hybrid.AppServiceEnvironment.location
package: '@azure/arm-appservice-profile-2020-09-01-hybrid'
summary: Location of the App Service Environment, e.g. "West US".
fullName: location
remarks: ''
isDeprecated: false
syntax:
content: 'location: string'
return:
description: ''
type: string
- name: maximumNumberOfMachines
uid: >-
@azure/arm-appservice-profile-2020-09-01-hybrid.AppServiceEnvironment.maximumNumberOfMachines
package: '@azure/arm-appservice-profile-2020-09-01-hybrid'
summary: >-
Maximum number of VMs in the App Service Environment.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: maximumNumberOfMachines
remarks: ''
isDeprecated: false
syntax:
content: 'maximumNumberOfMachines?: number'
return:
description: ''
type: number
- name: multiRoleCount
uid: >-
@azure/arm-appservice-profile-2020-09-01-hybrid.AppServiceEnvironment.multiRoleCount
package: '@azure/arm-appservice-profile-2020-09-01-hybrid'
summary: Number of front-end instances.
fullName: multiRoleCount
remarks: ''
isDeprecated: false
syntax:
content: 'multiRoleCount?: number'
return:
description: ''
type: number
- name: multiSize
uid: >-
@azure/arm-appservice-profile-2020-09-01-hybrid.AppServiceEnvironment.multiSize
package: '@azure/arm-appservice-profile-2020-09-01-hybrid'
summary: Front-end VM size, e.g. "Medium", "Large".
fullName: multiSize
remarks: ''
isDeprecated: false
syntax:
content: 'multiSize?: string'
return:
description: ''
type: string
- name: name
uid: '@azure/arm-appservice-profile-2020-09-01-hybrid.AppServiceEnvironment.name'
package: '@azure/arm-appservice-profile-2020-09-01-hybrid'
summary: Name of the App Service Environment.
fullName: name
remarks: ''
isDeprecated: false
syntax:
content: 'name: string'
return:
description: ''
type: string
- name: networkAccessControlList
uid: >-
@azure/arm-appservice-profile-2020-09-01-hybrid.AppServiceEnvironment.networkAccessControlList
package: '@azure/arm-appservice-profile-2020-09-01-hybrid'
summary: >-
Access control list for controlling traffic to the App Service
Environment.
fullName: networkAccessControlList
remarks: ''
isDeprecated: false
syntax:
content: 'networkAccessControlList?: NetworkAccessControlEntry[]'
return:
description: ''
type: >-
<xref
uid="@azure/arm-appservice-profile-2020-09-01-hybrid.NetworkAccessControlEntry"
/>[]
- name: provisioningState
uid: >-
@azure/arm-appservice-profile-2020-09-01-hybrid.AppServiceEnvironment.provisioningState
package: '@azure/arm-appservice-profile-2020-09-01-hybrid'
summary: >-
Provisioning state of the App Service Environment.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: provisioningState
remarks: ''
isDeprecated: false
syntax:
content: 'provisioningState?: ProvisioningState'
return:
description: ''
type: >-
<xref
uid="@azure/arm-appservice-profile-2020-09-01-hybrid.ProvisioningState"
/>
- name: resourceGroup
uid: >-
@azure/arm-appservice-profile-2020-09-01-hybrid.AppServiceEnvironment.resourceGroup
package: '@azure/arm-appservice-profile-2020-09-01-hybrid'
summary: >-
Resource group of the App Service Environment.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: resourceGroup
remarks: ''
isDeprecated: false
syntax:
content: 'resourceGroup?: string'
return:
description: ''
type: string
- name: sslCertKeyVaultId
uid: >-
@azure/arm-appservice-profile-2020-09-01-hybrid.AppServiceEnvironment.sslCertKeyVaultId
package: '@azure/arm-appservice-profile-2020-09-01-hybrid'
summary: Key Vault ID for ILB App Service Environment default SSL certificate
fullName: sslCertKeyVaultId
remarks: ''
isDeprecated: false
syntax:
content: 'sslCertKeyVaultId?: string'
return:
description: ''
type: string
- name: sslCertKeyVaultSecretName
uid: >-
@azure/arm-appservice-profile-2020-09-01-hybrid.AppServiceEnvironment.sslCertKeyVaultSecretName
package: '@azure/arm-appservice-profile-2020-09-01-hybrid'
summary: >-
Key Vault Secret Name for ILB App Service Environment default SSL
certificate
fullName: sslCertKeyVaultSecretName
remarks: ''
isDeprecated: false
syntax:
content: 'sslCertKeyVaultSecretName?: string'
return:
description: ''
type: string
- name: status
uid: >-
@azure/arm-appservice-profile-2020-09-01-hybrid.AppServiceEnvironment.status
package: '@azure/arm-appservice-profile-2020-09-01-hybrid'
summary: >-
Current status of the App Service Environment.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: status
remarks: ''
isDeprecated: false
syntax:
content: 'status?: HostingEnvironmentStatus'
return:
description: ''
type: >-
<xref
uid="@azure/arm-appservice-profile-2020-09-01-hybrid.HostingEnvironmentStatus"
/>
- name: subscriptionId
uid: >-
@azure/arm-appservice-profile-2020-09-01-hybrid.AppServiceEnvironment.subscriptionId
package: '@azure/arm-appservice-profile-2020-09-01-hybrid'
summary: >-
Subscription of the App Service Environment.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: subscriptionId
remarks: ''
isDeprecated: false
syntax:
content: 'subscriptionId?: string'
return:
description: ''
type: string
- name: suspended
uid: >-
@azure/arm-appservice-profile-2020-09-01-hybrid.AppServiceEnvironment.suspended
package: '@azure/arm-appservice-profile-2020-09-01-hybrid'
summary: >-
<code>true</code> if the App Service Environment is suspended; otherwise,
<code>false</code>. The environment can be suspended, e.g. when the
management endpoint is no longer available
(most likely because NSG blocked the incoming traffic).
fullName: suspended
remarks: ''
isDeprecated: false
syntax:
content: 'suspended?: boolean'
return:
description: ''
type: boolean
- name: upgradeDomains
uid: >-
@azure/arm-appservice-profile-2020-09-01-hybrid.AppServiceEnvironment.upgradeDomains
package: '@azure/arm-appservice-profile-2020-09-01-hybrid'
summary: >-
Number of upgrade domains of the App Service Environment.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: upgradeDomains
remarks: ''
isDeprecated: false
syntax:
content: 'upgradeDomains?: number'
return:
description: ''
type: number
- name: userWhitelistedIpRanges
uid: >-
@azure/arm-appservice-profile-2020-09-01-hybrid.AppServiceEnvironment.userWhitelistedIpRanges
package: '@azure/arm-appservice-profile-2020-09-01-hybrid'
summary: User added ip ranges to whitelist on ASE db
fullName: userWhitelistedIpRanges
remarks: ''
isDeprecated: false
syntax:
content: 'userWhitelistedIpRanges?: string[]'
return:
description: ''
type: string[]
- name: vipMappings
uid: >-
@azure/arm-appservice-profile-2020-09-01-hybrid.AppServiceEnvironment.vipMappings
package: '@azure/arm-appservice-profile-2020-09-01-hybrid'
summary: >-
Description of IP SSL mapping for the App Service Environment.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: vipMappings
remarks: ''
isDeprecated: false
syntax:
content: 'vipMappings?: VirtualIPMapping[]'
return:
description: ''
type: >-
<xref
uid="@azure/arm-appservice-profile-2020-09-01-hybrid.VirtualIPMapping"
/>[]
- name: virtualNetwork
uid: >-
@azure/arm-appservice-profile-2020-09-01-hybrid.AppServiceEnvironment.virtualNetwork
package: '@azure/arm-appservice-profile-2020-09-01-hybrid'
summary: Description of the Virtual Network.
fullName: virtualNetwork
remarks: ''
isDeprecated: false
syntax:
content: 'virtualNetwork: VirtualNetworkProfile'
return:
description: ''
type: >-
<xref
uid="@azure/arm-appservice-profile-2020-09-01-hybrid.VirtualNetworkProfile"
/>
- name: vnetName
uid: >-
@azure/arm-appservice-profile-2020-09-01-hybrid.AppServiceEnvironment.vnetName
package: '@azure/arm-appservice-profile-2020-09-01-hybrid'
summary: Name of the Virtual Network for the App Service Environment.
fullName: vnetName
remarks: ''
isDeprecated: false
syntax:
content: 'vnetName?: string'
return:
description: ''
type: string
- name: vnetResourceGroupName
uid: >-
@azure/arm-appservice-profile-2020-09-01-hybrid.AppServiceEnvironment.vnetResourceGroupName
package: '@azure/arm-appservice-profile-2020-09-01-hybrid'
summary: Resource group of the Virtual Network.
fullName: vnetResourceGroupName
remarks: ''
isDeprecated: false
syntax:
content: 'vnetResourceGroupName?: string'
return:
description: ''
type: string
- name: vnetSubnetName
uid: >-
@azure/arm-appservice-profile-2020-09-01-hybrid.AppServiceEnvironment.vnetSubnetName
package: '@azure/arm-appservice-profile-2020-09-01-hybrid'
summary: Subnet of the Virtual Network.
fullName: vnetSubnetName
remarks: ''
isDeprecated: false
syntax:
content: 'vnetSubnetName?: string'
return:
description: ''
type: string
- name: workerPools
uid: >-
@azure/arm-appservice-profile-2020-09-01-hybrid.AppServiceEnvironment.workerPools
package: '@azure/arm-appservice-profile-2020-09-01-hybrid'
summary: >-
Description of worker pools with worker size IDs, VM sizes, and number of
workers in each pool.
fullName: workerPools
remarks: ''
isDeprecated: false
syntax:
content: 'workerPools: WorkerPool[]'
return:
description: ''
type: >-
<xref uid="@azure/arm-appservice-profile-2020-09-01-hybrid.WorkerPool"
/>[]