Class: Azure::ServiceFabric::Mgmt::V2017_07_01_preview::Models::Cluster

Inherits:
Resource
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2017-07-01-preview/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



104
105
106
 
# File 'lib/2017-07-01-preview/generated/azure_mgmt_service_fabric/models/cluster.rb', line 104

def add_on_features
  @add_on_features
end

#available_cluster_versions ⇒ Array<ClusterVersionDetails>

versions available for this cluster.

Returns:



18
19
20
 
# File 'lib/2017-07-01-preview/generated/azure_mgmt_service_fabric/models/cluster.rb', line 18

def available_cluster_versions
  @available_cluster_versions
end

#azure_active_directory ⇒ AzureActiveDirectory

cluster.

Returns:



83
84
85
 
# File 'lib/2017-07-01-preview/generated/azure_mgmt_service_fabric/models/cluster.rb', line 83

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:



47
48
49
 
# File 'lib/2017-07-01-preview/generated/azure_mgmt_service_fabric/models/cluster.rb', line 47

def certificate
  @certificate
end

#client_certificate_common_names ⇒ Array<ClientCertificateCommonName>

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

Returns:



64
65
66
 
# File 'lib/2017-07-01-preview/generated/azure_mgmt_service_fabric/models/cluster.rb', line 64

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:



59
60
61
 
# File 'lib/2017-07-01-preview/generated/azure_mgmt_service_fabric/models/cluster.rb', line 59

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.



41
42
43
 
# File 'lib/2017-07-01-preview/generated/azure_mgmt_service_fabric/models/cluster.rb', line 41

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



33
34
35
 
# File 'lib/2017-07-01-preview/generated/azure_mgmt_service_fabric/models/cluster.rb', line 33

def cluster_endpoint
  @cluster_endpoint
end

#cluster_id ⇒ String

resource.

Returns:

  • (String) —

    A service generated unique identifier for the cluster



22
23
24
 
# File 'lib/2017-07-01-preview/generated/azure_mgmt_service_fabric/models/cluster.rb', line 22

def cluster_id
  @cluster_id
end

#cluster_state ⇒ Enum

‘BaselineUpgrade’, ‘UpdatingUserConfiguration’, ‘UpdatingUserCertificate’, ‘UpdatingInfrastructure’, ‘EnforcingClusterVersion’, ‘UpgradeServiceUnreachable’, ‘AutoScale’, ‘Ready’

Returns:

  • (Enum) —

    Possible values include: ‘WaitingForNodes’, ‘Deploying’,



29
30
31
 
# File 'lib/2017-07-01-preview/generated/azure_mgmt_service_fabric/models/cluster.rb', line 29

def cluster_state
  @cluster_state
end

#diagnostics_storage_account_config ⇒ DiagnosticsStorageAccountConfig

information for storing Service Fabric diagnostic logs.

Returns:



96
97
98
 
# File 'lib/2017-07-01-preview/generated/azure_mgmt_service_fabric/models/cluster.rb', line 96

def 
  
end

#fabric_settings ⇒ Array<SettingsSectionDescription>

settings to configure the cluster.

Returns:



68
69
70
 
# File 'lib/2017-07-01-preview/generated/azure_mgmt_service_fabric/models/cluster.rb', line 68

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.



75
76
77
 
# File 'lib/2017-07-01-preview/generated/azure_mgmt_service_fabric/models/cluster.rb', line 75

def management_endpoint
  @management_endpoint
end

#node_types ⇒ Array<NodeTypeDescription>

cluster.

Returns:



79
80
81
 
# File 'lib/2017-07-01-preview/generated/azure_mgmt_service_fabric/models/cluster.rb', line 79

def node_types
  @node_types
end

#provisioning_state ⇒ ProvisioningState

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

Returns:



88
89
90
 
# File 'lib/2017-07-01-preview/generated/azure_mgmt_service_fabric/models/cluster.rb', line 88

def provisioning_state
  @provisioning_state
end

#reliability_level ⇒ Enum

‘Gold’, ‘Platinum’

Returns:

  • (Enum) —

    Possible values include: ‘None’, ‘Bronze’, ‘Silver’,



51
52
53
 
# File 'lib/2017-07-01-preview/generated/azure_mgmt_service_fabric/models/cluster.rb', line 51

def reliability_level
  @reliability_level
end

#reverse_proxy_certificate ⇒ CertificateDescription

proxy.

Returns:



72
73
74
 
# File 'lib/2017-07-01-preview/generated/azure_mgmt_service_fabric/models/cluster.rb', line 72

def reverse_proxy_certificate
  @reverse_proxy_certificate
end

#upgrade_description ⇒ ClusterUpgradePolicy

cluster.

Returns:



100
101
102
 
# File 'lib/2017-07-01-preview/generated/azure_mgmt_service_fabric/models/cluster.rb', line 100

def upgrade_description
  @upgrade_description
end

#upgrade_mode ⇒ Enum

Returns Possible values include: ‘Automatic’, ‘Manual’.

Returns:

  • (Enum) —

    Possible values include: ‘Automatic’, ‘Manual’



54
55
56
 
# File 'lib/2017-07-01-preview/generated/azure_mgmt_service_fabric/models/cluster.rb', line 54

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



92
93
94
 
# File 'lib/2017-07-01-preview/generated/azure_mgmt_service_fabric/models/cluster.rb', line 92

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.



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
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
 
# File 'lib/2017-07-01-preview/generated/azure_mgmt_service_fabric/models/cluster.rb', line 111

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'
                }
            }
          }
        },
        available_cluster_versions: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.availableClusterVersions',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'ClusterVersionDetailsElementType',
                type: {
                  name: 'Composite',
                  class_name: 'ClusterVersionDetails'
                }
            }
          }
        },
        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,
          serialized_name: 'properties.clusterState',
          type: {
            name: 'String'
          }
        },
        cluster_endpoint: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.clusterEndpoint',
          type: {
            name: 'String'
          }
        },
        cluster_code_version: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.clusterCodeVersion',
          type: {
            name: 'String'
          }
        },
        certificate: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.certificate',
          type: {
            name: 'Composite',
            class_name: 'CertificateDescription'
          }
        },
        reliability_level: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.reliabilityLevel',
          type: {
            name: 'String'
          }
        },
        upgrade_mode: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.upgradeMode',
          type: {
            name: 'String'
          }
        },
        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'
                }
            }
          }
        },
        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'
                }
            }
          }
        },
        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'
                }
            }
          }
        },
        reverse_proxy_certificate: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.reverseProxyCertificate',
          type: {
            name: 'Composite',
            class_name: 'CertificateDescription'
          }
        },
        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'
                }
            }
          }
        },
        azure_active_directory: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.azureActiveDirectory',
          type: {
            name: 'Composite',
            class_name: 'AzureActiveDirectory'
          }
        },
        provisioning_state: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.provisioningState',
          type: {
            name: 'String'
          }
        },
        vm_image: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.vmImage',
          type: {
            name: 'String'
          }
        },
        diagnostics_storage_account_config: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.diagnosticsStorageAccountConfig',
          type: {
            name: 'Composite',
            class_name: 'DiagnosticsStorageAccountConfig'
          }
        },
        upgrade_description: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.upgradeDescription',
          type: {
            name: 'Composite',
            class_name: 'ClusterUpgradePolicy'
          }
        },
        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'
                }
            }
          }
        }
      }
    }
  }
end