Class: Azure::ARM::Web::Models::HostingEnvironmentProperties

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/azure_mgmt_web/models/hosting_environment_properties.rb

Overview

Model object.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance 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



98
99
100
 
# File 'lib/azure_mgmt_web/models/hosting_environment_properties.rb', line 98

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



102
103
104
 
# File 'lib/azure_mgmt_web/models/hosting_environment_properties.rb', line 102

def allowed_worker_sizes
  @allowed_worker_sizes
end

#api_management_account_id ⇒ String

Environment

Returns:

  • (String) —

    Api Management Account associated with this Hosting



135
136
137
 
# File 'lib/azure_mgmt_web/models/hosting_environment_properties.rb', line 135

def 
  
end

#cluster_settings ⇒ Array<NameValuePair>

behavior of the hosting environment

Returns:



145
146
147
 
# File 'lib/azure_mgmt_web/models/hosting_environment_properties.rb', line 145

def cluster_settings
  @cluster_settings
end

#database_edition ⇒ String

hostingEnvironment (App Service Environment) e.g. “Standard”

Returns:

  • (String) —

    Edition of the metadata database for the



70
71
72
 
# File 'lib/azure_mgmt_web/models/hosting_environment_properties.rb', line 70

def database_edition
  @database_edition
end

#database_service_objective ⇒ String

hostingEnvironment (App Service Environment) e.g. “S0”

Returns:

  • (String) —

    Service objective of the metadata database for the



74
75
76
 
# File 'lib/azure_mgmt_web/models/hosting_environment_properties.rb', line 74

def database_service_objective
  @database_service_objective
end

#dns_suffix ⇒ String

Environment)

Returns:

  • (String) —

    DNS suffix of the hostingEnvironment (App Service



86
87
88
 
# File 'lib/azure_mgmt_web/models/hosting_environment_properties.rb', line 86

def dns_suffix
  @dns_suffix
end

#environment_capacities ⇒ Array<StampCapacity>

worker capacities

Returns:



114
115
116
 
# File 'lib/azure_mgmt_web/models/hosting_environment_properties.rb', line 114

def environment_capacities
  @environment_capacities
end

#environment_is_healthy ⇒ Boolean

(App Service Environment) is healthy

Returns:

  • (Boolean) —

    True/false indicating whether the hostingEnvironment



123
124
125
 
# File 'lib/azure_mgmt_web/models/hosting_environment_properties.rb', line 123

def environment_is_healthy
  @environment_is_healthy
end

#environment_status ⇒ String

of the hostingEnvironment (App Service Environment)

Returns:

  • (String) —

    Detailed message about with results of the last check



127
128
129
 
# File 'lib/azure_mgmt_web/models/hosting_environment_properties.rb', line 127

def environment_status
  @environment_status
end

#internal_load_balancing_mode ⇒ InternalLoadBalancingMode

internally in the hostingEnvironment’s (App Service Environment) VNET. Possible values include: ‘None’, ‘Web’, ‘Publishing’

Returns:



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

def internal_load_balancing_mode
  @internal_load_balancing_mode
end

#ipssl_address_count ⇒ Integer

hostingEnvironment (App Service Environment)

Returns:

  • (Integer) —

    Number of IP SSL addresses reserved for this



66
67
68
 
# File 'lib/azure_mgmt_web/models/hosting_environment_properties.rb', line 66

def ipssl_address_count
  @ipssl_address_count
end

#last_action ⇒ String

(App Service Environment)

Returns:

  • (String) —

    Last deployment action on this hostingEnvironment



90
91
92
 
# File 'lib/azure_mgmt_web/models/hosting_environment_properties.rb', line 90

def last_action
  @last_action
end

#last_action_result ⇒ String

hostingEnvironment (App Service Environment)

Returns:

  • (String) —

    Result of the last deployment action on this



94
95
96
 
# File 'lib/azure_mgmt_web/models/hosting_environment_properties.rb', line 94

def last_action_result
  @last_action_result
end

#location ⇒ String

Environment), e.g. “West US”

Returns:

  • (String) —

    Location of the hostingEnvironment (App Service



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

def location
  @location
end

#maximum_number_of_machines ⇒ Integer

(App Service Environment)

Returns:

  • (Integer) —

    Maximum number of VMs in this hostingEnvironment



106
107
108
 
# File 'lib/azure_mgmt_web/models/hosting_environment_properties.rb', line 106

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



58
59
60
 
# File 'lib/azure_mgmt_web/models/hosting_environment_properties.rb', line 58

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”



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

def multi_size
  @multi_size
end

#name ⇒ String

Environment)

Returns:

  • (String) —

    Name of the hostingEnvironment (App Service



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

def name
  @name
end

#network_access_control_list ⇒ Array<NetworkAccessControlEntry>

controlling traffic to the hostingEnvironment (App Service Environment)

Returns:



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

def network_access_control_list
  @network_access_control_list
end

#provisioning_state ⇒ ProvisioningState

hostingEnvironment (App Service Environment). Possible values include: ‘Succeeded’, ‘Failed’, ‘Canceled’, ‘InProgress’, ‘Deleting’

Returns:



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

def provisioning_state
  @provisioning_state
end

#resource_group ⇒ String

Environment)

Returns:

  • (String) —

    Resource group of the hostingEnvironment (App Service



131
132
133
 
# File 'lib/azure_mgmt_web/models/hosting_environment_properties.rb', line 131

def resource_group
  @resource_group
end

#status ⇒ HostingEnvironmentStatus

hostingEnvironment (App Service Environment). Possible values include: ‘Preparing’, ‘Ready’, ‘Scaling’, ‘Deleting’

Returns:



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

def status
  @status
end

#subscription_id ⇒ String

Environment)

Returns:

  • (String) —

    Subscription of the hostingEnvironment (App Service



82
83
84
 
# File 'lib/azure_mgmt_web/models/hosting_environment_properties.rb', line 82

def subscription_id
  @subscription_id
end

#suspended ⇒ Boolean

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 hostingEnvironment



141
142
143
 
# File 'lib/azure_mgmt_web/models/hosting_environment_properties.rb', line 141

def suspended
  @suspended
end

#upgrade_domains ⇒ Integer

(App Service Environment)

Returns:

  • (Integer) —

    Number of upgrade domains of this hostingEnvironment



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

def upgrade_domains
  @upgrade_domains
end

#vip_mappings ⇒ Array<VirtualIPMapping>

this hostingEnvironment (App Service Environment)

Returns:



110
111
112
 
# File 'lib/azure_mgmt_web/models/hosting_environment_properties.rb', line 110

def vip_mappings
  @vip_mappings
end

#virtual_network ⇒ VirtualNetworkProfile

hostingEnvironment’s (App Service Environment) virtual network

Returns:



47
48
49
 
# File 'lib/azure_mgmt_web/models/hosting_environment_properties.rb', line 47

def virtual_network
  @virtual_network
end

#vnet_name ⇒ String

Environment) virtual network

Returns:

  • (String) —

    Name of the hostingEnvironment’s (App Service



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

def vnet_name
  @vnet_name
end

#vnet_resource_group_name ⇒ String

Service Environment) virtual network

Returns:

  • (String) —

    Resource group of the hostingEnvironment’s (App



39
40
41
 
# File 'lib/azure_mgmt_web/models/hosting_environment_properties.rb', line 39

def vnet_resource_group_name
  @vnet_resource_group_name
end

#vnet_subnet_name ⇒ String

Environment) virtual network

Returns:

  • (String) —

    Subnet of the hostingEnvironment’s (App Service



43
44
45
 
# File 'lib/azure_mgmt_web/models/hosting_environment_properties.rb', line 43

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



62
63
64
 
# File 'lib/azure_mgmt_web/models/hosting_environment_properties.rb', line 62

def worker_pools
  @worker_pools
end

Class Method Details

.deserialize_object(object) ⇒ HostingEnvironmentProperties

Deserializes given Ruby Hash into Model object.

Parameters:

  • object (Hash) —

    Ruby Hash object to deserialize.

Returns:



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
 
# File 'lib/azure_mgmt_web/models/hosting_environment_properties.rb', line 325

def self.deserialize_object(object)
  return if object.nil?
  output_object = HostingEnvironmentProperties.new

  deserialized_property = object['name']
  output_object.name = deserialized_property

  deserialized_property = object['location']
  output_object.location = deserialized_property

  deserialized_property = object['provisioningState']
  if (!deserialized_property.nil? && !deserialized_property.empty?)
    enum_is_valid = ProvisioningState.constants.any? { |e| ProvisioningState.const_get(e).to_s.downcase == deserialized_property.downcase }
    warn 'Enum ProvisioningState does not contain ' + deserialized_property.downcase + ', but was received from the server.' unless enum_is_valid
  end
  output_object.provisioning_state = deserialized_property

  deserialized_property = object['status']
  if (!deserialized_property.nil? && !deserialized_property.empty?)
    enum_is_valid = HostingEnvironmentStatus.constants.any? { |e| HostingEnvironmentStatus.const_get(e).to_s.downcase == deserialized_property.downcase }
    warn 'Enum HostingEnvironmentStatus does not contain ' + deserialized_property.downcase + ', but was received from the server.' unless enum_is_valid
  end
  output_object.status = deserialized_property

  deserialized_property = object['vnetName']
  output_object.vnet_name = deserialized_property

  deserialized_property = object['vnetResourceGroupName']
  output_object.vnet_resource_group_name = deserialized_property

  deserialized_property = object['vnetSubnetName']
  output_object.vnet_subnet_name = deserialized_property

  deserialized_property = object['virtualNetwork']
  unless deserialized_property.nil?
    deserialized_property = VirtualNetworkProfile.deserialize_object(deserialized_property)
  end
  output_object.virtual_network = deserialized_property

  deserialized_property = object['internalLoadBalancingMode']
  if (!deserialized_property.nil? && !deserialized_property.empty?)
    enum_is_valid = InternalLoadBalancingMode.constants.any? { |e| InternalLoadBalancingMode.const_get(e).to_s.downcase == deserialized_property.downcase }
    warn 'Enum InternalLoadBalancingMode does not contain ' + deserialized_property.downcase + ', but was received from the server.' unless enum_is_valid
  end
  output_object.internal_load_balancing_mode = deserialized_property

  deserialized_property = object['multiSize']
  output_object.multi_size = deserialized_property

  deserialized_property = object['multiRoleCount']
  deserialized_property = Integer(deserialized_property) unless deserialized_property.to_s.empty?
  output_object.multi_role_count = deserialized_property

  deserialized_property = object['workerPools']
  unless deserialized_property.nil?
    deserialized_array = []
    deserialized_property.each do |element5|
      unless element5.nil?
        element5 = WorkerPool.deserialize_object(element5)
      end
      deserialized_array.push(element5)
    end
    deserialized_property = deserialized_array
  end
  output_object.worker_pools = deserialized_property

  deserialized_property = object['ipsslAddressCount']
  deserialized_property = Integer(deserialized_property) unless deserialized_property.to_s.empty?
  output_object.ipssl_address_count = deserialized_property

  deserialized_property = object['databaseEdition']
  output_object.database_edition = deserialized_property

  deserialized_property = object['databaseServiceObjective']
  output_object.database_service_objective = deserialized_property

  deserialized_property = object['upgradeDomains']
  deserialized_property = Integer(deserialized_property) unless deserialized_property.to_s.empty?
  output_object.upgrade_domains = deserialized_property

  deserialized_property = object['subscriptionId']
  output_object.subscription_id = deserialized_property

  deserialized_property = object['dnsSuffix']
  output_object.dns_suffix = deserialized_property

  deserialized_property = object['lastAction']
  output_object.last_action = deserialized_property

  deserialized_property = object['lastActionResult']
  output_object.last_action_result = deserialized_property

  deserialized_property = object['allowedMultiSizes']
  output_object.allowed_multi_sizes = deserialized_property

  deserialized_property = object['allowedWorkerSizes']
  output_object.allowed_worker_sizes = deserialized_property

  deserialized_property = object['maximumNumberOfMachines']
  deserialized_property = Integer(deserialized_property) unless deserialized_property.to_s.empty?
  output_object.maximum_number_of_machines = deserialized_property

  deserialized_property = object['vipMappings']
  unless deserialized_property.nil?
    deserialized_array = []
    deserialized_property.each do |element6|
      unless element6.nil?
        element6 = VirtualIPMapping.deserialize_object(element6)
      end
      deserialized_array.push(element6)
    end
    deserialized_property = deserialized_array
  end
  output_object.vip_mappings = deserialized_property

  deserialized_property = object['environmentCapacities']
  unless deserialized_property.nil?
    deserialized_array = []
    deserialized_property.each do |element7|
      unless element7.nil?
        element7 = StampCapacity.deserialize_object(element7)
      end
      deserialized_array.push(element7)
    end
    deserialized_property = deserialized_array
  end
  output_object.environment_capacities = deserialized_property

  deserialized_property = object['networkAccessControlList']
  unless deserialized_property.nil?
    deserialized_array = []
    deserialized_property.each do |element8|
      unless element8.nil?
        element8 = NetworkAccessControlEntry.deserialize_object(element8)
      end
      deserialized_array.push(element8)
    end
    deserialized_property = deserialized_array
  end
  output_object.network_access_control_list = deserialized_property

  deserialized_property = object['environmentIsHealthy']
  output_object.environment_is_healthy = deserialized_property

  deserialized_property = object['environmentStatus']
  output_object.environment_status = deserialized_property

  deserialized_property = object['resourceGroup']
  output_object.resource_group = deserialized_property

  deserialized_property = object['apiManagementAccountId']
  output_object. = deserialized_property

  deserialized_property = object['suspended']
  output_object.suspended = deserialized_property

  deserialized_property = object['clusterSettings']
  unless deserialized_property.nil?
    deserialized_array = []
    deserialized_property.each do |element9|
      unless element9.nil?
        element9 = NameValuePair.deserialize_object(element9)
      end
      deserialized_array.push(element9)
    end
    deserialized_property = deserialized_array
  end
  output_object.cluster_settings = deserialized_property

  output_object
end

.serialize_object(object) ⇒ Hash

Serializes given Model object into Ruby Hash.

Parameters:

  • object —

    Model object to serialize.

Returns:

  • (Hash) —

    Serialized object in form of Ruby Hash.



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
 
# File 'lib/azure_mgmt_web/models/hosting_environment_properties.rb', line 164

def self.serialize_object(object)
  object.validate
  output_object = {}

  serialized_property = object.name
  output_object['name'] = serialized_property unless serialized_property.nil?

  serialized_property = object.location
  output_object['location'] = serialized_property unless serialized_property.nil?

  serialized_property = object.provisioning_state
  output_object['provisioningState'] = serialized_property unless serialized_property.nil?

  serialized_property = object.status
  output_object['status'] = serialized_property unless serialized_property.nil?

  serialized_property = object.vnet_name
  output_object['vnetName'] = serialized_property unless serialized_property.nil?

  serialized_property = object.vnet_resource_group_name
  output_object['vnetResourceGroupName'] = serialized_property unless serialized_property.nil?

  serialized_property = object.vnet_subnet_name
  output_object['vnetSubnetName'] = serialized_property unless serialized_property.nil?

  serialized_property = object.virtual_network
  unless serialized_property.nil?
    serialized_property = VirtualNetworkProfile.serialize_object(serialized_property)
  end
  output_object['virtualNetwork'] = serialized_property unless serialized_property.nil?

  serialized_property = object.internal_load_balancing_mode
  output_object['internalLoadBalancingMode'] = serialized_property unless serialized_property.nil?

  serialized_property = object.multi_size
  output_object['multiSize'] = serialized_property unless serialized_property.nil?

  serialized_property = object.multi_role_count
  output_object['multiRoleCount'] = serialized_property unless serialized_property.nil?

  serialized_property = object.worker_pools
  unless serialized_property.nil?
    serializedArray = []
    serialized_property.each do |element|
      unless element.nil?
        element = WorkerPool.serialize_object(element)
      end
      serializedArray.push(element)
    end
    serialized_property = serializedArray
  end
  output_object['workerPools'] = serialized_property unless serialized_property.nil?

  serialized_property = object.ipssl_address_count
  output_object['ipsslAddressCount'] = serialized_property unless serialized_property.nil?

  serialized_property = object.database_edition
  output_object['databaseEdition'] = serialized_property unless serialized_property.nil?

  serialized_property = object.database_service_objective
  output_object['databaseServiceObjective'] = serialized_property unless serialized_property.nil?

  serialized_property = object.upgrade_domains
  output_object['upgradeDomains'] = serialized_property unless serialized_property.nil?

  serialized_property = object.subscription_id
  output_object['subscriptionId'] = serialized_property unless serialized_property.nil?

  serialized_property = object.dns_suffix
  output_object['dnsSuffix'] = serialized_property unless serialized_property.nil?

  serialized_property = object.last_action
  output_object['lastAction'] = serialized_property unless serialized_property.nil?

  serialized_property = object.last_action_result
  output_object['lastActionResult'] = serialized_property unless serialized_property.nil?

  serialized_property = object.allowed_multi_sizes
  output_object['allowedMultiSizes'] = serialized_property unless serialized_property.nil?

  serialized_property = object.allowed_worker_sizes
  output_object['allowedWorkerSizes'] = serialized_property unless serialized_property.nil?

  serialized_property = object.maximum_number_of_machines
  output_object['maximumNumberOfMachines'] = serialized_property unless serialized_property.nil?

  serialized_property = object.vip_mappings
  unless serialized_property.nil?
    serializedArray = []
    serialized_property.each do |element1|
      unless element1.nil?
        element1 = VirtualIPMapping.serialize_object(element1)
      end
      serializedArray.push(element1)
    end
    serialized_property = serializedArray
  end
  output_object['vipMappings'] = serialized_property unless serialized_property.nil?

  serialized_property = object.environment_capacities
  unless serialized_property.nil?
    serializedArray = []
    serialized_property.each do |element2|
      unless element2.nil?
        element2 = StampCapacity.serialize_object(element2)
      end
      serializedArray.push(element2)
    end
    serialized_property = serializedArray
  end
  output_object['environmentCapacities'] = serialized_property unless serialized_property.nil?

  serialized_property = object.network_access_control_list
  unless serialized_property.nil?
    serializedArray = []
    serialized_property.each do |element3|
      unless element3.nil?
        element3 = NetworkAccessControlEntry.serialize_object(element3)
      end
      serializedArray.push(element3)
    end
    serialized_property = serializedArray
  end
  output_object['networkAccessControlList'] = serialized_property unless serialized_property.nil?

  serialized_property = object.environment_is_healthy
  output_object['environmentIsHealthy'] = serialized_property unless serialized_property.nil?

  serialized_property = object.environment_status
  output_object['environmentStatus'] = serialized_property unless serialized_property.nil?

  serialized_property = object.resource_group
  output_object['resourceGroup'] = serialized_property unless serialized_property.nil?

  serialized_property = object.
  output_object['apiManagementAccountId'] = serialized_property unless serialized_property.nil?

  serialized_property = object.suspended
  output_object['suspended'] = serialized_property unless serialized_property.nil?

  serialized_property = object.cluster_settings
  unless serialized_property.nil?
    serializedArray = []
    serialized_property.each do |element4|
      unless element4.nil?
        element4 = NameValuePair.serialize_object(element4)
      end
      serializedArray.push(element4)
    end
    serialized_property = serializedArray
  end
  output_object['clusterSettings'] = serialized_property unless serialized_property.nil?

  output_object
end

Instance Method Details

#validate ⇒ Object

Validate the object. Throws ValidationError if validation fails.



150
151
152
153
154
155
156
157
 
# File 'lib/azure_mgmt_web/models/hosting_environment_properties.rb', line 150

def validate
  @virtual_network.validate unless @virtual_network.nil?
  @worker_pools.each{ |e| e.validate if e.respond_to?(:validate) } unless @worker_pools.nil?
  @vip_mappings.each{ |e| e.validate if e.respond_to?(:validate) } unless @vip_mappings.nil?
  @environment_capacities.each{ |e| e.validate if e.respond_to?(:validate) } unless @environment_capacities.nil?
  @network_access_control_list.each{ |e| e.validate if e.respond_to?(:validate) } unless @network_access_control_list.nil?
  @cluster_settings.each{ |e| e.validate if e.respond_to?(:validate) } unless @cluster_settings.nil?
end