Class: Azure::ARM::Web::Models::Site

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

Overview

A web app, a mobile app backend, or an API app.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#availability_state ⇒ SiteAvailabilityState

state for the app. Possible values include: ‘Normal’, ‘Limited’, ‘DisasterRecoveryMode’

Returns:



42
43
44
 
# File 'lib/generated/azure_mgmt_web/models/site.rb', line 42

def availability_state
  @availability_state
end

#client_affinity_enabled ⇒ Boolean

false to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is true.

Returns:

  • (Boolean) —

    true to enable client affinity;



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

def client_affinity_enabled
  @client_affinity_enabled
end

#client_cert_enabled ⇒ Boolean

authentication (TLS mutual authentication); otherwise, false. Default is false.

Returns:

  • (Boolean) —

    true to enable client certificate



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

def client_cert_enabled
  @client_cert_enabled
end

#cloning_info ⇒ CloningInfo

cloned from a source app.

Returns:

  • (CloningInfo) —

    If specified during app creation, the app is



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

def cloning_info
  @cloning_info
end

#container_size ⇒ Integer

Returns Size of the function container.

Returns:

  • (Integer) —

    Size of the function container.



112
113
114
 
# File 'lib/generated/azure_mgmt_web/models/site.rb', line 112

def container_size
  @container_size
end

#daily_memory_time_quota ⇒ Integer

on dynamic apps only).

Returns:

  • (Integer) —

    Maximum allowed daily memory-time quota (applicable



116
117
118
 
# File 'lib/generated/azure_mgmt_web/models/site.rb', line 116

def daily_memory_time_quota
  @daily_memory_time_quota
end

#default_host_name ⇒ String

Returns Default hostname of the app. Read-only.

Returns:

  • (String) —

    Default hostname of the app. Read-only.



139
140
141
 
# File 'lib/generated/azure_mgmt_web/models/site.rb', line 139

def default_host_name
  @default_host_name
end

#enabled ⇒ Boolean

false. Setting this value to false disables the app (takes the app offline).

Returns:

  • (Boolean) —

    true if the app is enabled; otherwise,



32
33
34
 
# File 'lib/generated/azure_mgmt_web/models/site.rb', line 32

def enabled
  @enabled
end

#enabled_host_names ⇒ Array<String>

be assigned (see HostNames) AND enabled. Otherwise, the app is not served on those hostnames.

Returns:

  • (Array<String>) —

    Enabled hostnames for the app.Hostnames need to



37
38
39
 
# File 'lib/generated/azure_mgmt_web/models/site.rb', line 37

def enabled_host_names
  @enabled_host_names
end

#gateway_site_name ⇒ String

Returns Name of gateway app associated with the app.

Returns:

  • (String) —

    Name of gateway app associated with the app.



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

def gateway_site_name
  @gateway_site_name
end

#host_name_ssl_states ⇒ Array<HostNameSslState>

manage the SSL bindings for app’s hostnames.

Returns:



46
47
48
 
# File 'lib/generated/azure_mgmt_web/models/site.rb', line 46

def host_name_ssl_states
  @host_name_ssl_states
end

#host_names ⇒ Array<String>

Returns Hostnames associated with the app.

Returns:

  • (Array<String>) —

    Hostnames associated with the app.



20
21
22
 
# File 'lib/generated/azure_mgmt_web/models/site.rb', line 20

def host_names
  @host_names
end

#host_names_disabled ⇒ Boolean

the app; otherwise, false. If true, the app is only accessible via API management process.

Returns:

  • (Boolean) —

    true to disable the public hostnames of



105
106
107
 
# File 'lib/generated/azure_mgmt_web/models/site.rb', line 105

def host_names_disabled
  @host_names_disabled
end

#hosting_environment_profile ⇒ HostingEnvironmentProfile

the app.

Returns:



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

def hosting_environment_profile
  @hosting_environment_profile
end

#is_default_container ⇒ Boolean

otherwise, false.

Returns:

  • (Boolean) —

    true if the app is a default container;



136
137
138
 
# File 'lib/generated/azure_mgmt_web/models/site.rb', line 136

def is_default_container
  @is_default_container
end

#last_modified_time_utc ⇒ DateTime

Returns Last time the app was modified, in UTC. Read-only.

Returns:

  • (DateTime) —

    Last time the app was modified, in UTC. Read-only.



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

def last_modified_time_utc
  @last_modified_time_utc
end

#max_number_of_workers ⇒ Integer

This only applies to Functions container.

Returns:

  • (Integer) —

    Maximum number of workers.



124
125
126
 
# File 'lib/generated/azure_mgmt_web/models/site.rb', line 124

def max_number_of_workers
  @max_number_of_workers
end

#micro_service ⇒ String

‘WebSites’ .

Returns:

  • (String) —

    Micro services like apps, logic apps. Default value:



85
86
87
 
# File 'lib/generated/azure_mgmt_web/models/site.rb', line 85

def micro_service
  @micro_service
end

#outbound_ip_addresses ⇒ String

connections (e.g. database access). Read-only.

Returns:

  • (String) —

    List of IP addresses that the app uses for outbound



109
110
111
 
# File 'lib/generated/azure_mgmt_web/models/site.rb', line 109

def outbound_ip_addresses
  @outbound_ip_addresses
end

#premium_app_deployed ⇒ Boolean

Returns Indicates whether app is deployed as a premium app.

Returns:

  • (Boolean) —

    Indicates whether app is deployed as a premium app.



68
69
70
 
# File 'lib/generated/azure_mgmt_web/models/site.rb', line 68

def premium_app_deployed
  @premium_app_deployed
end

#repository_site_name ⇒ String

Returns Name of the repository site.

Returns:

  • (String) —

    Name of the repository site.



23
24
25
 
# File 'lib/generated/azure_mgmt_web/models/site.rb', line 23

def repository_site_name
  @repository_site_name
end

#reserved ⇒ Boolean

false. Default value: false .

Returns:

  • (Boolean) —

    true if reserved; otherwise,



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

def reserved
  @reserved
end

#resource_group ⇒ String

Read-only.

Returns:

  • (String) —

    Name of the resource group the app belongs to.



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

def resource_group
  @resource_group
end

#scm_site_also_stopped ⇒ Boolean

app is stopped; otherwise, false. The default is false. Default value: false .

Returns:

  • (Boolean) —

    true to stop SCM (KUDU) site when the



73
74
75
 
# File 'lib/generated/azure_mgmt_web/models/site.rb', line 73

def scm_site_also_stopped
  @scm_site_also_stopped
end

#server_farm_id ⇒ String

formatted as: “/subscriptions/subscriptionID/resourceGroups/groupName/providers/Microsoft.Web/serverfarms/appServicePlanName”.

Returns:

  • (String) —

    Resource ID of the associated App Service plan,



51
52
53
 
# File 'lib/generated/azure_mgmt_web/models/site.rb', line 51

def server_farm_id
  @server_farm_id
end

#site_config ⇒ SiteConfig

Returns Configuration of the app.

Returns:



61
62
63
 
# File 'lib/generated/azure_mgmt_web/models/site.rb', line 61

def site_config
  @site_config
end

#slot_swap_status ⇒ SlotSwapStatus

operation.

Returns:



143
144
145
 
# File 'lib/generated/azure_mgmt_web/models/site.rb', line 143

def slot_swap_status
  @slot_swap_status
end

#state ⇒ String

Returns Current state of the app.

Returns:

  • (String) —

    Current state of the app.



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

def state
  @state
end

#suspended_till ⇒ DateTime

exceeded.

Returns:

  • (DateTime) —

    App suspended till in case memory-time quota is



120
121
122
 
# File 'lib/generated/azure_mgmt_web/models/site.rb', line 120

def suspended_till
  @suspended_till
end

#target_swap_slot ⇒ String

into. Read-only.

Returns:

  • (String) —

    Specifies which deployment slot this app will swap



77
78
79
 
# File 'lib/generated/azure_mgmt_web/models/site.rb', line 77

def target_swap_slot
  @target_swap_slot
end

#traffic_manager_host_names ⇒ Array<String>

the app. Read-only.

Returns:

  • (Array<String>) —

    Azure Traffic Manager hostnames associated with



65
66
67
 
# File 'lib/generated/azure_mgmt_web/models/site.rb', line 65

def traffic_manager_host_names
  @traffic_manager_host_names
end

#usage_state ⇒ UsageState

quota usage. Read-only. Possible values include: ‘Normal’, ‘Exceeded’

Returns:

  • (UsageState) —

    State indicating whether the app has exceeded its



27
28
29
 
# File 'lib/generated/azure_mgmt_web/models/site.rb', line 27

def usage_state
  @usage_state
end

Class Method Details

.mapper ⇒ Object

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



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

def self.mapper()
  {
    required: false,
    serialized_name: 'Site',
    type: {
      name: 'Composite',
      class_name: 'Site',
      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'
                }
            }
          }
        },
        state: {
          required: false,
          read_only: true,
          serialized_name: 'properties.state',
          type: {
            name: 'String'
          }
        },
        host_names: {
          required: false,
          read_only: true,
          serialized_name: 'properties.hostNames',
          type: {
            name: 'Sequence',
            element: {
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        repository_site_name: {
          required: false,
          read_only: true,
          serialized_name: 'properties.repositorySiteName',
          type: {
            name: 'String'
          }
        },
        usage_state: {
          required: false,
          read_only: true,
          serialized_name: 'properties.usageState',
          type: {
            name: 'Enum',
            module: 'UsageState'
          }
        },
        enabled: {
          required: false,
          serialized_name: 'properties.enabled',
          type: {
            name: 'Boolean'
          }
        },
        enabled_host_names: {
          required: false,
          read_only: true,
          serialized_name: 'properties.enabledHostNames',
          type: {
            name: 'Sequence',
            element: {
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        availability_state: {
          required: false,
          read_only: true,
          serialized_name: 'properties.availabilityState',
          type: {
            name: 'Enum',
            module: 'SiteAvailabilityState'
          }
        },
        host_name_ssl_states: {
          required: false,
          serialized_name: 'properties.hostNameSslStates',
          type: {
            name: 'Sequence',
            element: {
                required: false,
                serialized_name: 'HostNameSslStateElementType',
                type: {
                  name: 'Composite',
                  class_name: 'HostNameSslState'
                }
            }
          }
        },
        server_farm_id: {
          required: false,
          serialized_name: 'properties.serverFarmId',
          type: {
            name: 'String'
          }
        },
        reserved: {
          required: false,
          serialized_name: 'properties.reserved',
          default_value: false,
          type: {
            name: 'Boolean'
          }
        },
        last_modified_time_utc: {
          required: false,
          read_only: true,
          serialized_name: 'properties.lastModifiedTimeUtc',
          type: {
            name: 'DateTime'
          }
        },
        site_config: {
          required: false,
          serialized_name: 'properties.siteConfig',
          type: {
            name: 'Composite',
            class_name: 'SiteConfig'
          }
        },
        traffic_manager_host_names: {
          required: false,
          read_only: true,
          serialized_name: 'properties.trafficManagerHostNames',
          type: {
            name: 'Sequence',
            element: {
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        premium_app_deployed: {
          required: false,
          read_only: true,
          serialized_name: 'properties.premiumAppDeployed',
          type: {
            name: 'Boolean'
          }
        },
        scm_site_also_stopped: {
          required: false,
          serialized_name: 'properties.scmSiteAlsoStopped',
          default_value: false,
          type: {
            name: 'Boolean'
          }
        },
        target_swap_slot: {
          required: false,
          read_only: true,
          serialized_name: 'properties.targetSwapSlot',
          type: {
            name: 'String'
          }
        },
        hosting_environment_profile: {
          required: false,
          serialized_name: 'properties.hostingEnvironmentProfile',
          type: {
            name: 'Composite',
            class_name: 'HostingEnvironmentProfile'
          }
        },
        micro_service: {
          required: false,
          serialized_name: 'properties.microService',
          default_value: 'WebSites',
          type: {
            name: 'String'
          }
        },
        gateway_site_name: {
          required: false,
          serialized_name: 'properties.gatewaySiteName',
          type: {
            name: 'String'
          }
        },
        client_affinity_enabled: {
          required: false,
          serialized_name: 'properties.clientAffinityEnabled',
          type: {
            name: 'Boolean'
          }
        },
        client_cert_enabled: {
          required: false,
          serialized_name: 'properties.clientCertEnabled',
          type: {
            name: 'Boolean'
          }
        },
        host_names_disabled: {
          required: false,
          serialized_name: 'properties.hostNamesDisabled',
          type: {
            name: 'Boolean'
          }
        },
        outbound_ip_addresses: {
          required: false,
          read_only: true,
          serialized_name: 'properties.outboundIpAddresses',
          type: {
            name: 'String'
          }
        },
        container_size: {
          required: false,
          serialized_name: 'properties.containerSize',
          type: {
            name: 'Number'
          }
        },
        daily_memory_time_quota: {
          required: false,
          serialized_name: 'properties.dailyMemoryTimeQuota',
          type: {
            name: 'Number'
          }
        },
        suspended_till: {
          required: false,
          read_only: true,
          serialized_name: 'properties.suspendedTill',
          type: {
            name: 'DateTime'
          }
        },
        max_number_of_workers: {
          required: false,
          read_only: true,
          serialized_name: 'properties.maxNumberOfWorkers',
          type: {
            name: 'Number'
          }
        },
        cloning_info: {
          required: false,
          serialized_name: 'properties.cloningInfo',
          type: {
            name: 'Composite',
            class_name: 'CloningInfo'
          }
        },
        resource_group: {
          required: false,
          read_only: true,
          serialized_name: 'properties.resourceGroup',
          type: {
            name: 'String'
          }
        },
        is_default_container: {
          required: false,
          read_only: true,
          serialized_name: 'properties.isDefaultContainer',
          type: {
            name: 'Boolean'
          }
        },
        default_host_name: {
          required: false,
          read_only: true,
          serialized_name: 'properties.defaultHostName',
          type: {
            name: 'String'
          }
        },
        slot_swap_status: {
          required: false,
          read_only: true,
          serialized_name: 'properties.slotSwapStatus',
          type: {
            name: 'Composite',
            class_name: 'SlotSwapStatus'
          }
        }
      }
    }
  }
end