Class: Azure::ContainerService::Mgmt::V2020_12_01::Models::ManagedCluster

Inherits:
Resource
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2020-12-01/generated/azure_mgmt_container_service/models/managed_cluster.rb

Overview

Managed 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

#aad_profile ⇒ ManagedClusterAADProfile

configuration.

Returns:



84
85
86
 
# File 'lib/2020-12-01/generated/azure_mgmt_container_service/models/managed_cluster.rb', line 84

def aad_profile
  @aad_profile
end

#addon_profiles ⇒ Hash{String => ManagedClusterAddonProfile}

cluster add-on.

Returns:



59
60
61
 
# File 'lib/2020-12-01/generated/azure_mgmt_container_service/models/managed_cluster.rb', line 59

def addon_profiles
  @addon_profiles
end

#agent_pool_profiles ⇒ Array<ManagedClusterAgentPoolProfile>

pool.

Returns:



42
43
44
 
# File 'lib/2020-12-01/generated/azure_mgmt_container_service/models/managed_cluster.rb', line 42

def agent_pool_profiles
  @agent_pool_profiles
end

#api_server_access_profile ⇒ ManagedClusterAPIServerAccessProfile

managed cluster API server.

Returns:



96
97
98
 
# File 'lib/2020-12-01/generated/azure_mgmt_container_service/models/managed_cluster.rb', line 96

def api_server_access_profile
  @api_server_access_profile
end

#auto_scaler_profile ⇒ ManagedClusterPropertiesAutoScalerProfile

applied to the cluster-autoscaler when enabled

Returns:



92
93
94
 
# File 'lib/2020-12-01/generated/azure_mgmt_container_service/models/managed_cluster.rb', line 92

def auto_scaler_profile
  @auto_scaler_profile
end

#auto_upgrade_profile ⇒ ManagedClusterAutoUpgradeProfile

configuration.

Returns:



88
89
90
 
# File 'lib/2020-12-01/generated/azure_mgmt_container_service/models/managed_cluster.rb', line 88

def auto_upgrade_profile
  @auto_upgrade_profile
end

#disk_encryption_set_id ⇒ String

enabling encryption at rest.

Returns:

  • (String) —

    ResourceId of the disk encryption set to use for



100
101
102
 
# File 'lib/2020-12-01/generated/azure_mgmt_container_service/models/managed_cluster.rb', line 100

def disk_encryption_set_id
  @disk_encryption_set_id
end

#dns_prefix ⇒ String

cluster.

Returns:

  • (String) —

    DNS prefix specified when creating the managed



32
33
34
 
# File 'lib/2020-12-01/generated/azure_mgmt_container_service/models/managed_cluster.rb', line 32

def dns_prefix
  @dns_prefix
end

#enable_pod_security_policy ⇒ Boolean

security policy (preview). This feature is set for removal on October 15th, 2020. Learn more at aka.ms/aks/azpodpolicy.

Returns:

  • (Boolean) —

    (DEPRECATING) Whether to enable Kubernetes pod



76
77
78
 
# File 'lib/2020-12-01/generated/azure_mgmt_container_service/models/managed_cluster.rb', line 76

def enable_pod_security_policy
  @enable_pod_security_policy
end

#enable_rbac ⇒ Boolean

Control.

Returns:

  • (Boolean) —

    Whether to enable Kubernetes Role-Based Access



71
72
73
 
# File 'lib/2020-12-01/generated/azure_mgmt_container_service/models/managed_cluster.rb', line 71

def enable_rbac
  @enable_rbac
end

#fqdn ⇒ String

Returns FQDN for the master pool.

Returns:

  • (String) —

    FQDN for the master pool.



35
36
37
 
# File 'lib/2020-12-01/generated/azure_mgmt_container_service/models/managed_cluster.rb', line 35

def fqdn
  @fqdn
end

#identity ⇒ ManagedClusterIdentity

if configured.

Returns:



108
109
110
 
# File 'lib/2020-12-01/generated/azure_mgmt_container_service/models/managed_cluster.rb', line 108

def identity
  @identity
end

#identity_profile ⇒ Hash{String => ManagedClusterPropertiesIdentityProfileValue}

Identities associated with the cluster.

Returns:



104
105
106
 
# File 'lib/2020-12-01/generated/azure_mgmt_container_service/models/managed_cluster.rb', line 104

def identity_profile
  @identity_profile
end

#kubernetes_version ⇒ String

managed cluster.

Returns:

  • (String) —

    Version of Kubernetes specified when creating the



28
29
30
 
# File 'lib/2020-12-01/generated/azure_mgmt_container_service/models/managed_cluster.rb', line 28

def kubernetes_version
  @kubernetes_version
end

#linux_profile ⇒ ContainerServiceLinuxProfile

container service cluster.

Returns:



46
47
48
 
# File 'lib/2020-12-01/generated/azure_mgmt_container_service/models/managed_cluster.rb', line 46

def linux_profile
  @linux_profile
end

#max_agent_pools ⇒ Integer

cluster.

Returns:

  • (Integer) —

    The max number of agent pools for the managed



24
25
26
 
# File 'lib/2020-12-01/generated/azure_mgmt_container_service/models/managed_cluster.rb', line 24

def max_agent_pools
  @max_agent_pools
end

#network_profile ⇒ ContainerServiceNetworkProfile

configuration.

Returns:



80
81
82
 
# File 'lib/2020-12-01/generated/azure_mgmt_container_service/models/managed_cluster.rb', line 80

def network_profile
  @network_profile
end

#node_resource_group ⇒ String

nodes.

Returns:

  • (String) —

    Name of the resource group containing agent pool



67
68
69
 
# File 'lib/2020-12-01/generated/azure_mgmt_container_service/models/managed_cluster.rb', line 67

def node_resource_group
  @node_resource_group
end

#pod_identity_profile ⇒ ManagedClusterPodIdentityProfile

pod identity.

Returns:



63
64
65
 
# File 'lib/2020-12-01/generated/azure_mgmt_container_service/models/managed_cluster.rb', line 63

def pod_identity_profile
  @pod_identity_profile
end

#power_state ⇒ PowerState

Returns Represents the Power State of the cluster.

Returns:

  • (PowerState) —

    Represents the Power State of the cluster



20
21
22
 
# File 'lib/2020-12-01/generated/azure_mgmt_container_service/models/managed_cluster.rb', line 20

def power_state
  @power_state
end

#private_fqdn ⇒ String

Returns FQDN of private cluster.

Returns:

  • (String) —

    FQDN of private cluster.



38
39
40
 
# File 'lib/2020-12-01/generated/azure_mgmt_container_service/models/managed_cluster.rb', line 38

def private_fqdn
  @private_fqdn
end

#provisioning_state ⇒ String

only appears in the response.

Returns:

  • (String) —

    The current deployment or provisioning state, which



17
18
19
 
# File 'lib/2020-12-01/generated/azure_mgmt_container_service/models/managed_cluster.rb', line 17

def provisioning_state
  @provisioning_state
end

#service_principal_profile ⇒ ManagedClusterServicePrincipalProfile

service principal identity for the cluster to use for manipulating Azure APIs.

Returns:



55
56
57
 
# File 'lib/2020-12-01/generated/azure_mgmt_container_service/models/managed_cluster.rb', line 55

def service_principal_profile
  @service_principal_profile
end

#sku ⇒ ManagedClusterSKU

Returns The managed cluster SKU.

Returns:



111
112
113
 
# File 'lib/2020-12-01/generated/azure_mgmt_container_service/models/managed_cluster.rb', line 111

def sku
  @sku
end

#windows_profile ⇒ ManagedClusterWindowsProfile

container service cluster.

Returns:



50
51
52
 
# File 'lib/2020-12-01/generated/azure_mgmt_container_service/models/managed_cluster.rb', line 50

def windows_profile
  @windows_profile
end

Class Method Details

.mapper ⇒ Object

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



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
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
 
# File 'lib/2020-12-01/generated/azure_mgmt_container_service/models/managed_cluster.rb', line 118

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'ManagedCluster',
    type: {
      name: 'Composite',
      class_name: 'ManagedCluster',
      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'
                }
            }
          }
        },
        provisioning_state: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.provisioningState',
          type: {
            name: 'String'
          }
        },
        power_state: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.powerState',
          type: {
            name: 'Composite',
            class_name: 'PowerState'
          }
        },
        max_agent_pools: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.maxAgentPools',
          type: {
            name: 'Number'
          }
        },
        kubernetes_version: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.kubernetesVersion',
          type: {
            name: 'String'
          }
        },
        dns_prefix: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.dnsPrefix',
          type: {
            name: 'String'
          }
        },
        fqdn: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.fqdn',
          type: {
            name: 'String'
          }
        },
        private_fqdn: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.privateFQDN',
          type: {
            name: 'String'
          }
        },
        agent_pool_profiles: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.agentPoolProfiles',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'ManagedClusterAgentPoolProfileElementType',
                type: {
                  name: 'Composite',
                  class_name: 'ManagedClusterAgentPoolProfile'
                }
            }
          }
        },
        linux_profile: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.linuxProfile',
          type: {
            name: 'Composite',
            class_name: 'ContainerServiceLinuxProfile'
          }
        },
        windows_profile: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.windowsProfile',
          type: {
            name: 'Composite',
            class_name: 'ManagedClusterWindowsProfile'
          }
        },
        service_principal_profile: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.servicePrincipalProfile',
          type: {
            name: 'Composite',
            class_name: 'ManagedClusterServicePrincipalProfile'
          }
        },
        addon_profiles: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.addonProfiles',
          type: {
            name: 'Dictionary',
            value: {
                client_side_validation: true,
                required: false,
                serialized_name: 'ManagedClusterAddonProfileElementType',
                type: {
                  name: 'Composite',
                  class_name: 'ManagedClusterAddonProfile'
                }
            }
          }
        },
        pod_identity_profile: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.podIdentityProfile',
          type: {
            name: 'Composite',
            class_name: 'ManagedClusterPodIdentityProfile'
          }
        },
        node_resource_group: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.nodeResourceGroup',
          type: {
            name: 'String'
          }
        },
        enable_rbac: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.enableRBAC',
          type: {
            name: 'Boolean'
          }
        },
        enable_pod_security_policy: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.enablePodSecurityPolicy',
          type: {
            name: 'Boolean'
          }
        },
        network_profile: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.networkProfile',
          type: {
            name: 'Composite',
            class_name: 'ContainerServiceNetworkProfile'
          }
        },
        aad_profile: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.aadProfile',
          type: {
            name: 'Composite',
            class_name: 'ManagedClusterAADProfile'
          }
        },
        auto_upgrade_profile: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.autoUpgradeProfile',
          type: {
            name: 'Composite',
            class_name: 'ManagedClusterAutoUpgradeProfile'
          }
        },
        auto_scaler_profile: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.autoScalerProfile',
          type: {
            name: 'Composite',
            class_name: 'ManagedClusterPropertiesAutoScalerProfile'
          }
        },
        api_server_access_profile: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.apiServerAccessProfile',
          type: {
            name: 'Composite',
            class_name: 'ManagedClusterAPIServerAccessProfile'
          }
        },
        disk_encryption_set_id: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.diskEncryptionSetID',
          type: {
            name: 'String'
          }
        },
        identity_profile: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.identityProfile',
          type: {
            name: 'Dictionary',
            value: {
                client_side_validation: true,
                required: false,
                serialized_name: 'ManagedClusterPropertiesIdentityProfileValueElementType',
                type: {
                  name: 'Composite',
                  class_name: 'ManagedClusterPropertiesIdentityProfileValue'
                }
            }
          }
        },
        identity: {
          client_side_validation: true,
          required: false,
          serialized_name: 'identity',
          type: {
            name: 'Composite',
            class_name: 'ManagedClusterIdentity'
          }
        },
        sku: {
          client_side_validation: true,
          required: false,
          serialized_name: 'sku',
          type: {
            name: 'Composite',
            class_name: 'ManagedClusterSKU'
          }
        }
      }
    }
  }
end