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

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

Overview

Represents a web app

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#availability_state ⇒ SiteAvailabilityState

state for the web app. Possible values are Normal or Limited. Normal means that the site is running correctly and that management information for the site is available. Limited means that only partial management information for the site is available and that detailed site information is unavailable. Possible values include: ‘Normal’, ‘Limited’, ‘DisasterRecoveryMode’

Returns:



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

def availability_state
  @availability_state
end

#client_affinity_enabled ⇒ Boolean

load balancing http request for multiple instances of the web app

Returns:

  • (Boolean) —

    Specifies if the client affinity is enabled when



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

def client_affinity_enabled
  @client_affinity_enabled
end

#client_cert_enabled ⇒ Boolean

the web app

Returns:

  • (Boolean) —

    Specifies if the client certificate is enabled for



97
98
99
 
# File 'lib/generated/azure_mgmt_web/models/site.rb', line 97

def client_cert_enabled
  @client_cert_enabled
end

#cloning_info ⇒ CloningInfo

specified, web app is cloned from a source web app

Returns:

  • (CloningInfo) —

    This is only valid for web app creation. If



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

def cloning_info
  @cloning_info
end

#container_size ⇒ Integer

Returns Size of a function container.

Returns:

  • (Integer) —

    Size of a function container



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

def container_size
  @container_size
end

#default_host_name ⇒ String

Returns Default hostname of the web app.

Returns:

  • (String) —

    Default hostname of the web app



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

def default_host_name
  @default_host_name
end

#enabled ⇒ Boolean

Setting this value to false disables the site (takes the site off line).

Returns:

  • (Boolean) —

    True if the site is enabled; otherwise, false.



34
35
36
 
# File 'lib/generated/azure_mgmt_web/models/site.rb', line 34

def enabled
  @enabled
end

#enabled_host_names ⇒ Array<String>

Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled the app is not served on those hostnames

Returns:

  • (Array<String>) —

    Hostnames for the web app that are enabled.



40
41
42
 
# File 'lib/generated/azure_mgmt_web/models/site.rb', line 40

def enabled_host_names
  @enabled_host_names
end

#gateway_site_name ⇒ String

Returns Name of gateway app associated with web app.

Returns:

  • (String) —

    Name of gateway app associated with web app



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

def gateway_site_name
  @gateway_site_name
end

#host_name_ssl_states ⇒ Array<HostNameSslState>

manage the SSL bindings for site’s hostnames.

Returns:



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

def host_name_ssl_states
  @host_name_ssl_states
end

#host_names ⇒ Array<String>

Returns Hostnames associated with web app.

Returns:

  • (Array<String>) —

    Hostnames associated with web app



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

def host_names
  @host_names
end

#host_names_disabled ⇒ Boolean

web app. If set to true the app is only accessible via API Management process

Returns:

  • (Boolean) —

    Specifies if the public hostnames are disabled the



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

def host_names_disabled
  @host_names_disabled
end

#hosting_environment_profile ⇒ HostingEnvironmentProfile

environment (App Service Environment) to use for the web app

Returns:



83
84
85
 
# File 'lib/generated/azure_mgmt_web/models/site.rb', line 83

def hosting_environment_profile
  @hosting_environment_profile
end

#is_default_container ⇒ Boolean

Returns Site is a default container.

Returns:

  • (Boolean) —

    Site is a default container



126
127
128
 
# File 'lib/generated/azure_mgmt_web/models/site.rb', line 126

def is_default_container
  @is_default_container
end

#last_modified_time_utc ⇒ DateTime

Returns Last time web app was modified in UTC.

Returns:

  • (DateTime) —

    Last time web app was modified in UTC



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

def last_modified_time_utc
  @last_modified_time_utc
end

#max_number_of_workers ⇒ Integer

This only applies to function container

Returns:

  • (Integer) —

    Maximum number of workers



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

def max_number_of_workers
  @max_number_of_workers
end

#micro_service ⇒ String

Returns:

  • (String) 


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

def micro_service
  @micro_service
end

#outbound_ip_addresses ⇒ String

app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app.

Returns:

  • (String) —

    List of comma separated IP addresses that this web



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

def outbound_ip_addresses
  @outbound_ip_addresses
end

#premium_app_deployed ⇒ Boolean

premium app

Returns:

  • (Boolean) —

    If set indicates whether web app is deployed as a



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

def premium_app_deployed
  @premium_app_deployed
end

#repository_site_name ⇒ String

Returns Name of repository site.

Returns:

  • (String) —

    Name of repository site



25
26
27
 
# File 'lib/generated/azure_mgmt_web/models/site.rb', line 25

def repository_site_name
  @repository_site_name
end

#resource_group ⇒ String

Returns Resource group web app belongs to.

Returns:

  • (String) —

    Resource group web app belongs to



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

def resource_group
  @resource_group
end

#scm_site_also_stopped ⇒ Boolean

when the web app is stopped. Default is false.

Returns:

  • (Boolean) —

    If set indicates whether to stop SCM (KUDU) site



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

def scm_site_also_stopped
  @scm_site_also_stopped
end

#server_farm_id ⇒ String

Returns:

  • (String) 


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

def server_farm_id
  @server_farm_id
end

#site_config ⇒ SiteConfig

Returns Configuration of web app.

Returns:



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

def site_config
  @site_config
end

#site_name ⇒ String

Returns Name of web app.

Returns:

  • (String) —

    Name of web app



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

def site_name
  @site_name
end

#state ⇒ String

Returns State of the web app.

Returns:

  • (String) —

    State of the web app



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

def state
  @state
end

#target_swap_slot ⇒ String

will swap into

Returns:

  • (String) —

    Read-only property that specifies which slot this app



79
80
81
 
# File 'lib/generated/azure_mgmt_web/models/site.rb', line 79

def target_swap_slot
  @target_swap_slot
end

#traffic_manager_host_names ⇒ Array<String>

hostnames associated with web app

Returns:

  • (Array<String>) —

    Read-only list of Azure Traffic manager



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

def traffic_manager_host_names
  @traffic_manager_host_names
end

#usage_state ⇒ UsageState

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

Returns:

  • (UsageState) —

    State indicating whether web app has exceeded its



29
30
31
 
# File 'lib/generated/azure_mgmt_web/models/site.rb', line 29

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.



136
137
138
139
140
141
142
143
144
145
146
147
148
149
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
 
# File 'lib/generated/azure_mgmt_web/models/site.rb', line 136

def self.mapper()
  {
    required: false,
    serialized_name: 'Site',
    type: {
      name: 'Composite',
      class_name: 'Site',
      model_properties: {
        id: {
          required: false,
          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'
                }
            }
          }
        },
        site_name: {
          required: false,
          serialized_name: 'properties.name',
          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'
          }
        },
        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',
          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',
          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'
          }
        },
        max_number_of_workers: {
          required: false,
          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'
          }
        }
      }
    }
  }
end