Class: Azure::Web::Mgmt::V2018_02_01::Models::SitePatchResource

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

Overview

ARM resource for a site.

Instance Attribute Summary collapse

Attributes inherited from ProxyOnlyResource

#id, #kind, #name, #type

Class Method Summary collapse

Instance Attribute Details

#availability_state ⇒ SiteAvailabilityState

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

Returns:



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

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;



89
90
91
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/site_patch_resource.rb', line 89

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



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

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



129
130
131
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/site_patch_resource.rb', line 129

def cloning_info
  @cloning_info
end

#container_size ⇒ Integer

Returns Size of the function container.

Returns:

  • (Integer) —

    Size of the function container.



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

def container_size
  @container_size
end

#daily_memory_time_quota ⇒ Integer

on dynamic apps only).

Returns:

  • (Integer) —

    Maximum allowed daily memory-time quota (applicable



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

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.



140
141
142
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/site_patch_resource.rb', line 140

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,



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

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



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

def enabled_host_names
  @enabled_host_names
end

#host_name_ssl_states ⇒ Array<HostNameSslState>

manage the SSL bindings for app’s hostnames.

Returns:



45
46
47
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/site_patch_resource.rb', line 45

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.



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

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



100
101
102
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/site_patch_resource.rb', line 100

def host_names_disabled
  @host_names_disabled
end

#hosting_environment_profile ⇒ HostingEnvironmentProfile

the app.

Returns:



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

def hosting_environment_profile
  @hosting_environment_profile
end

#https_only ⇒ Boolean

requests. Issues redirect for http requests

Returns:

  • (Boolean) —

    HttpsOnly: configures a web site to accept only https



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

def https_only
  @https_only
end

#hyper_v ⇒ Boolean

Returns Hyper-V sandbox. Default value: false .

Returns:

  • (Boolean) —

    Hyper-V sandbox. Default value: false .



60
61
62
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/site_patch_resource.rb', line 60

def hyper_v
  @hyper_v
end

#is_default_container ⇒ Boolean

otherwise, false.

Returns:

  • (Boolean) —

    true if the app is a default container;



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

def is_default_container
  @is_default_container
end

#is_xenon ⇒ Boolean

Returns Obsolete: Hyper-V sandbox. Default value: false .

Returns:

  • (Boolean) —

    Obsolete: Hyper-V sandbox. Default value: false .



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

def is_xenon
  @is_xenon
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.



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

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.



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

def max_number_of_workers
  @max_number_of_workers
end

#outbound_ip_addresses ⇒ String

connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only.

Returns:

  • (String) —

    List of IP addresses that the app uses for outbound



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

def outbound_ip_addresses
  @outbound_ip_addresses
end

#possible_outbound_ip_addresses ⇒ String

connections (e.g. database access). Includes VIPs from all tenants. Read-only.

Returns:

  • (String) —

    List of IP addresses that the app uses for outbound



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

def possible_outbound_ip_addresses
  @possible_outbound_ip_addresses
end

#repository_site_name ⇒ String

Returns Name of the repository site.

Returns:

  • (String) —

    Name of the repository site.



22
23
24
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/site_patch_resource.rb', line 22

def repository_site_name
  @repository_site_name
end

#reserved ⇒ Boolean

false. Default value: false .

Returns:

  • (Boolean) —

    true if reserved; otherwise,



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

def reserved
  @reserved
end

#resource_group ⇒ String

Read-only.

Returns:

  • (String) —

    Name of the resource group the app belongs to.



133
134
135
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/site_patch_resource.rb', line 133

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



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

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,



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

def server_farm_id
  @server_farm_id
end

#site_config ⇒ SiteConfig

Returns Configuration of the app.

Returns:



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

def site_config
  @site_config
end

#slot_swap_status ⇒ SlotSwapStatus

operation.

Returns:



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

def slot_swap_status
  @slot_swap_status
end

#state ⇒ String

Returns Current state of the app.

Returns:

  • (String) —

    Current state of the app.



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

def state
  @state
end

#suspended_till ⇒ DateTime

exceeded.

Returns:

  • (DateTime) —

    App suspended till in case memory-time quota is



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

def suspended_till
  @suspended_till
end

#target_swap_slot ⇒ String

into. Read-only.

Returns:

  • (String) —

    Specifies which deployment slot this app will swap



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

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



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

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



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

def usage_state
  @usage_state
end

Class Method Details

.mapper ⇒ Object

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



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/site_patch_resource.rb', line 156

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