Class: Azure::ServiceFabric::Mgmt::V2018_02_01::Models::Cluster

Inherits:
Resource
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2018-02-01/generated/azure_mgmt_service_fabric/models/cluster.rb

Overview

The cluster resource

Instance Attribute Summary collapse

Attributes inherited from Resource

#id, #location, #name, #tags, #type

Class Method Summary collapse

Methods inherited from Resource

#resource_group

Instance Attribute Details

#add_on_features ⇒ Array<Enum>

cluster.

Returns:

  • (Array<Enum>) —

    The list of add-on features to enable in the



18
19
20
 
# File 'lib/2018-02-01/generated/azure_mgmt_service_fabric/models/cluster.rb', line 18

def add_on_features
  @add_on_features
end

#available_cluster_versions ⇒ Array<ClusterVersionDetails>

versions available for this cluster.

Returns:



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

def available_cluster_versions
  @available_cluster_versions
end

#azure_active_directory ⇒ AzureActiveDirectory

cluster.

Returns:



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

def azure_active_directory
  @azure_active_directory
end

#certificate ⇒ CertificateDescription

the cluster. The certificate provided will be used for node to node security within the cluster, SSL certificate for cluster management endpoint and default admin client.

Returns:



32
33
34
 
# File 'lib/2018-02-01/generated/azure_mgmt_service_fabric/models/cluster.rb', line 32

def certificate
  @certificate
end

#certificate_common_names ⇒ ServerCertificateCommonNames

certificates referenced by common name that are used to secure the cluster.

Returns:



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

def certificate_common_names
  @certificate_common_names
end

#client_certificate_common_names ⇒ Array<ClientCertificateCommonName>

certificates referenced by common name that are allowed to manage the cluster.

Returns:



42
43
44
 
# File 'lib/2018-02-01/generated/azure_mgmt_service_fabric/models/cluster.rb', line 42

def client_certificate_common_names
  @client_certificate_common_names
end

#client_certificate_thumbprints ⇒ Array<ClientCertificateThumbprint>

certificates referenced by thumbprint that are allowed to manage the cluster.

Returns:



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

def client_certificate_thumbprints
  @client_certificate_thumbprints
end

#cluster_code_version ⇒ String

This property can only by set the user when upgradeMode is set to ‘Manual’. To get list of available Service Fabric versions for new clusters use [ClusterVersion API](./ClusterVersion.md). To get the list of available version for existing clusters use availableClusterVersions.

Returns:

  • (String) —

    The Service Fabric runtime version of the cluster.



55
56
57
 
# File 'lib/2018-02-01/generated/azure_mgmt_service_fabric/models/cluster.rb', line 55

def cluster_code_version
  @cluster_code_version
end

#cluster_endpoint ⇒ String

in the cluster connects to this endpoint.

Returns:

  • (String) —

    The Azure Resource Provider endpoint. A system service



59
60
61
 
# File 'lib/2018-02-01/generated/azure_mgmt_service_fabric/models/cluster.rb', line 59

def cluster_endpoint
  @cluster_endpoint
end

#cluster_id ⇒ String

resource.

Returns:

  • (String) —

    A service generated unique identifier for the cluster



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

def cluster_id
  @cluster_id
end

#cluster_state ⇒ Enum

  • WaitingForNodes - Indicates that the cluster resource is created and

the resource provider is waiting for Service Fabric VM extension to boot up and report to it.

  • Deploying - Indicates that the Service Fabric runtime is being

installed on the VMs. Cluster resource will be in this state until the cluster boots up and system services are up.

  • BaselineUpgrade - Indicates that the cluster is upgrading to

establishes the cluster version. This upgrade is automatically initiated when the cluster boots up for the first time.

  • UpdatingUserConfiguration - Indicates that the cluster is being

upgraded with the user provided configuration.

  • UpdatingUserCertificate - Indicates that the cluster is being

upgraded with the user provided certificate.

  • UpdatingInfrastructure - Indicates that the cluster is being upgraded

with the latest Service Fabric runtime version. This happens only when the upgradeMode is set to ‘Automatic’.

  • EnforcingClusterVersion - Indicates that cluster is on a different

version than expected and the cluster is being upgraded to the expected version.

  • UpgradeServiceUnreachable - Indicates that the system service in the

cluster is no longer polling the Resource Provider. Clusters in this state cannot be managed by the Resource Provider.

  • AutoScale - Indicates that the ReliabilityLevel of the cluster is

being adjusted.

  • Ready - Indicates that the cluster is in a stable state.

. Possible values include: ‘WaitingForNodes’, ‘Deploying’, ‘BaselineUpgrade’, ‘UpdatingUserConfiguration’, ‘UpdatingUserCertificate’, ‘UpdatingInfrastructure’, ‘EnforcingClusterVersion’, ‘UpgradeServiceUnreachable’, ‘AutoScale’, ‘Ready’

Returns:

  • (Enum) —

    The current state of the cluster.



97
98
99
 
# File 'lib/2018-02-01/generated/azure_mgmt_service_fabric/models/cluster.rb', line 97

def cluster_state
  @cluster_state
end

#diagnostics_storage_account_config ⇒ DiagnosticsStorageAccountConfig

information for storing Service Fabric diagnostic logs.

Returns:



101
102
103
 
# File 'lib/2018-02-01/generated/azure_mgmt_service_fabric/models/cluster.rb', line 101

def 
  @diagnostics_storage_account_config
end

#fabric_settings ⇒ Array<SettingsSectionDescription>

settings to configure the cluster.

Returns:



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

def fabric_settings
  @fabric_settings
end

#management_endpoint ⇒ String

Returns The http management endpoint of the cluster.

Returns:

  • (String) —

    The http management endpoint of the cluster.



108
109
110
 
# File 'lib/2018-02-01/generated/azure_mgmt_service_fabric/models/cluster.rb', line 108

def management_endpoint
  @management_endpoint
end

#node_types ⇒ Array<NodeTypeDescription>

cluster.

Returns:



112
113
114
 
# File 'lib/2018-02-01/generated/azure_mgmt_service_fabric/models/cluster.rb', line 112

def node_types
  @node_types
end

#provisioning_state ⇒ ProvisioningState

resource. Possible values include: ‘Updating’, ‘Succeeded’, ‘Failed’, ‘Canceled’

Returns:



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

def provisioning_state
  @provisioning_state
end

#reliability_level ⇒ Enum

system services. Learn about [ReliabilityLevel](docs.microsoft.com/en-us/azure/service-fabric/service-fabric-cluster-capacity).

  • None - Run the System services with a target replica set count of 1.

This should only be used for test clusters.

  • Bronze - Run the System services with a target replica set count of

  1. This should only be used for test clusters.

  • Silver - Run the System services with a target replica set count of

5.

  • Gold - Run the System services with a target replica set count of 7.

  • Platinum - Run the System services with a target replica set count of

9. . Possible values include: ‘None’, ‘Bronze’, ‘Silver’, ‘Gold’, ‘Platinum’

Returns:

  • (Enum) —

    The reliability level sets the replica set size of



134
135
136
 
# File 'lib/2018-02-01/generated/azure_mgmt_service_fabric/models/cluster.rb', line 134

def reliability_level
  @reliability_level
end

#reverse_proxy_certificate ⇒ CertificateDescription

proxy.

Returns:



138
139
140
 
# File 'lib/2018-02-01/generated/azure_mgmt_service_fabric/models/cluster.rb', line 138

def reverse_proxy_certificate
  @reverse_proxy_certificate
end

#reverse_proxy_certificate_common_names ⇒ ServerCertificateCommonNames

certificates referenced by common name that are used to secure the cluster.

Returns:



143
144
145
 
# File 'lib/2018-02-01/generated/azure_mgmt_service_fabric/models/cluster.rb', line 143

def reverse_proxy_certificate_common_names
  @reverse_proxy_certificate_common_names
end

#upgrade_description ⇒ ClusterUpgradePolicy

cluster.

Returns:



147
148
149
 
# File 'lib/2018-02-01/generated/azure_mgmt_service_fabric/models/cluster.rb', line 147

def upgrade_description
  @upgrade_description
end

#upgrade_mode ⇒ Enum

runtime version is available.

  • Automatic - The cluster will be automatically upgraded to the latest

Service Fabric runtime version as soon as it is available.

  • Manual - The cluster will not be automatically upgraded to the latest

Service Fabric runtime version. The cluster is upgraded by setting the clusterCodeVersion property in the cluster resource. . Possible values include: ‘Automatic’, ‘Manual’

Returns:

  • (Enum) —

    The upgrade mode of the cluster when new Service Fabric



158
159
160
 
# File 'lib/2018-02-01/generated/azure_mgmt_service_fabric/models/cluster.rb', line 158

def upgrade_mode
  @upgrade_mode
end

#vm_image ⇒ String

names such as Windows or Linux can be used.

Returns:

  • (String) —

    The VM image VMSS has been configured with. Generic



162
163
164
 
# File 'lib/2018-02-01/generated/azure_mgmt_service_fabric/models/cluster.rb', line 162

def vm_image
  @vm_image
end

Class Method Details

.mapper ⇒ Object

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



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
 
# File 'lib/2018-02-01/generated/azure_mgmt_service_fabric/models/cluster.rb', line 169

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'Cluster',
    type: {
      name: 'Composite',
      class_name: 'Cluster',
      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'
          }
        },
        type: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'type',
          type: {
            name: 'String'
          }
        },
        location: {
          client_side_validation: true,
          required: true,
          serialized_name: 'location',
          type: {
            name: 'String'
          }
        },
        tags: {
          client_side_validation: true,
          required: false,
          serialized_name: 'tags',
          type: {
            name: 'Dictionary',
            value: {
                client_side_validation: true,
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        add_on_features: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.addOnFeatures',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'enumElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        available_cluster_versions: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.availableClusterVersions',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'ClusterVersionDetailsElementType',
                type: {
                  name: 'Composite',
                  class_name: 'ClusterVersionDetails'
                }
            }
          }
        },
        azure_active_directory: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.azureActiveDirectory',
          type: {
            name: 'Composite',
            class_name: 'AzureActiveDirectory'
          }
        },
        certificate: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.certificate',
          type: {
            name: 'Composite',
            class_name: 'CertificateDescription'
          }
        },
        certificate_common_names: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.certificateCommonNames',
          type: {
            name: 'Composite',
            class_name: 'ServerCertificateCommonNames'
          }
        },
        client_certificate_common_names: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.clientCertificateCommonNames',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'ClientCertificateCommonNameElementType',
                type: {
                  name: 'Composite',
                  class_name: 'ClientCertificateCommonName'
                }
            }
          }
        },
        client_certificate_thumbprints: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.clientCertificateThumbprints',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'ClientCertificateThumbprintElementType',
                type: {
                  name: 'Composite',
                  class_name: 'ClientCertificateThumbprint'
                }
            }
          }
        },
        cluster_code_version: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.clusterCodeVersion',
          type: {
            name: 'String'
          }
        },
        cluster_endpoint: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.clusterEndpoint',
          type: {
            name: 'String'
          }
        },
        cluster_id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.clusterId',
          type: {
            name: 'String'
          }
        },
        cluster_state: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.clusterState',
          type: {
            name: 'String'
          }
        },
        diagnostics_storage_account_config: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.diagnosticsStorageAccountConfig',
          type: {
            name: 'Composite',
            class_name: 'DiagnosticsStorageAccountConfig'
          }
        },
        fabric_settings: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.fabricSettings',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'SettingsSectionDescriptionElementType',
                type: {
                  name: 'Composite',
                  class_name: 'SettingsSectionDescription'
                }
            }
          }
        },
        management_endpoint: {
          client_side_validation: true,
          required: true,
          serialized_name: 'properties.managementEndpoint',
          type: {
            name: 'String'
          }
        },
        node_types: {
          client_side_validation: true,
          required: true,
          serialized_name: 'properties.nodeTypes',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'NodeTypeDescriptionElementType',
                type: {
                  name: 'Composite',
                  class_name: 'NodeTypeDescription'
                }
            }
          }
        },
        provisioning_state: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.provisioningState',
          type: {
            name: 'String'
          }
        },
        reliability_level: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.reliabilityLevel',
          type: {
            name: 'String'
          }
        },
        reverse_proxy_certificate: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.reverseProxyCertificate',
          type: {
            name: 'Composite',
            class_name: 'CertificateDescription'
          }
        },
        reverse_proxy_certificate_common_names: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.reverseProxyCertificateCommonNames',
          type: {
            name: 'Composite',
            class_name: 'ServerCertificateCommonNames'
          }
        },
        upgrade_description: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.upgradeDescription',
          type: {
            name: 'Composite',
            class_name: 'ClusterUpgradePolicy'
          }
        },
        upgrade_mode: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.upgradeMode',
          type: {
            name: 'String'
          }
        },
        vm_image: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.vmImage',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end