Class ManagedClusterAgentPoolProfileProperties

Properties for the container service agent pool profile.

Inheritance

ManagedClusterAgentPoolProfileProperties

Namespace: System.Dynamic.ExpandoObject

Assembly: Microsoft.Azure.Management.ContainerService.dll

Syntax

public class ManagedClusterAgentPoolProfileProperties

Constructors

ManagedClusterAgentPoolProfileProperties()

Initializes a new instance of the ManagedClusterAgentPoolProfileProperties class.

Declaration

public ManagedClusterAgentPoolProfileProperties ();

ManagedClusterAgentPoolProfileProperties(Int32, String, Nullable<Int32>, String, Nullable<Int32>, String, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, String, String, String, IList<String>)

Initializes a new instance of the ManagedClusterAgentPoolProfileProperties class.

Declaration

public ManagedClusterAgentPoolProfileProperties (int count, string vmSize, Nullable<int> osDiskSizeGB = null, string vnetSubnetID = null, Nullable<int> maxPods = null, string osType = null, Nullable<int> maxCount = null, Nullable<int> minCount = null, Nullable<bool> enableAutoScaling = null, string type = null, string orchestratorVersion = null, string provisioningState = null, System.Collections.Generic.IList<string> availabilityZones = null);

Parameters

Int32 count

Number of agents (VMs) to host docker containers. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1.

String vmSize

Size of agent VMs. Possible values include: 'Standard_A1', 'Standard_A10', 'Standard_A11', 'Standard_A1_v2', 'Standard_A2', 'Standard_A2_v2', 'Standard_A2m_v2', 'Standard_A3', 'Standard_A4', 'Standard_A4_v2', 'Standard_A4m_v2', 'Standard_A5', 'Standard_A6', 'Standard_A7', 'Standard_A8', 'Standard_A8_v2', 'Standard_A8m_v2', 'Standard_A9', 'Standard_B2ms', 'Standard_B2s', 'Standard_B4ms', 'Standard_B8ms', 'Standard_D1', 'Standard_D11', 'Standard_D11_v2', 'Standard_D11_v2_Promo', 'Standard_D12', 'Standard_D12_v2', 'Standard_D12_v2_Promo', 'Standard_D13', 'Standard_D13_v2', 'Standard_D13_v2_Promo', 'Standard_D14', 'Standard_D14_v2', 'Standard_D14_v2_Promo', 'Standard_D15_v2', 'Standard_D16_v3', 'Standard_D16s_v3', 'Standard_D1_v2', 'Standard_D2', 'Standard_D2_v2', 'Standard_D2_v2_Promo', 'Standard_D2_v3', 'Standard_D2s_v3', 'Standard_D3', 'Standard_D32_v3', 'Standard_D32s_v3', 'Standard_D3_v2', 'Standard_D3_v2_Promo', 'Standard_D4', 'Standard_D4_v2', 'Standard_D4_v2_Promo', 'Standard_D4_v3', 'Standard_D4s_v3', 'Standard_D5_v2', 'Standard_D5_v2_Promo', 'Standard_D64_v3', 'Standard_D64s_v3', 'Standard_D8_v3', 'Standard_D8s_v3', 'Standard_DS1', 'Standard_DS11', 'Standard_DS11_v2', 'Standard_DS11_v2_Promo', 'Standard_DS12', 'Standard_DS12_v2', 'Standard_DS12_v2_Promo', 'Standard_DS13', 'Standard_DS13-2_v2', 'Standard_DS13-4_v2', 'Standard_DS13_v2', 'Standard_DS13_v2_Promo', 'Standard_DS14', 'Standard_DS14-4_v2', 'Standard_DS14-8_v2', 'Standard_DS14_v2', 'Standard_DS14_v2_Promo', 'Standard_DS15_v2', 'Standard_DS1_v2', 'Standard_DS2', 'Standard_DS2_v2', 'Standard_DS2_v2_Promo', 'Standard_DS3', 'Standard_DS3_v2', 'Standard_DS3_v2_Promo', 'Standard_DS4', 'Standard_DS4_v2', 'Standard_DS4_v2_Promo', 'Standard_DS5_v2', 'Standard_DS5_v2_Promo', 'Standard_E16_v3', 'Standard_E16s_v3', 'Standard_E2_v3', 'Standard_E2s_v3', 'Standard_E32-16s_v3', 'Standard_E32-8s_v3', 'Standard_E32_v3', 'Standard_E32s_v3', 'Standard_E4_v3', 'Standard_E4s_v3', 'Standard_E64-16s_v3', 'Standard_E64-32s_v3', 'Standard_E64_v3', 'Standard_E64s_v3', 'Standard_E8_v3', 'Standard_E8s_v3', 'Standard_F1', 'Standard_F16', 'Standard_F16s', 'Standard_F16s_v2', 'Standard_F1s', 'Standard_F2', 'Standard_F2s', 'Standard_F2s_v2', 'Standard_F32s_v2', 'Standard_F4', 'Standard_F4s', 'Standard_F4s_v2', 'Standard_F64s_v2', 'Standard_F72s_v2', 'Standard_F8', 'Standard_F8s', 'Standard_F8s_v2', 'Standard_G1', 'Standard_G2', 'Standard_G3', 'Standard_G4', 'Standard_G5', 'Standard_GS1', 'Standard_GS2', 'Standard_GS3', 'Standard_GS4', 'Standard_GS4-4', 'Standard_GS4-8', 'Standard_GS5', 'Standard_GS5-16', 'Standard_GS5-8', 'Standard_H16', 'Standard_H16m', 'Standard_H16mr', 'Standard_H16r', 'Standard_H8', 'Standard_H8m', 'Standard_L16s', 'Standard_L32s', 'Standard_L4s', 'Standard_L8s', 'Standard_M128-32ms', 'Standard_M128-64ms', 'Standard_M128ms', 'Standard_M128s', 'Standard_M64-16ms', 'Standard_M64-32ms', 'Standard_M64ms', 'Standard_M64s', 'Standard_NC12', 'Standard_NC12s_v2', 'Standard_NC12s_v3', 'Standard_NC24', 'Standard_NC24r', 'Standard_NC24rs_v2', 'Standard_NC24rs_v3', 'Standard_NC24s_v2', 'Standard_NC24s_v3', 'Standard_NC6', 'Standard_NC6s_v2', 'Standard_NC6s_v3', 'Standard_ND12s', 'Standard_ND24rs', 'Standard_ND24s', 'Standard_ND6s', 'Standard_NV12', 'Standard_NV24', 'Standard_NV6'

Nullable<Int32> osDiskSizeGB

OS Disk Size in GB to be used to specify the disk size for every machine in this master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified.

String vnetSubnetID

VNet SubnetID specifies the VNet's subnet identifier.

Nullable<Int32> maxPods

Maximum number of pods that can run on a node.

String osType

OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux. Possible values include: 'Linux', 'Windows'

Nullable<Int32> maxCount

Maximum number of nodes for auto-scaling

Nullable<Int32> minCount

Minimum number of nodes for auto-scaling

Nullable<Boolean> enableAutoScaling

Whether to enable auto-scaler

String type

AgentPoolType represents types of an agent pool. Possible values include: 'VirtualMachineScaleSets', 'AvailabilitySet'

String orchestratorVersion

Version of orchestrator specified when creating the managed cluster.

String provisioningState

The current deployment or provisioning state, which only appears in the response.

IList<String> availabilityZones

(PREVIEW) Availability zones for nodes. Must use VirtualMachineScaleSets AgentPoolType.

Properties

AvailabilityZones

Gets or sets (PREVIEW) Availability zones for nodes. Must use VirtualMachineScaleSets AgentPoolType.

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="availabilityZones")]
public System.Collections.Generic.IList<string> AvailabilityZones { get; set; }

Property Value

IList<String>

Count

Gets or sets number of agents (VMs) to host docker containers. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1.

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="count")]
public int Count { get; set; }

Property Value

Int32

EnableAutoScaling

Gets or sets whether to enable auto-scaler

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="enableAutoScaling")]
public Nullable<bool> EnableAutoScaling { get; set; }

Property Value

Nullable<Boolean>

MaxCount

Gets or sets maximum number of nodes for auto-scaling

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="maxCount")]
public Nullable<int> MaxCount { get; set; }

Property Value

Nullable<Int32>

MaxPods

Gets or sets maximum number of pods that can run on a node.

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="maxPods")]
public Nullable<int> MaxPods { get; set; }

Property Value

Nullable<Int32>

MinCount

Gets or sets minimum number of nodes for auto-scaling

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="minCount")]
public Nullable<int> MinCount { get; set; }

Property Value

Nullable<Int32>

OrchestratorVersion

Gets or sets version of orchestrator specified when creating the managed cluster.

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="orchestratorVersion")]
public string OrchestratorVersion { get; set; }

Property Value

String

OsDiskSizeGB

Gets or sets OS Disk Size in GB to be used to specify the disk size for every machine in this master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified.

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="osDiskSizeGB")]
public Nullable<int> OsDiskSizeGB { get; set; }

Property Value

Nullable<Int32>

OsType

Gets or sets osType to be used to specify os type. Choose from Linux and Windows. Default to Linux. Possible values include: 'Linux', 'Windows'

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="osType")]
public string OsType { get; set; }

Property Value

String

ProvisioningState

Gets the current deployment or provisioning state, which only appears in the response.

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="provisioningState")]
public string ProvisioningState { get; }

Property Value

String

Type

Gets or sets agentPoolType represents types of an agent pool. Possible values include: 'VirtualMachineScaleSets', 'AvailabilitySet'

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="type")]
public string Type { get; set; }

Property Value

String

VmSize

Gets or sets size of agent VMs. Possible values include: 'Standard_A1', 'Standard_A10', 'Standard_A11', 'Standard_A1_v2', 'Standard_A2', 'Standard_A2_v2', 'Standard_A2m_v2', 'Standard_A3', 'Standard_A4', 'Standard_A4_v2', 'Standard_A4m_v2', 'Standard_A5', 'Standard_A6', 'Standard_A7', 'Standard_A8', 'Standard_A8_v2', 'Standard_A8m_v2', 'Standard_A9', 'Standard_B2ms', 'Standard_B2s', 'Standard_B4ms', 'Standard_B8ms', 'Standard_D1', 'Standard_D11', 'Standard_D11_v2', 'Standard_D11_v2_Promo', 'Standard_D12', 'Standard_D12_v2', 'Standard_D12_v2_Promo', 'Standard_D13', 'Standard_D13_v2', 'Standard_D13_v2_Promo', 'Standard_D14', 'Standard_D14_v2', 'Standard_D14_v2_Promo', 'Standard_D15_v2', 'Standard_D16_v3', 'Standard_D16s_v3', 'Standard_D1_v2', 'Standard_D2', 'Standard_D2_v2', 'Standard_D2_v2_Promo', 'Standard_D2_v3', 'Standard_D2s_v3', 'Standard_D3', 'Standard_D32_v3', 'Standard_D32s_v3', 'Standard_D3_v2', 'Standard_D3_v2_Promo', 'Standard_D4', 'Standard_D4_v2', 'Standard_D4_v2_Promo', 'Standard_D4_v3', 'Standard_D4s_v3', 'Standard_D5_v2', 'Standard_D5_v2_Promo', 'Standard_D64_v3', 'Standard_D64s_v3', 'Standard_D8_v3', 'Standard_D8s_v3', 'Standard_DS1', 'Standard_DS11', 'Standard_DS11_v2', 'Standard_DS11_v2_Promo', 'Standard_DS12', 'Standard_DS12_v2', 'Standard_DS12_v2_Promo', 'Standard_DS13', 'Standard_DS13-2_v2', 'Standard_DS13-4_v2', 'Standard_DS13_v2', 'Standard_DS13_v2_Promo', 'Standard_DS14', 'Standard_DS14-4_v2', 'Standard_DS14-8_v2', 'Standard_DS14_v2', 'Standard_DS14_v2_Promo', 'Standard_DS15_v2', 'Standard_DS1_v2', 'Standard_DS2', 'Standard_DS2_v2', 'Standard_DS2_v2_Promo', 'Standard_DS3', 'Standard_DS3_v2', 'Standard_DS3_v2_Promo', 'Standard_DS4', 'Standard_DS4_v2', 'Standard_DS4_v2_Promo', 'Standard_DS5_v2', 'Standard_DS5_v2_Promo', 'Standard_E16_v3', 'Standard_E16s_v3', 'Standard_E2_v3', 'Standard_E2s_v3', 'Standard_E32-16s_v3', 'Standard_E32-8s_v3', 'Standard_E32_v3', 'Standard_E32s_v3', 'Standard_E4_v3', 'Standard_E4s_v3', 'Standard_E64-16s_v3', 'Standard_E64-32s_v3', 'Standard_E64_v3', 'Standard_E64s_v3', 'Standard_E8_v3', 'Standard_E8s_v3', 'Standard_F1', 'Standard_F16', 'Standard_F16s', 'Standard_F16s_v2', 'Standard_F1s', 'Standard_F2', 'Standard_F2s', 'Standard_F2s_v2', 'Standard_F32s_v2', 'Standard_F4', 'Standard_F4s', 'Standard_F4s_v2', 'Standard_F64s_v2', 'Standard_F72s_v2', 'Standard_F8', 'Standard_F8s', 'Standard_F8s_v2', 'Standard_G1', 'Standard_G2', 'Standard_G3', 'Standard_G4', 'Standard_G5', 'Standard_GS1', 'Standard_GS2', 'Standard_GS3', 'Standard_GS4', 'Standard_GS4-4', 'Standard_GS4-8', 'Standard_GS5', 'Standard_GS5-16', 'Standard_GS5-8', 'Standard_H16', 'Standard_H16m', 'Standard_H16mr', 'Standard_H16r', 'Standard_H8', 'Standard_H8m', 'Standard_L16s', 'Standard_L32s', 'Standard_L4s', 'Standard_L8s', 'Standard_M128-32ms', 'Standard_M128-64ms', 'Standard_M128ms', 'Standard_M128s', 'Standard_M64-16ms', 'Standard_M64-32ms', 'Standard_M64ms', 'Standard_M64s', 'Standard_NC12', 'Standard_NC12s_v2', 'Standard_NC12s_v3', 'Standard_NC24', 'Standard_NC24r', 'Standard_NC24rs_v2', 'Standard_NC24rs_v3', 'Standard_NC24s_v2', 'Standard_NC24s_v3', 'Standard_NC6', 'Standard_NC6s_v2', 'Standard_NC6s_v3', 'Standard_ND12s', 'Standard_ND24rs', 'Standard_ND24s', 'Standard_ND6s', 'Standard_NV12', 'Standard_NV24', 'Standard_NV6'

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="vmSize")]
public string VmSize { get; set; }

Property Value

String

VnetSubnetID

Gets or sets vNet SubnetID specifies the VNet's subnet identifier.

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="vnetSubnetID")]
public string VnetSubnetID { get; set; }

Property Value

String

Methods

Validate()

Validate the object.

Declaration

public virtual void Validate ();

Exceptions

ValidationException

Thrown if validation fails