Class: Azure::Batch::Mgmt::V2019_08_01::Models::BatchAccount

Inherits:
Resource
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-08-01/generated/azure_mgmt_batch/models/batch_account.rb

Overview

Contains information about an Azure Batch account.

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

#account_endpoint ⇒ String

service.

Returns:

  • (String) —

    The account endpoint used to interact with the Batch



17
18
19
 
# File 'lib/2019-08-01/generated/azure_mgmt_batch/models/batch_account.rb', line 17

def 
  @account_endpoint
end

#active_job_and_job_schedule_quota ⇒ Integer

account.

Returns:

  • (Integer) —

    The active job and job schedule quota for the Batch



70
71
72
 
# File 'lib/2019-08-01/generated/azure_mgmt_batch/models/batch_account.rb', line 70

def active_job_and_job_schedule_quota
  @active_job_and_job_schedule_quota
end

#auto_storage ⇒ AutoStorageProperties

auto-storage account associated with the Batch account.

Returns:



35
36
37
 
# File 'lib/2019-08-01/generated/azure_mgmt_batch/models/batch_account.rb', line 35

def auto_storage
  @auto_storage
end

#dedicated_core_quota ⇒ Integer

accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned.

Returns:

  • (Integer) —

    The dedicated core quota for the Batch account. For



40
41
42
 
# File 'lib/2019-08-01/generated/azure_mgmt_batch/models/batch_account.rb', line 40

def dedicated_core_quota
  @dedicated_core_quota
end

#dedicated_core_quota_per_vmfamily ⇒ Array<VirtualMachineFamilyCoreQuota>

core quota per Virtual Machine family for the Batch account. For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned.

Returns:



51
52
53
 
# File 'lib/2019-08-01/generated/azure_mgmt_batch/models/batch_account.rb', line 51

def dedicated_core_quota_per_vmfamily
  @dedicated_core_quota_per_vmfamily
end

#dedicated_core_quota_per_vmfamily_enforced ⇒ Boolean

Batch Account is enforced per Virtual Machine family or not. Batch is transitioning its core quota system for dedicated cores to be enforced per Virtual Machine family. During this transitional phase, the dedicated core quota per Virtual Machine family may not yet be enforced. If this flag is false, dedicated core quota is enforced via the old dedicatedCoreQuota property on the account and does not consider Virtual Machine family. If this flag is true, dedicated core quota is enforced via the dedicatedCoreQuotaPerVMFamily property on the account, and the old dedicatedCoreQuota does not apply.

Returns:

  • (Boolean) —

    A value indicating whether the core quota for the



63
64
65
 
# File 'lib/2019-08-01/generated/azure_mgmt_batch/models/batch_account.rb', line 63

def dedicated_core_quota_per_vmfamily_enforced
  @dedicated_core_quota_per_vmfamily_enforced
end

#key_vault_reference ⇒ KeyVaultReference

associated with the Batch account.

Returns:



31
32
33
 
# File 'lib/2019-08-01/generated/azure_mgmt_batch/models/batch_account.rb', line 31

def key_vault_reference
  @key_vault_reference
end

#low_priority_core_quota ⇒ Integer

For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned.

Returns:

  • (Integer) —

    The low-priority core quota for the Batch account.



45
46
47
 
# File 'lib/2019-08-01/generated/azure_mgmt_batch/models/batch_account.rb', line 45

def low_priority_core_quota
  @low_priority_core_quota
end

#pool_allocation_mode ⇒ PoolAllocationMode

pools in the Batch account. Possible values include: ‘BatchService’, ‘UserSubscription’

Returns:



27
28
29
 
# File 'lib/2019-08-01/generated/azure_mgmt_batch/models/batch_account.rb', line 27

def pool_allocation_mode
  @pool_allocation_mode
end

#pool_quota ⇒ Integer

Returns The pool quota for the Batch account.

Returns:

  • (Integer) —

    The pool quota for the Batch account.



66
67
68
 
# File 'lib/2019-08-01/generated/azure_mgmt_batch/models/batch_account.rb', line 66

def pool_quota
  @pool_quota
end

#provisioning_state ⇒ ProvisioningState

Possible values include: ‘Invalid’, ‘Creating’, ‘Deleting’, ‘Succeeded’, ‘Failed’, ‘Cancelled’

Returns:



22
23
24
 
# File 'lib/2019-08-01/generated/azure_mgmt_batch/models/batch_account.rb', line 22

def provisioning_state
  @provisioning_state
end

Class Method Details

.mapper ⇒ Object

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



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
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
 
# File 'lib/2019-08-01/generated/azure_mgmt_batch/models/batch_account.rb', line 77

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'BatchAccount',
    type: {
      name: 'Composite',
      class_name: 'BatchAccount',
      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'
                }
            }
          }
        },
        account_endpoint: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.accountEndpoint',
          type: {
            name: 'String'
          }
        },
        provisioning_state: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.provisioningState',
          type: {
            name: 'Enum',
            module: 'ProvisioningState'
          }
        },
        pool_allocation_mode: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.poolAllocationMode',
          type: {
            name: 'Enum',
            module: 'PoolAllocationMode'
          }
        },
        key_vault_reference: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.keyVaultReference',
          type: {
            name: 'Composite',
            class_name: 'KeyVaultReference'
          }
        },
        auto_storage: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.autoStorage',
          type: {
            name: 'Composite',
            class_name: 'AutoStorageProperties'
          }
        },
        dedicated_core_quota: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.dedicatedCoreQuota',
          type: {
            name: 'Number'
          }
        },
        low_priority_core_quota: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.lowPriorityCoreQuota',
          type: {
            name: 'Number'
          }
        },
        dedicated_core_quota_per_vmfamily: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.dedicatedCoreQuotaPerVMFamily',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'VirtualMachineFamilyCoreQuotaElementType',
                type: {
                  name: 'Composite',
                  class_name: 'VirtualMachineFamilyCoreQuota'
                }
            }
          }
        },
        dedicated_core_quota_per_vmfamily_enforced: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.dedicatedCoreQuotaPerVMFamilyEnforced',
          type: {
            name: 'Boolean'
          }
        },
        pool_quota: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.poolQuota',
          type: {
            name: 'Number'
          }
        },
        active_job_and_job_schedule_quota: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.activeJobAndJobScheduleQuota',
          type: {
            name: 'Number'
          }
        }
      }
    }
  }
end