ManagedClusterAgentPoolProfileProperties Class

Reference

Properties for the container service agent pool profile.

Variables are only populated by the server, and will be ignored when sending a request.

Inheritance: Model

ManagedClusterAgentPoolProfileProperties

Constructor

ManagedClusterAgentPoolProfileProperties(*, count: Optional[int] = None, vm_size: Optional[str] = None, os_disk_size_gb: Optional[int] = None, os_disk_type: Optional[Union[str, _models.OSDiskType]] = None, kubelet_disk_type: Optional[Union[str, _models.KubeletDiskType]] = None, vnet_subnet_id: Optional[str] = None, pod_subnet_id: Optional[str] = None, max_pods: Optional[int] = None, os_type: Optional[Union[str, _models.OSType]] = 'Linux', os_sku: Optional[Union[str, _models.OSSKU]] = None, max_count: Optional[int] = None, min_count: Optional[int] = None, enable_auto_scaling: Optional[bool] = None, type: Optional[Union[str, _models.AgentPoolType]] = None, mode: Optional[Union[str, _models.AgentPoolMode]] = None, orchestrator_version: Optional[str] = None, upgrade_settings: Optional[_models.AgentPoolUpgradeSettings] = None, availability_zones: Optional[List[str]] = None, enable_node_public_ip: Optional[bool] = None, node_public_ip_prefix_id: Optional[str] = None, scale_set_priority: Optional[Union[str, _models.ScaleSetPriority]] = 'Regular', scale_set_eviction_policy: Optional[Union[str, _models.ScaleSetEvictionPolicy]] = 'Delete', spot_max_price: Optional[float] = - 1, tags: Optional[Dict[str, str]] = None, node_labels: Optional[Dict[str, str]] = None, node_taints: Optional[List[str]] = None, proximity_placement_group_id: Optional[str] = None, kubelet_config: Optional[_models.KubeletConfig] = None, linux_os_config: Optional[_models.LinuxOSConfig] = None, enable_encryption_at_host: Optional[bool] = None, enable_fips: Optional[bool] = None, gpu_instance_profile: Optional[Union[str, _models.GPUInstanceProfile]] = None, **kwargs)

Variables

count: int

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

vm_size: str

Size of agent VMs.

os_disk_size_gb: int

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.

os_disk_type: str or OSDiskType

OS disk type to be used for machines in a given agent pool. Allowed values are 'Ephemeral' and 'Managed'. If unspecified, defaults to 'Ephemeral' when the VM supports ephemeral OS and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed after creation. Known values are: "Managed", "Ephemeral".

kubelet_disk_type: str or KubeletDiskType

KubeletDiskType determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage. Currently allows one value, OS, resulting in Kubelet using the OS disk for data. Known values are: "OS", "Temporary".

vnet_subnet_id: str

VNet SubnetID specifies the VNet's subnet identifier for nodes and maybe pods.

pod_subnet_id: str

Pod SubnetID specifies the VNet's subnet identifier for pods.

max_pods: int

Maximum number of pods that can run on a node.

os_type: str or OSType

OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux. Known values are: "Linux", "Windows". Default value: "Linux".

os_sku: str or OSSKU

OsSKU to be used to specify os sku. Choose from Ubuntu(default) and CBLMariner for Linux OSType. Not applicable to Windows OSType. Known values are: "Ubuntu", "CBLMariner".

max_count: int

Maximum number of nodes for auto-scaling.

min_count: int

Minimum number of nodes for auto-scaling.

enable_auto_scaling: bool

Whether to enable auto-scaler.

type: str or AgentPoolType

AgentPoolType represents types of an agent pool. Known values are: "VirtualMachineScaleSets", "AvailabilitySet".

mode: str or AgentPoolMode

AgentPoolMode represents mode of an agent pool. Known values are: "System", "User".

orchestrator_version: str

Version of orchestrator specified when creating the managed cluster.

node_image_version: str

Version of node image.

upgrade_settings: AgentPoolUpgradeSettings

Settings for upgrading the agentpool.

provisioning_state: str

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

power_state: PowerState

Describes whether the Agent Pool is Running or Stopped.

availability_zones: list[str]

Availability zones for nodes. Must use VirtualMachineScaleSets AgentPoolType.

enable_node_public_ip: bool

Enable public IP for nodes.

node_public_ip_prefix_id: str

Public IP Prefix ID. VM nodes use IPs assigned from this Public IP Prefix.

scale_set_priority: str or ScaleSetPriority

ScaleSetPriority to be used to specify virtual machine scale set priority. Default to regular. Known values are: "Spot", "Regular". Default value: "Regular".

scale_set_eviction_policy: str or ScaleSetEvictionPolicy

ScaleSetEvictionPolicy to be used to specify eviction policy for Spot virtual machine scale set. Default to Delete. Known values are: "Delete", "Deallocate". Default value: "Delete".

spot_max_price: float

SpotMaxPrice to be used to specify the maximum price you are willing to pay in US Dollars. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand.

tags: dict[str, str]

A set of tags. Agent pool tags to be persisted on the agent pool virtual machine scale set.

node_labels: dict[str, str]

Agent pool node labels to be persisted across all nodes in agent pool.

node_taints: list[str]

Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule.

proximity_placement_group_id: str

The ID for Proximity Placement Group.

kubelet_config: KubeletConfig

KubeletConfig specifies the configuration of kubelet on agent nodes.

linux_os_config: LinuxOSConfig

LinuxOSConfig specifies the OS configuration of linux agent nodes.

enable_encryption_at_host: bool

Whether to enable EncryptionAtHost.

enable_fips: bool

Whether to use FIPS enabled OS.

gpu_instance_profile: str or GPUInstanceProfile

GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU. Supported values are MIG1g, MIG2g, MIG3g, MIG4g and MIG7g. Known values are: "MIG1g", "MIG2g", "MIG3g", "MIG4g", "MIG7g".

ManagedClusterAgentPoolProfileProperties Class

Constructor

Variables

Feedback