Class: Azure::Web::Mgmt::V2018_02_01::Models::AppServicePlanPatchResource

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

Overview

ARM resource for a app service plan.

Instance Attribute Summary collapse

Attributes inherited from ProxyOnlyResource

#id, #kind, #name, #type

Class Method Summary collapse

Instance Attribute Details

#admin_site_name ⇒ String

Returns App Service plan administration site.

Returns:

  • (String) —

    App Service plan administration site.



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

def admin_site_name
  @admin_site_name
end

#free_offer_expiration_time ⇒ DateTime

Returns The time when the server farm free offer expires.

Returns:

  • (DateTime) —

    The time when the server farm free offer expires.



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

def free_offer_expiration_time
  @free_offer_expiration_time
end

#geo_region ⇒ String

Returns Geographical location for the App Service plan.

Returns:

  • (String) —

    Geographical location for the App Service plan.



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

def geo_region
  @geo_region
end

#hosting_environment_profile ⇒ HostingEnvironmentProfile

Environment to use for the App Service plan.

Returns:



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

def hosting_environment_profile
  @hosting_environment_profile
end

#hyper_v ⇒ Boolean

true, false otherwise. Default value: false .

Returns:

  • (Boolean) —

    If Hyper-V container app service plan



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

def hyper_v
  @hyper_v
end

#is_spot ⇒ Boolean

instances.

Returns:

  • (Boolean) —

    If true, this App Service Plan owns spot



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

def is_spot
  @is_spot
end

#is_xenon ⇒ Boolean

true, false otherwise. Default value: false .

Returns:

  • (Boolean) —

    Obsolete: If Hyper-V container app service plan



72
73
74
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/app_service_plan_patch_resource.rb', line 72

def is_xenon
  @is_xenon
end

#maximum_elastic_worker_count ⇒ Integer

ElasticScaleEnabled App Service Plan

Returns:

  • (Integer) —

    Maximum number of total workers allowed for this



47
48
49
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/app_service_plan_patch_resource.rb', line 47

def maximum_elastic_worker_count
  @maximum_elastic_worker_count
end

#maximum_number_of_workers ⇒ Integer

this App Service plan.

Returns:

  • (Integer) —

    Maximum number of instances that can be assigned to



34
35
36
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/app_service_plan_patch_resource.rb', line 34

def maximum_number_of_workers
  @maximum_number_of_workers
end

#number_of_sites ⇒ Integer

Returns Number of apps assigned to this App Service plan.

Returns:

  • (Integer) —

    Number of apps assigned to this App Service plan.



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

def number_of_sites
  @number_of_sites
end

#per_site_scaling ⇒ Boolean

Service plan can be scaled independently. If false, apps assigned to this App Service plan will scale to all instances of the plan. Default value: false .

Returns:

  • (Boolean) —

    If true, apps assigned to this App



43
44
45
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/app_service_plan_patch_resource.rb', line 43

def per_site_scaling
  @per_site_scaling
end

#provisioning_state ⇒ ProvisioningState

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

Returns:



87
88
89
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/app_service_plan_patch_resource.rb', line 87

def provisioning_state
  @provisioning_state
end

#reserved ⇒ Boolean

false otherwise. Default value: false .

Returns:

  • (Boolean) —

    If Linux app service plan true,



68
69
70
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/app_service_plan_patch_resource.rb', line 68

def reserved
  @reserved
end

#resource_group ⇒ String

Returns Resource group of the App Service plan.

Returns:

  • (String) —

    Resource group of the App Service plan.



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

def resource_group
  @resource_group
end

#spot_expiration_time ⇒ DateTime

it is a spot server farm.

Returns:

  • (DateTime) —

    The time when the server farm expires. Valid only if



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

def spot_expiration_time
  @spot_expiration_time
end

#status ⇒ StatusOptions

include: ‘Ready’, ‘Pending’, ‘Creating’

Returns:



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

def status
  @status
end

#subscription ⇒ String

Returns App Service plan subscription.

Returns:

  • (String) —

    App Service plan subscription.



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

def subscription
  @subscription
end

#target_worker_count ⇒ Integer

Returns Scaling worker count.

Returns:

  • (Integer) —

    Scaling worker count.



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

def target_worker_count
  @target_worker_count
end

#target_worker_size_id ⇒ Integer

Returns Scaling worker size ID.

Returns:

  • (Integer) —

    Scaling worker size ID.



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

def target_worker_size_id
  @target_worker_size_id
end

#worker_tier_name ⇒ String

Returns Target worker tier assigned to the App Service plan.

Returns:

  • (String) —

    Target worker tier assigned to the App Service plan.



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

def worker_tier_name
  @worker_tier_name
end

Class Method Details

.mapper ⇒ Object

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



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
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
 
# File 'lib/2018-02-01/generated/azure_mgmt_web/models/app_service_plan_patch_resource.rb', line 94

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'AppServicePlanPatchResource',
    type: {
      name: 'Composite',
      class_name: 'AppServicePlanPatchResource',
      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'
          }
        },
        worker_tier_name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.workerTierName',
          type: {
            name: 'String'
          }
        },
        status: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.status',
          type: {
            name: 'Enum',
            module: 'StatusOptions'
          }
        },
        subscription: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.subscription',
          type: {
            name: 'String'
          }
        },
        admin_site_name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.adminSiteName',
          type: {
            name: 'String'
          }
        },
        hosting_environment_profile: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.hostingEnvironmentProfile',
          type: {
            name: 'Composite',
            class_name: 'HostingEnvironmentProfile'
          }
        },
        maximum_number_of_workers: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.maximumNumberOfWorkers',
          type: {
            name: 'Number'
          }
        },
        geo_region: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.geoRegion',
          type: {
            name: 'String'
          }
        },
        per_site_scaling: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.perSiteScaling',
          default_value: false,
          type: {
            name: 'Boolean'
          }
        },
        maximum_elastic_worker_count: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.maximumElasticWorkerCount',
          type: {
            name: 'Number'
          }
        },
        number_of_sites: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.numberOfSites',
          type: {
            name: 'Number'
          }
        },
        is_spot: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.isSpot',
          type: {
            name: 'Boolean'
          }
        },
        spot_expiration_time: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.spotExpirationTime',
          type: {
            name: 'DateTime'
          }
        },
        free_offer_expiration_time: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.freeOfferExpirationTime',
          type: {
            name: 'DateTime'
          }
        },
        resource_group: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.resourceGroup',
          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'
          }
        },
        target_worker_count: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.targetWorkerCount',
          type: {
            name: 'Number'
          }
        },
        target_worker_size_id: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.targetWorkerSizeId',
          type: {
            name: 'Number'
          }
        },
        provisioning_state: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.provisioningState',
          type: {
            name: 'Enum',
            module: 'ProvisioningState'
          }
        }
      }
    }
  }
end