Class: Azure::Web::Mgmt::V2018_02_01::Models::AppServiceEnvironmentPatchResource

Inherits:
ProxyOnlyResource
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2018-02-01/generated/azure_mgmt_web/models/app_service_environment_patch_resource.rb

Overview

ARM resource for a app service enviroment.

Instance Attribute Summary collapse

Attributes inherited from ProxyOnlyResource

#id, #kind, #name, #type

Class Method Summary collapse

Instance Attribute Details

#allowed_multi_sizesString

sizes are allowed for front-ends.

Returns:

  • (String)

    List of comma separated strings describing which VM



91
92
93
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/app_service_environment_patch_resource.rb', line 91

def allowed_multi_sizes
  @allowed_multi_sizes
end

#allowed_worker_sizesString

sizes are allowed for workers.

Returns:

  • (String)

    List of comma separated strings describing which VM



95
96
97
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/app_service_environment_patch_resource.rb', line 95

def allowed_worker_sizes
  @allowed_worker_sizes
end

#api_management_account_idString

Environment.

Returns:

  • (String)

    API Management Account associated with the App Service



131
132
133
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/app_service_environment_patch_resource.rb', line 131

def 
  
end

#app_service_environment_patch_resource_nameString

Returns Name of the App Service Environment.

Returns:

  • (String)

    Name of the App Service Environment.



16
17
18
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/app_service_environment_patch_resource.rb', line 16

def app_service_environment_patch_resource_name
  @app_service_environment_patch_resource_name
end

#cluster_settingsArray<NameValuePair>

behavior of the App Service Environment.

Returns:



147
148
149
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/app_service_environment_patch_resource.rb', line 147

def cluster_settings
  @cluster_settings
end

#database_editionString

Environment, e.g. “Standard”.

Returns:

  • (String)

    Edition of the metadata database for the App Service



66
67
68
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/app_service_environment_patch_resource.rb', line 66

def database_edition
  @database_edition
end

#database_service_objectiveString

Service Environment, e.g. “S0”.

Returns:

  • (String)

    Service objective of the metadata database for the App



70
71
72
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/app_service_environment_patch_resource.rb', line 70

def database_service_objective
  @database_service_objective
end

#default_front_end_scale_factorInteger

Returns Default Scale Factor for FrontEnds.

Returns:

  • (Integer)

    Default Scale Factor for FrontEnds.



127
128
129
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/app_service_environment_patch_resource.rb', line 127

def default_front_end_scale_factor
  @default_front_end_scale_factor
end

#dns_suffixString

Returns DNS suffix of the App Service Environment.

Returns:

  • (String)

    DNS suffix of the App Service Environment.



80
81
82
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/app_service_environment_patch_resource.rb', line 80

def dns_suffix
  @dns_suffix
end

#dynamic_cache_enabledBoolean

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).

Returns:

  • (Boolean)

    True/false indicating whether the App Service



143
144
145
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/app_service_environment_patch_resource.rb', line 143

def dynamic_cache_enabled
  @dynamic_cache_enabled
end

#environment_capacitiesArray<StampCapacity>

worker capacities.

Returns:



106
107
108
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/app_service_environment_patch_resource.rb', line 106

def environment_capacities
  @environment_capacities
end

#environment_is_healthyBoolean

Environment is healthy.

Returns:

  • (Boolean)

    True/false indicating whether the App Service



114
115
116
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/app_service_environment_patch_resource.rb', line 114

def environment_is_healthy
  @environment_is_healthy
end

#environment_statusString

of the App Service Environment.

Returns:

  • (String)

    Detailed message about with results of the last check



118
119
120
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/app_service_environment_patch_resource.rb', line 118

def environment_status
  @environment_status
end

#front_end_scale_factorInteger

Returns Scale factor for front-ends.

Returns:

  • (Integer)

    Scale factor for front-ends.



124
125
126
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/app_service_environment_patch_resource.rb', line 124

def front_end_scale_factor
  @front_end_scale_factor
end

#has_linux_workersBoolean

or not

Returns:

  • (Boolean)

    Flag that displays whether an ASE has linux workers



154
155
156
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/app_service_environment_patch_resource.rb', line 154

def has_linux_workers
  @has_linux_workers
end

#internal_load_balancing_modeInternalLoadBalancingMode

internally in the Virtual Network for the App Service Environment. Possible values include: ‘None’, ‘Web’, ‘Publishing’

Returns:



48
49
50
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/app_service_environment_patch_resource.rb', line 48

def internal_load_balancing_mode
  @internal_load_balancing_mode
end

#ipssl_address_countInteger

Service Environment.

Returns:

  • (Integer)

    Number of IP SSL addresses reserved for the App



62
63
64
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/app_service_environment_patch_resource.rb', line 62

def ipssl_address_count
  @ipssl_address_count
end

#last_actionString

Returns Last deployment action on the App Service Environment.

Returns:

  • (String)

    Last deployment action on the App Service Environment.



83
84
85
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/app_service_environment_patch_resource.rb', line 83

def last_action
  @last_action
end

#last_action_resultString

Service Environment.

Returns:

  • (String)

    Result of the last deployment action on the App



87
88
89
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/app_service_environment_patch_resource.rb', line 87

def last_action_result
  @last_action_result
end

#locationString

US“.

Returns:

  • (String)

    Location of the App Service Environment, e.g. “West



20
21
22
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/app_service_environment_patch_resource.rb', line 20

def location
  @location
end

#maximum_number_of_machinesInteger

Returns Maximum number of VMs in the App Service Environment.

Returns:

  • (Integer)

    Maximum number of VMs in the App Service Environment.



98
99
100
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/app_service_environment_patch_resource.rb', line 98

def maximum_number_of_machines
  @maximum_number_of_machines
end

#multi_role_countInteger

Returns Number of front-end instances.

Returns:

  • (Integer)

    Number of front-end instances.



54
55
56
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/app_service_environment_patch_resource.rb', line 54

def multi_role_count
  @multi_role_count
end

#multi_sizeString

Returns Front-end VM size, e.g. “Medium”, “Large”.

Returns:

  • (String)

    Front-end VM size, e.g. “Medium”, “Large”.



51
52
53
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/app_service_environment_patch_resource.rb', line 51

def multi_size
  @multi_size
end

#network_access_control_listArray<NetworkAccessControlEntry>

controlling traffic to the App Service Environment.

Returns:



110
111
112
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/app_service_environment_patch_resource.rb', line 110

def network_access_control_list
  @network_access_control_list
end

#provisioning_stateProvisioningState

Environment. Possible values include: ‘Succeeded’, ‘Failed’, ‘Canceled’, ‘InProgress’, ‘Deleting’

Returns:



25
26
27
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/app_service_environment_patch_resource.rb', line 25

def provisioning_state
  @provisioning_state
end

#resource_groupString

Returns Resource group of the App Service Environment.

Returns:

  • (String)

    Resource group of the App Service Environment.



121
122
123
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/app_service_environment_patch_resource.rb', line 121

def resource_group
  @resource_group
end

#ssl_cert_key_vault_idString

SSL certificate

Returns:

  • (String)

    Key Vault ID for ILB App Service Environment default



158
159
160
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/app_service_environment_patch_resource.rb', line 158

def ssl_cert_key_vault_id
  @ssl_cert_key_vault_id
end

#ssl_cert_key_vault_secret_nameString

default SSL certificate

Returns:

  • (String)

    Key Vault Secret Name for ILB App Service Environment



162
163
164
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/app_service_environment_patch_resource.rb', line 162

def ssl_cert_key_vault_secret_name
  @ssl_cert_key_vault_secret_name
end

#statusHostingEnvironmentStatus

Environment. Possible values include: ‘Preparing’, ‘Ready’, ‘Scaling’, ‘Deleting’

Returns:



30
31
32
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/app_service_environment_patch_resource.rb', line 30

def status
  @status
end

#subscription_idString

Returns Subscription of the App Service Environment.

Returns:

  • (String)

    Subscription of the App Service Environment.



77
78
79
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/app_service_environment_patch_resource.rb', line 77

def subscription_id
  @subscription_id
end

#suspendedBoolean

suspended; otherwise, false. The environment can be suspended, e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic).

Returns:

  • (Boolean)

    true if the App Service Environment is



137
138
139
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/app_service_environment_patch_resource.rb', line 137

def suspended
  @suspended
end

#upgrade_domainsInteger

Environment.

Returns:

  • (Integer)

    Number of upgrade domains of the App Service



74
75
76
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/app_service_environment_patch_resource.rb', line 74

def upgrade_domains
  @upgrade_domains
end

#user_whitelisted_ip_rangesArray<String>

Returns User added ip ranges to whitelist on ASE db.

Returns:

  • (Array<String>)

    User added ip ranges to whitelist on ASE db



150
151
152
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/app_service_environment_patch_resource.rb', line 150

def user_whitelisted_ip_ranges
  @user_whitelisted_ip_ranges
end

#vip_mappingsArray<VirtualIPMapping>

App Service Environment.

Returns:



102
103
104
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/app_service_environment_patch_resource.rb', line 102

def vip_mappings
  @vip_mappings
end

#virtual_networkVirtualNetworkProfile

Returns Description of the Virtual Network.

Returns:



43
44
45
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/app_service_environment_patch_resource.rb', line 43

def virtual_network
  @virtual_network
end

#vnet_nameString

Environment.

Returns:

  • (String)

    Name of the Virtual Network for the App Service



34
35
36
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/app_service_environment_patch_resource.rb', line 34

def vnet_name
  @vnet_name
end

#vnet_resource_group_nameString

Returns Resource group of the Virtual Network.

Returns:

  • (String)

    Resource group of the Virtual Network.



37
38
39
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/app_service_environment_patch_resource.rb', line 37

def vnet_resource_group_name
  @vnet_resource_group_name
end

#vnet_subnet_nameString

Returns Subnet of the Virtual Network.

Returns:

  • (String)

    Subnet of the Virtual Network.



40
41
42
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/app_service_environment_patch_resource.rb', line 40

def vnet_subnet_name
  @vnet_subnet_name
end

#worker_poolsArray<WorkerPool>

size IDs, VM sizes, and number of workers in each pool.

Returns:

  • (Array<WorkerPool>)

    Description of worker pools with worker



58
59
60
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/app_service_environment_patch_resource.rb', line 58

def worker_pools
  @worker_pools
end

Class Method Details

.mapperObject

Mapper for AppServiceEnvironmentPatchResource class as Ruby Hash. This will be used for serialization/deserialization.



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
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/app_service_environment_patch_resource.rb', line 169

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'AppServiceEnvironmentPatchResource',
    type: {
      name: 'Composite',
      class_name: 'AppServiceEnvironmentPatchResource',
      model_properties: {
        id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'id',
          type: {
            name: 'String'
          }
        },
        name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'name',
          type: {
            name: 'String'
          }
        },
        kind: {
          client_side_validation: true,
          required: false,
          serialized_name: 'kind',
          type: {
            name: 'String'
          }
        },
        type: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'type',
          type: {
            name: 'String'
          }
        },
        app_service_environment_patch_resource_name: {
          client_side_validation: true,
          required: true,
          serialized_name: 'properties.name',
          type: {
            name: 'String'
          }
        },
        location: {
          client_side_validation: true,
          required: true,
          serialized_name: 'properties.location',
          type: {
            name: 'String'
          }
        },
        provisioning_state: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.provisioningState',
          type: {
            name: 'Enum',
            module: 'ProvisioningState'
          }
        },
        status: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.status',
          type: {
            name: 'Enum',
            module: 'HostingEnvironmentStatus'
          }
        },
        vnet_name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.vnetName',
          type: {
            name: 'String'
          }
        },
        vnet_resource_group_name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.vnetResourceGroupName',
          type: {
            name: 'String'
          }
        },
        vnet_subnet_name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.vnetSubnetName',
          type: {
            name: 'String'
          }
        },
        virtual_network: {
          client_side_validation: true,
          required: true,
          serialized_name: 'properties.virtualNetwork',
          type: {
            name: 'Composite',
            class_name: 'VirtualNetworkProfile'
          }
        },
        internal_load_balancing_mode: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.internalLoadBalancingMode',
          type: {
            name: 'Enum',
            module: 'InternalLoadBalancingMode'
          }
        },
        multi_size: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.multiSize',
          type: {
            name: 'String'
          }
        },
        multi_role_count: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.multiRoleCount',
          type: {
            name: 'Number'
          }
        },
        worker_pools: {
          client_side_validation: true,
          required: true,
          serialized_name: 'properties.workerPools',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'WorkerPoolElementType',
                type: {
                  name: 'Composite',
                  class_name: 'WorkerPool'
                }
            }
          }
        },
        ipssl_address_count: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.ipsslAddressCount',
          type: {
            name: 'Number'
          }
        },
        database_edition: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.databaseEdition',
          type: {
            name: 'String'
          }
        },
        database_service_objective: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.databaseServiceObjective',
          type: {
            name: 'String'
          }
        },
        upgrade_domains: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.upgradeDomains',
          type: {
            name: 'Number'
          }
        },
        subscription_id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.subscriptionId',
          type: {
            name: 'String'
          }
        },
        dns_suffix: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.dnsSuffix',
          type: {
            name: 'String'
          }
        },
        last_action: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.lastAction',
          type: {
            name: 'String'
          }
        },
        last_action_result: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.lastActionResult',
          type: {
            name: 'String'
          }
        },
        allowed_multi_sizes: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.allowedMultiSizes',
          type: {
            name: 'String'
          }
        },
        allowed_worker_sizes: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.allowedWorkerSizes',
          type: {
            name: 'String'
          }
        },
        maximum_number_of_machines: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.maximumNumberOfMachines',
          type: {
            name: 'Number'
          }
        },
        vip_mappings: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.vipMappings',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'VirtualIPMappingElementType',
                type: {
                  name: 'Composite',
                  class_name: 'VirtualIPMapping'
                }
            }
          }
        },
        environment_capacities: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.environmentCapacities',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'StampCapacityElementType',
                type: {
                  name: 'Composite',
                  class_name: 'StampCapacity'
                }
            }
          }
        },
        network_access_control_list: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.networkAccessControlList',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'NetworkAccessControlEntryElementType',
                type: {
                  name: 'Composite',
                  class_name: 'NetworkAccessControlEntry'
                }
            }
          }
        },
        environment_is_healthy: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.environmentIsHealthy',
          type: {
            name: 'Boolean'
          }
        },
        environment_status: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.environmentStatus',
          type: {
            name: 'String'
          }
        },
        resource_group: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.resourceGroup',
          type: {
            name: 'String'
          }
        },
        front_end_scale_factor: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.frontEndScaleFactor',
          type: {
            name: 'Number'
          }
        },
        default_front_end_scale_factor: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.defaultFrontEndScaleFactor',
          type: {
            name: 'Number'
          }
        },
        api_management_account_id: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.apiManagementAccountId',
          type: {
            name: 'String'
          }
        },
        suspended: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.suspended',
          type: {
            name: 'Boolean'
          }
        },
        dynamic_cache_enabled: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.dynamicCacheEnabled',
          type: {
            name: 'Boolean'
          }
        },
        cluster_settings: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.clusterSettings',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'NameValuePairElementType',
                type: {
                  name: 'Composite',
                  class_name: 'NameValuePair'
                }
            }
          }
        },
        user_whitelisted_ip_ranges: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.userWhitelistedIpRanges',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        has_linux_workers: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.hasLinuxWorkers',
          type: {
            name: 'Boolean'
          }
        },
        ssl_cert_key_vault_id: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.sslCertKeyVaultId',
          type: {
            name: 'String'
          }
        },
        ssl_cert_key_vault_secret_name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.sslCertKeyVaultSecretName',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end