Class: Azure::BatchAI::Mgmt::V2017_09_01_preview::Models::Cluster

Inherits:
Resource
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2017-09-01-preview/generated/azure_mgmt_batchai/models/cluster.rb

Overview

Contains information about a Cluster.

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

#allocation_state ⇒ AllocationState

Possible values are: steady and resizing. steady state indicates that the cluster is not resizing. There are no changes to the number of compute nodes in the cluster in progress. A cluster enters this state when it is created and when no operations are being performed on the cluster to change the number of compute nodes. resizing state indicates that the cluster is resizing; that is, compute nodes are being added to or removed from the cluster. Possible values include: ‘steady’, ‘resizing’

Returns:



73
74
75
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_batchai/models/cluster.rb', line 73

def allocation_state
  @allocation_state
end

#allocation_state_transition_time ⇒ DateTime

allocation state.

Returns:

  • (DateTime) —

    The time at which the cluster entered its current



77
78
79
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_batchai/models/cluster.rb', line 77

def allocation_state_transition_time
  @allocation_state_transition_time
end

#creation_time ⇒ DateTime

Returns The creation time of the cluster.

Returns:

  • (DateTime) —

    The creation time of the cluster.



50
51
52
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_batchai/models/cluster.rb', line 50

def creation_time
  @creation_time
end

#current_node_count ⇒ Integer

cluster.

Returns:

  • (Integer) —

    The number of compute nodes currently assigned to the



86
87
88
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_batchai/models/cluster.rb', line 86

def current_node_count
  @current_node_count
end

#errors ⇒ Array<BatchAIError>

cluster including resize and node setup task. This element contains all the errors encountered by various compute nodes during node setup.

Returns:

  • (Array<BatchAIError>) —

    Contains details of various errors on the



82
83
84
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_batchai/models/cluster.rb', line 82

def errors
  @errors
end

#node_setup ⇒ NodeSetup

Cluster.

Returns:

  • (NodeSetup) —

    Setup to be done on all compute nodes in the



40
41
42
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_batchai/models/cluster.rb', line 40

def node_setup
  @node_setup
end

#node_state_counts ⇒ NodeStateCounts

Returns Counts of various node states on the cluster.

Returns:



89
90
91
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_batchai/models/cluster.rb', line 89

def node_state_counts
  @node_state_counts
end

#provisioning_state ⇒ ProvisioningState

cluster. Possible value are: creating - Specifies that the cluster is being created. succeeded - Specifies that the cluster has been created successfully. failed - Specifies that the cluster creation has failed. deleting - Specifies that the cluster is being deleted. Possible values include: ‘creating’, ‘succeeded’, ‘failed’, ‘deleting’

Returns:



58
59
60
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_batchai/models/cluster.rb', line 58

def provisioning_state
  @provisioning_state
end

#provisioning_state_transition_time ⇒ DateTime

cluster.

Returns:

  • (DateTime) —

    The provisioning state transition time of the



62
63
64
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_batchai/models/cluster.rb', line 62

def provisioning_state_transition_time
  @provisioning_state_transition_time
end

#scale_settings ⇒ ScaleSettings

Returns Desired scale for the Cluster.

Returns:



32
33
34
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_batchai/models/cluster.rb', line 32

def scale_settings
  @scale_settings
end

#subnet ⇒ ResourceId

Returns Specifies the identifier of the subnet.

Returns:

  • (ResourceId) —

    Specifies the identifier of the subnet.



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

def subnet
  @subnet
end

#user_account_settings ⇒ UserAccountSettings

nodes.

Returns:



44
45
46
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_batchai/models/cluster.rb', line 44

def 
  
end

#virtual_machine_configuration ⇒ VirtualMachineConfiguration

data volumes.

Returns:



36
37
38
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_batchai/models/cluster.rb', line 36

def virtual_machine_configuration
  @virtual_machine_configuration
end

#vm_priority ⇒ VmPriority

dedicated. The node can get preempted while the task is running if lowpriority is chosen. This is best suited if the workload is checkpointing and can be restarted. Possible values include: ‘dedicated’, ‘lowpriority’. Default value: ‘dedicated’ .

Returns:

  • (VmPriority) —

    dedicated or lowpriority. The default value is



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

def vm_priority
  @vm_priority
end

#vm_size ⇒ String

virtual machines in a cluster are the same size. For information about available VM sizes for clusters using images from the Virtual Machines Marketplace (see Sizes for Virtual Machines (Linux) or Sizes for Virtual Machines (Windows). Batch AI service supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series).

Returns:

  • (String) —

    The size of the virtual machines in the cluster. All



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

def vm_size
  @vm_size
end

Class Method Details

.mapper ⇒ Object

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



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
 
# File 'lib/2017-09-01-preview/generated/azure_mgmt_batchai/models/cluster.rb', line 96

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: false,
          read_only: true,
          serialized_name: 'location',
          type: {
            name: 'String'
          }
        },
        tags: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'tags',
          type: {
            name: 'Dictionary',
            value: {
                client_side_validation: true,
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        vm_size: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.vmSize',
          type: {
            name: 'String'
          }
        },
        vm_priority: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.vmPriority',
          default_value: 'dedicated',
          type: {
            name: 'Enum',
            module: 'VmPriority'
          }
        },
        scale_settings: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.scaleSettings',
          type: {
            name: 'Composite',
            class_name: 'ScaleSettings'
          }
        },
        virtual_machine_configuration: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.virtualMachineConfiguration',
          type: {
            name: 'Composite',
            class_name: 'VirtualMachineConfiguration'
          }
        },
        node_setup: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.nodeSetup',
          type: {
            name: 'Composite',
            class_name: 'NodeSetup'
          }
        },
        user_account_settings: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.userAccountSettings',
          type: {
            name: 'Composite',
            class_name: 'UserAccountSettings'
          }
        },
        subnet: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.subnet',
          type: {
            name: 'Composite',
            class_name: 'ResourceId'
          }
        },
        creation_time: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.creationTime',
          type: {
            name: 'DateTime'
          }
        },
        provisioning_state: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.provisioningState',
          type: {
            name: 'Enum',
            module: 'ProvisioningState'
          }
        },
        provisioning_state_transition_time: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.provisioningStateTransitionTime',
          type: {
            name: 'DateTime'
          }
        },
        allocation_state: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.allocationState',
          type: {
            name: 'Enum',
            module: 'AllocationState'
          }
        },
        allocation_state_transition_time: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.allocationStateTransitionTime',
          type: {
            name: 'DateTime'
          }
        },
        errors: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.errors',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'BatchAIErrorElementType',
                type: {
                  name: 'Composite',
                  class_name: 'BatchAIError'
                }
            }
          }
        },
        current_node_count: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.currentNodeCount',
          type: {
            name: 'Number'
          }
        },
        node_state_counts: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.nodeStateCounts',
          type: {
            name: 'Composite',
            class_name: 'NodeStateCounts'
          }
        }
      }
    }
  }
end