Class: Azure::ARM::Web::Models::AppServiceEnvironmentResource

Inherits:
MsRestAzure::Resource
  • Object
show all
Includes:
MsRest::JSONable, MsRestAzure
Defined in:
lib/generated/azure_mgmt_web/models/app_service_environment_resource.rb

Overview

App Service Environment ARM resource.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#allowed_multi_sizes ⇒ String

sizes are allowed for front-ends.

Returns:

  • (String) —

    List of comma separated strings describing which VM



92
93
94
 
# File 'lib/generated/azure_mgmt_web/models/app_service_environment_resource.rb', line 92

def allowed_multi_sizes
  @allowed_multi_sizes
end

#allowed_worker_sizes ⇒ String

sizes are allowed for workers.

Returns:

  • (String) —

    List of comma separated strings describing which VM



96
97
98
 
# File 'lib/generated/azure_mgmt_web/models/app_service_environment_resource.rb', line 96

def allowed_worker_sizes
  @allowed_worker_sizes
end

#api_management_account_id ⇒ String

Environment.

Returns:

  • (String) —

    API Management Account associated with the App Service



132
133
134
 
# File 'lib/generated/azure_mgmt_web/models/app_service_environment_resource.rb', line 132

def 
  @api_management_account_id
end

#app_service_environment_resource_location ⇒ String

US“.

Returns:

  • (String) —

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



21
22
23
 
# File 'lib/generated/azure_mgmt_web/models/app_service_environment_resource.rb', line 21

def app_service_environment_resource_location
  @app_service_environment_resource_location
end

#app_service_environment_resource_name ⇒ String

Returns Name of the App Service Environment.

Returns:

  • (String) —

    Name of the App Service Environment.



17
18
19
 
# File 'lib/generated/azure_mgmt_web/models/app_service_environment_resource.rb', line 17

def app_service_environment_resource_name
  @app_service_environment_resource_name
end

#cluster_settings ⇒ Array<NameValuePair>

behavior of the App Service Environment.

Returns:



148
149
150
 
# File 'lib/generated/azure_mgmt_web/models/app_service_environment_resource.rb', line 148

def cluster_settings
  @cluster_settings
end

#database_edition ⇒ String

Environment, e.g. “Standard”.

Returns:

  • (String) —

    Edition of the metadata database for the App Service



67
68
69
 
# File 'lib/generated/azure_mgmt_web/models/app_service_environment_resource.rb', line 67

def database_edition
  @database_edition
end

#database_service_objective ⇒ String

Service Environment, e.g. “S0”.

Returns:

  • (String) —

    Service objective of the metadata database for the App



71
72
73
 
# File 'lib/generated/azure_mgmt_web/models/app_service_environment_resource.rb', line 71

def database_service_objective
  @database_service_objective
end

#default_front_end_scale_factor ⇒ Integer

Returns Default Scale Factor for FrontEnds.

Returns:

  • (Integer) —

    Default Scale Factor for FrontEnds.



128
129
130
 
# File 'lib/generated/azure_mgmt_web/models/app_service_environment_resource.rb', line 128

def default_front_end_scale_factor
  @default_front_end_scale_factor
end

#dns_suffix ⇒ String

Returns DNS suffix of the App Service Environment.

Returns:

  • (String) —

    DNS suffix of the App Service Environment.



81
82
83
 
# File 'lib/generated/azure_mgmt_web/models/app_service_environment_resource.rb', line 81

def dns_suffix
  @dns_suffix
end

#dynamic_cache_enabled ⇒ Boolean

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



144
145
146
 
# File 'lib/generated/azure_mgmt_web/models/app_service_environment_resource.rb', line 144

def dynamic_cache_enabled
  @dynamic_cache_enabled
end

#environment_capacities ⇒ Array<StampCapacity>

worker capacities.

Returns:



107
108
109
 
# File 'lib/generated/azure_mgmt_web/models/app_service_environment_resource.rb', line 107

def environment_capacities
  @environment_capacities
end

#environment_is_healthy ⇒ Boolean

Environment is healthy.

Returns:

  • (Boolean) —

    True/false indicating whether the App Service



115
116
117
 
# File 'lib/generated/azure_mgmt_web/models/app_service_environment_resource.rb', line 115

def environment_is_healthy
  @environment_is_healthy
end

#environment_status ⇒ String

of the App Service Environment.

Returns:

  • (String) —

    Detailed message about with results of the last check



119
120
121
 
# File 'lib/generated/azure_mgmt_web/models/app_service_environment_resource.rb', line 119

def environment_status
  @environment_status
end

#front_end_scale_factor ⇒ Integer

Returns Scale factor for front-ends.

Returns:

  • (Integer) —

    Scale factor for front-ends.



125
126
127
 
# File 'lib/generated/azure_mgmt_web/models/app_service_environment_resource.rb', line 125

def front_end_scale_factor
  @front_end_scale_factor
end

#internal_load_balancing_mode ⇒ InternalLoadBalancingMode

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

Returns:



49
50
51
 
# File 'lib/generated/azure_mgmt_web/models/app_service_environment_resource.rb', line 49

def internal_load_balancing_mode
  @internal_load_balancing_mode
end

#ipssl_address_count ⇒ Integer

Service Environment.

Returns:

  • (Integer) —

    Number of IP SSL addresses reserved for the App



63
64
65
 
# File 'lib/generated/azure_mgmt_web/models/app_service_environment_resource.rb', line 63

def ipssl_address_count
  @ipssl_address_count
end

#last_action ⇒ String

Returns Last deployment action on the App Service Environment.

Returns:

  • (String) —

    Last deployment action on the App Service Environment.



84
85
86
 
# File 'lib/generated/azure_mgmt_web/models/app_service_environment_resource.rb', line 84

def last_action
  @last_action
end

#last_action_result ⇒ String

Service Environment.

Returns:

  • (String) —

    Result of the last deployment action on the App



88
89
90
 
# File 'lib/generated/azure_mgmt_web/models/app_service_environment_resource.rb', line 88

def last_action_result
  @last_action_result
end

#maximum_number_of_machines ⇒ Integer

Returns Maximum number of VMs in the App Service Environment.

Returns:

  • (Integer) —

    Maximum number of VMs in the App Service Environment.



99
100
101
 
# File 'lib/generated/azure_mgmt_web/models/app_service_environment_resource.rb', line 99

def maximum_number_of_machines
  @maximum_number_of_machines
end

#multi_role_count ⇒ Integer

Returns Number of front-end instances.

Returns:

  • (Integer) —

    Number of front-end instances.



55
56
57
 
# File 'lib/generated/azure_mgmt_web/models/app_service_environment_resource.rb', line 55

def multi_role_count
  @multi_role_count
end

#multi_size ⇒ String

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

Returns:

  • (String) —

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



52
53
54
 
# File 'lib/generated/azure_mgmt_web/models/app_service_environment_resource.rb', line 52

def multi_size
  @multi_size
end

#network_access_control_list ⇒ Array<NetworkAccessControlEntry>

controlling traffic to the App Service Environment.

Returns:



111
112
113
 
# File 'lib/generated/azure_mgmt_web/models/app_service_environment_resource.rb', line 111

def network_access_control_list
  @network_access_control_list
end

#provisioning_state ⇒ ProvisioningState

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

Returns:



26
27
28
 
# File 'lib/generated/azure_mgmt_web/models/app_service_environment_resource.rb', line 26

def provisioning_state
  @provisioning_state
end

#resource_group ⇒ String

Returns Resource group of the App Service Environment.

Returns:

  • (String) —

    Resource group of the App Service Environment.



122
123
124
 
# File 'lib/generated/azure_mgmt_web/models/app_service_environment_resource.rb', line 122

def resource_group
  @resource_group
end

#status ⇒ HostingEnvironmentStatus

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

Returns:



31
32
33
 
# File 'lib/generated/azure_mgmt_web/models/app_service_environment_resource.rb', line 31

def status
  @status
end

#subscription_id ⇒ String

Returns Subscription of the App Service Environment.

Returns:

  • (String) —

    Subscription of the App Service Environment.



78
79
80
 
# File 'lib/generated/azure_mgmt_web/models/app_service_environment_resource.rb', line 78

def subscription_id
  @subscription_id
end

#suspended ⇒ Boolean

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



138
139
140
 
# File 'lib/generated/azure_mgmt_web/models/app_service_environment_resource.rb', line 138

def suspended
  @suspended
end

#upgrade_domains ⇒ Integer

Environment.

Returns:

  • (Integer) —

    Number of upgrade domains of the App Service



75
76
77
 
# File 'lib/generated/azure_mgmt_web/models/app_service_environment_resource.rb', line 75

def upgrade_domains
  @upgrade_domains
end

#vip_mappings ⇒ Array<VirtualIPMapping>

App Service Environment.

Returns:



103
104
105
 
# File 'lib/generated/azure_mgmt_web/models/app_service_environment_resource.rb', line 103

def vip_mappings
  @vip_mappings
end

#virtual_network ⇒ VirtualNetworkProfile

Returns Description of the Virtual Network.

Returns:



44
45
46
 
# File 'lib/generated/azure_mgmt_web/models/app_service_environment_resource.rb', line 44

def virtual_network
  @virtual_network
end

#vnet_name ⇒ String

Environment.

Returns:

  • (String) —

    Name of the Virtual Network for the App Service



35
36
37
 
# File 'lib/generated/azure_mgmt_web/models/app_service_environment_resource.rb', line 35

def vnet_name
  @vnet_name
end

#vnet_resource_group_name ⇒ String

Returns Resource group of the Virtual Network.

Returns:

  • (String) —

    Resource group of the Virtual Network.



38
39
40
 
# File 'lib/generated/azure_mgmt_web/models/app_service_environment_resource.rb', line 38

def vnet_resource_group_name
  @vnet_resource_group_name
end

#vnet_subnet_name ⇒ String

Returns Subnet of the Virtual Network.

Returns:

  • (String) —

    Subnet of the Virtual Network.



41
42
43
 
# File 'lib/generated/azure_mgmt_web/models/app_service_environment_resource.rb', line 41

def vnet_subnet_name
  @vnet_subnet_name
end

#worker_pools ⇒ Array<WorkerPool>

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

Returns:

  • (Array<WorkerPool>) —

    Description of worker pools with worker



59
60
61
 
# File 'lib/generated/azure_mgmt_web/models/app_service_environment_resource.rb', line 59

def worker_pools
  @worker_pools
end

Class Method Details

.mapper ⇒ Object

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



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
 
# File 'lib/generated/azure_mgmt_web/models/app_service_environment_resource.rb', line 155

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