azure-native.containerservice.getAgentPool

func LookupAgentPool(ctx *Context, args *LookupAgentPoolArgs, opts ...InvokeOption) (*LookupAgentPoolResult, error)
func LookupAgentPoolOutput(ctx *Context, args *LookupAgentPoolOutputArgs, opts ...InvokeOption) LookupAgentPoolResultOutput

> Note: This function is named LookupAgentPool in the Go SDK.

AgentPoolName string

The name of the agent pool.

ResourceGroupName string

The name of the resource group. The name is case insensitive.

ResourceName string

The name of the managed cluster resource.

AgentPoolName string

The name of the agent pool.

ResourceGroupName string

The name of the resource group. The name is case insensitive.

ResourceName string

The name of the managed cluster resource.

agentPoolName String

The name of the agent pool.

resourceGroupName String

The name of the resource group. The name is case insensitive.

resourceName String

The name of the managed cluster resource.

agentPoolName string

The name of the agent pool.

resourceGroupName string

The name of the resource group. The name is case insensitive.

resourceName string

The name of the managed cluster resource.

agent_pool_name str

The name of the agent pool.

resource_group_name str

The name of the resource group. The name is case insensitive.

resource_name str

The name of the managed cluster resource.

agentPoolName String

The name of the agent pool.

resourceGroupName String

The name of the resource group. The name is case insensitive.

resourceName String

The name of the managed cluster resource.

CurrentOrchestratorVersion string

If orchestratorVersion is a fully specified version <major.minor.patch>, this field will be exactly equal to it. If orchestratorVersion is <major.minor>, this field will contain the full <major.minor.patch> version being used.

Id string

Resource ID.

Name string

The name of the resource that is unique within a resource group. This name can be used to access the resource.

NodeImageVersion string

The version of node image

ProvisioningState string

The current deployment or provisioning state.

Type string

Resource type

AvailabilityZones List<string>

The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'.

Count int

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

CreationData Pulumi.AzureNative.ContainerService.Outputs.CreationDataResponse

CreationData to be used to specify the source Snapshot ID if the node pool will be created/upgraded using a snapshot.

EnableAutoScaling bool

Whether to enable auto-scaler

EnableEncryptionAtHost bool

This is only supported on certain VM sizes and in certain Azure regions. For more information, see: https://docs.microsoft.com/azure/aks/enable-host-encryption

EnableFIPS bool

See Add a FIPS-enabled node pool for more details.

EnableNodePublicIP bool

Some scenarios may require nodes in a node pool to receive their own dedicated public IP addresses. A common scenario is for gaming workloads, where a console needs to make a direct connection to a cloud virtual machine to minimize hops. For more information see assigning a public IP per node. The default is false.

EnableUltraSSD bool

Whether to enable UltraSSD

GpuInstanceProfile string

GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU.

HostGroupID string

This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. For more information see Azure dedicated hosts.

KubeletConfig Pulumi.AzureNative.ContainerService.Outputs.KubeletConfigResponse

The Kubelet configuration on the agent pool nodes.

KubeletDiskType string

Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage.

LinuxOSConfig Pulumi.AzureNative.ContainerService.Outputs.LinuxOSConfigResponse

The OS configuration of Linux agent nodes.

MaxCount int

The maximum number of nodes for auto-scaling

MaxPods int

The maximum number of pods that can run on a node.

MinCount int

The minimum number of nodes for auto-scaling

Mode string

A cluster must have at least one 'System' Agent Pool at all times. For additional information on agent pool restrictions and best practices, see: https://docs.microsoft.com/azure/aks/use-system-pools

NodeLabels Dictionary<string, string>

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

NodePublicIPPrefixID string

This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}

NodeTaints List<string>

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

OrchestratorVersion string

Both patch version <major.minor.patch> (e.g. 1.20.13) and <major.minor> (e.g. 1.20) are supported. When <major.minor> is specified, the latest supported GA patch version is chosen automatically. Updating the cluster with the same <major.minor> once it has been created (e.g. 1.14.x -> 1.14) will not trigger an upgrade, even if a newer patch version is available. As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see upgrading a node pool.

OsDiskSizeGB int

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

OsDiskType string

The default is 'Ephemeral' if the VM supports it and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed after creation. For more information see Ephemeral OS.

OsSKU string

Specifies the OS SKU used by the agent pool. The default is Ubuntu if OSType is Linux. The default is Windows2019 when Kubernetes <= 1.24 or Windows2022 when Kubernetes >= 1.25 if OSType is Windows.

OsType string

The operating system type. The default is Linux.

PodSubnetID string

If omitted, pod IPs are statically assigned on the node subnet (see vnetSubnetID for more details). This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}

PowerState Pulumi.AzureNative.ContainerService.Outputs.PowerStateResponse

When an Agent Pool is first created it is initially Running. The Agent Pool can be stopped by setting this field to Stopped. A stopped Agent Pool stops all of its VMs and does not accrue billing charges. An Agent Pool can only be stopped if it is Running and provisioning state is Succeeded

ProximityPlacementGroupID string

The ID for Proximity Placement Group.

ScaleDownMode string

This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete.

ScaleSetEvictionPolicy string

This cannot be specified unless the scaleSetPriority is 'Spot'. If not specified, the default is 'Delete'.

ScaleSetPriority string

The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'.

SpotMaxPrice double

Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see spot VMs pricing

Tags Dictionary<string, string>

The tags to be persisted on the agent pool virtual machine scale set.

UpgradeSettings Pulumi.AzureNative.ContainerService.Outputs.AgentPoolUpgradeSettingsResponse

Settings for upgrading the agentpool

VmSize string

VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions

VnetSubnetID string

If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}

WorkloadRuntime string

Determines the type of workload a node can run.

CurrentOrchestratorVersion string

If orchestratorVersion is a fully specified version <major.minor.patch>, this field will be exactly equal to it. If orchestratorVersion is <major.minor>, this field will contain the full <major.minor.patch> version being used.

Id string

Resource ID.

Name string

The name of the resource that is unique within a resource group. This name can be used to access the resource.

NodeImageVersion string

The version of node image

ProvisioningState string

The current deployment or provisioning state.

Type string

Resource type

AvailabilityZones []string

The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'.

Count int

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

CreationData CreationDataResponse

CreationData to be used to specify the source Snapshot ID if the node pool will be created/upgraded using a snapshot.

EnableAutoScaling bool

Whether to enable auto-scaler

EnableEncryptionAtHost bool

This is only supported on certain VM sizes and in certain Azure regions. For more information, see: https://docs.microsoft.com/azure/aks/enable-host-encryption

EnableFIPS bool

See Add a FIPS-enabled node pool for more details.

EnableNodePublicIP bool

Some scenarios may require nodes in a node pool to receive their own dedicated public IP addresses. A common scenario is for gaming workloads, where a console needs to make a direct connection to a cloud virtual machine to minimize hops. For more information see assigning a public IP per node. The default is false.

EnableUltraSSD bool

Whether to enable UltraSSD

GpuInstanceProfile string

GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU.

HostGroupID string

This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. For more information see Azure dedicated hosts.

KubeletConfig KubeletConfigResponse

The Kubelet configuration on the agent pool nodes.

KubeletDiskType string

Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage.

LinuxOSConfig LinuxOSConfigResponse

The OS configuration of Linux agent nodes.

MaxCount int

The maximum number of nodes for auto-scaling

MaxPods int

The maximum number of pods that can run on a node.

MinCount int

The minimum number of nodes for auto-scaling

Mode string

A cluster must have at least one 'System' Agent Pool at all times. For additional information on agent pool restrictions and best practices, see: https://docs.microsoft.com/azure/aks/use-system-pools

NodeLabels map[string]string

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

NodePublicIPPrefixID string

This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}

NodeTaints []string

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

OrchestratorVersion string

Both patch version <major.minor.patch> (e.g. 1.20.13) and <major.minor> (e.g. 1.20) are supported. When <major.minor> is specified, the latest supported GA patch version is chosen automatically. Updating the cluster with the same <major.minor> once it has been created (e.g. 1.14.x -> 1.14) will not trigger an upgrade, even if a newer patch version is available. As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see upgrading a node pool.

OsDiskSizeGB int

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

OsDiskType string

The default is 'Ephemeral' if the VM supports it and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed after creation. For more information see Ephemeral OS.

OsSKU string

Specifies the OS SKU used by the agent pool. The default is Ubuntu if OSType is Linux. The default is Windows2019 when Kubernetes <= 1.24 or Windows2022 when Kubernetes >= 1.25 if OSType is Windows.

OsType string

The operating system type. The default is Linux.

PodSubnetID string

If omitted, pod IPs are statically assigned on the node subnet (see vnetSubnetID for more details). This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}

PowerState PowerStateResponse

When an Agent Pool is first created it is initially Running. The Agent Pool can be stopped by setting this field to Stopped. A stopped Agent Pool stops all of its VMs and does not accrue billing charges. An Agent Pool can only be stopped if it is Running and provisioning state is Succeeded

ProximityPlacementGroupID string

The ID for Proximity Placement Group.

ScaleDownMode string

This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete.

ScaleSetEvictionPolicy string

This cannot be specified unless the scaleSetPriority is 'Spot'. If not specified, the default is 'Delete'.

ScaleSetPriority string

The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'.

SpotMaxPrice float64

Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see spot VMs pricing

Tags map[string]string

The tags to be persisted on the agent pool virtual machine scale set.

UpgradeSettings AgentPoolUpgradeSettingsResponse

Settings for upgrading the agentpool

VmSize string

VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions

VnetSubnetID string

If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}

WorkloadRuntime string

Determines the type of workload a node can run.

currentOrchestratorVersion String

If orchestratorVersion is a fully specified version <major.minor.patch>, this field will be exactly equal to it. If orchestratorVersion is <major.minor>, this field will contain the full <major.minor.patch> version being used.

id String

Resource ID.

name String

The name of the resource that is unique within a resource group. This name can be used to access the resource.

nodeImageVersion String

The version of node image

provisioningState String

The current deployment or provisioning state.

type String

Resource type

availabilityZones List<String>

The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'.

count Integer

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

creationData CreationDataResponse

CreationData to be used to specify the source Snapshot ID if the node pool will be created/upgraded using a snapshot.

enableAutoScaling Boolean

Whether to enable auto-scaler

enableEncryptionAtHost Boolean

This is only supported on certain VM sizes and in certain Azure regions. For more information, see: https://docs.microsoft.com/azure/aks/enable-host-encryption

enableFIPS Boolean

See Add a FIPS-enabled node pool for more details.

enableNodePublicIP Boolean

Some scenarios may require nodes in a node pool to receive their own dedicated public IP addresses. A common scenario is for gaming workloads, where a console needs to make a direct connection to a cloud virtual machine to minimize hops. For more information see assigning a public IP per node. The default is false.

enableUltraSSD Boolean

Whether to enable UltraSSD

gpuInstanceProfile String

GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU.

hostGroupID String

This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. For more information see Azure dedicated hosts.

kubeletConfig KubeletConfigResponse

The Kubelet configuration on the agent pool nodes.

kubeletDiskType String

Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage.

linuxOSConfig LinuxOSConfigResponse

The OS configuration of Linux agent nodes.

maxCount Integer

The maximum number of nodes for auto-scaling

maxPods Integer

The maximum number of pods that can run on a node.

minCount Integer

The minimum number of nodes for auto-scaling

mode String

A cluster must have at least one 'System' Agent Pool at all times. For additional information on agent pool restrictions and best practices, see: https://docs.microsoft.com/azure/aks/use-system-pools

nodeLabels Map<String,String>

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

nodePublicIPPrefixID String

This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}

nodeTaints List<String>

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

orchestratorVersion String

Both patch version <major.minor.patch> (e.g. 1.20.13) and <major.minor> (e.g. 1.20) are supported. When <major.minor> is specified, the latest supported GA patch version is chosen automatically. Updating the cluster with the same <major.minor> once it has been created (e.g. 1.14.x -> 1.14) will not trigger an upgrade, even if a newer patch version is available. As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see upgrading a node pool.

osDiskSizeGB Integer

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

osDiskType String

The default is 'Ephemeral' if the VM supports it and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed after creation. For more information see Ephemeral OS.

osSKU String

Specifies the OS SKU used by the agent pool. The default is Ubuntu if OSType is Linux. The default is Windows2019 when Kubernetes <= 1.24 or Windows2022 when Kubernetes >= 1.25 if OSType is Windows.

osType String

The operating system type. The default is Linux.

podSubnetID String

If omitted, pod IPs are statically assigned on the node subnet (see vnetSubnetID for more details). This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}

powerState PowerStateResponse

When an Agent Pool is first created it is initially Running. The Agent Pool can be stopped by setting this field to Stopped. A stopped Agent Pool stops all of its VMs and does not accrue billing charges. An Agent Pool can only be stopped if it is Running and provisioning state is Succeeded

proximityPlacementGroupID String

The ID for Proximity Placement Group.

scaleDownMode String

This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete.

scaleSetEvictionPolicy String

This cannot be specified unless the scaleSetPriority is 'Spot'. If not specified, the default is 'Delete'.

scaleSetPriority String

The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'.

spotMaxPrice Double

Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see spot VMs pricing

tags Map<String,String>

The tags to be persisted on the agent pool virtual machine scale set.

upgradeSettings AgentPoolUpgradeSettingsResponse

Settings for upgrading the agentpool

vmSize String

VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions

vnetSubnetID String

If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}

workloadRuntime String

Determines the type of workload a node can run.

currentOrchestratorVersion string

If orchestratorVersion is a fully specified version <major.minor.patch>, this field will be exactly equal to it. If orchestratorVersion is <major.minor>, this field will contain the full <major.minor.patch> version being used.

id string

Resource ID.

name string

The name of the resource that is unique within a resource group. This name can be used to access the resource.

nodeImageVersion string

The version of node image

provisioningState string

The current deployment or provisioning state.

type string

Resource type

availabilityZones string[]

The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'.

count number

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

creationData CreationDataResponse

CreationData to be used to specify the source Snapshot ID if the node pool will be created/upgraded using a snapshot.

enableAutoScaling boolean

Whether to enable auto-scaler

enableEncryptionAtHost boolean

This is only supported on certain VM sizes and in certain Azure regions. For more information, see: https://docs.microsoft.com/azure/aks/enable-host-encryption

enableFIPS boolean

See Add a FIPS-enabled node pool for more details.

enableNodePublicIP boolean

Some scenarios may require nodes in a node pool to receive their own dedicated public IP addresses. A common scenario is for gaming workloads, where a console needs to make a direct connection to a cloud virtual machine to minimize hops. For more information see assigning a public IP per node. The default is false.

enableUltraSSD boolean

Whether to enable UltraSSD

gpuInstanceProfile string

GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU.

hostGroupID string

This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. For more information see Azure dedicated hosts.

kubeletConfig KubeletConfigResponse

The Kubelet configuration on the agent pool nodes.

kubeletDiskType string

Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage.

linuxOSConfig LinuxOSConfigResponse

The OS configuration of Linux agent nodes.

maxCount number

The maximum number of nodes for auto-scaling

maxPods number

The maximum number of pods that can run on a node.

minCount number

The minimum number of nodes for auto-scaling

mode string

A cluster must have at least one 'System' Agent Pool at all times. For additional information on agent pool restrictions and best practices, see: https://docs.microsoft.com/azure/aks/use-system-pools

nodeLabels {[key: string]: string}

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

nodePublicIPPrefixID string

This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}

nodeTaints string[]

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

orchestratorVersion string

Both patch version <major.minor.patch> (e.g. 1.20.13) and <major.minor> (e.g. 1.20) are supported. When <major.minor> is specified, the latest supported GA patch version is chosen automatically. Updating the cluster with the same <major.minor> once it has been created (e.g. 1.14.x -> 1.14) will not trigger an upgrade, even if a newer patch version is available. As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see upgrading a node pool.

osDiskSizeGB number

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

osDiskType string

The default is 'Ephemeral' if the VM supports it and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed after creation. For more information see Ephemeral OS.

osSKU string

Specifies the OS SKU used by the agent pool. The default is Ubuntu if OSType is Linux. The default is Windows2019 when Kubernetes <= 1.24 or Windows2022 when Kubernetes >= 1.25 if OSType is Windows.

osType string

The operating system type. The default is Linux.

podSubnetID string

If omitted, pod IPs are statically assigned on the node subnet (see vnetSubnetID for more details). This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}

powerState PowerStateResponse

When an Agent Pool is first created it is initially Running. The Agent Pool can be stopped by setting this field to Stopped. A stopped Agent Pool stops all of its VMs and does not accrue billing charges. An Agent Pool can only be stopped if it is Running and provisioning state is Succeeded

proximityPlacementGroupID string

The ID for Proximity Placement Group.

scaleDownMode string

This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete.

scaleSetEvictionPolicy string

This cannot be specified unless the scaleSetPriority is 'Spot'. If not specified, the default is 'Delete'.

scaleSetPriority string

The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'.

spotMaxPrice number

Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see spot VMs pricing

tags {[key: string]: string}

The tags to be persisted on the agent pool virtual machine scale set.

upgradeSettings AgentPoolUpgradeSettingsResponse

Settings for upgrading the agentpool

vmSize string

VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions

vnetSubnetID string

If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}

workloadRuntime string

Determines the type of workload a node can run.

current_orchestrator_version str

If orchestratorVersion is a fully specified version <major.minor.patch>, this field will be exactly equal to it. If orchestratorVersion is <major.minor>, this field will contain the full <major.minor.patch> version being used.

id str

Resource ID.

name str

The name of the resource that is unique within a resource group. This name can be used to access the resource.

node_image_version str

The version of node image

provisioning_state str

The current deployment or provisioning state.

type str

Resource type

availability_zones Sequence[str]

The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'.

count int

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

creation_data CreationDataResponse

CreationData to be used to specify the source Snapshot ID if the node pool will be created/upgraded using a snapshot.

enable_auto_scaling bool

Whether to enable auto-scaler

enable_encryption_at_host bool

This is only supported on certain VM sizes and in certain Azure regions. For more information, see: https://docs.microsoft.com/azure/aks/enable-host-encryption

enable_fips bool

See Add a FIPS-enabled node pool for more details.

enable_node_public_ip bool

Some scenarios may require nodes in a node pool to receive their own dedicated public IP addresses. A common scenario is for gaming workloads, where a console needs to make a direct connection to a cloud virtual machine to minimize hops. For more information see assigning a public IP per node. The default is false.

enable_ultra_ssd bool

Whether to enable UltraSSD

gpu_instance_profile str

GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU.

host_group_id str

This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. For more information see Azure dedicated hosts.

kubelet_config KubeletConfigResponse

The Kubelet configuration on the agent pool nodes.

kubelet_disk_type str

Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage.

linux_os_config LinuxOSConfigResponse

The OS configuration of Linux agent nodes.

max_count int

The maximum number of nodes for auto-scaling

max_pods int

The maximum number of pods that can run on a node.

min_count int

The minimum number of nodes for auto-scaling

mode str

A cluster must have at least one 'System' Agent Pool at all times. For additional information on agent pool restrictions and best practices, see: https://docs.microsoft.com/azure/aks/use-system-pools

node_labels Mapping[str, str]

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

node_public_ip_prefix_id str

This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}

node_taints Sequence[str]

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

orchestrator_version str

Both patch version <major.minor.patch> (e.g. 1.20.13) and <major.minor> (e.g. 1.20) are supported. When <major.minor> is specified, the latest supported GA patch version is chosen automatically. Updating the cluster with the same <major.minor> once it has been created (e.g. 1.14.x -> 1.14) will not trigger an upgrade, even if a newer patch version is available. As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see upgrading a node pool.

os_disk_size_gb int

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

os_disk_type str

The default is 'Ephemeral' if the VM supports it and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed after creation. For more information see Ephemeral OS.

os_sku str

Specifies the OS SKU used by the agent pool. The default is Ubuntu if OSType is Linux. The default is Windows2019 when Kubernetes <= 1.24 or Windows2022 when Kubernetes >= 1.25 if OSType is Windows.

os_type str

The operating system type. The default is Linux.

pod_subnet_id str

If omitted, pod IPs are statically assigned on the node subnet (see vnetSubnetID for more details). This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}

power_state PowerStateResponse

When an Agent Pool is first created it is initially Running. The Agent Pool can be stopped by setting this field to Stopped. A stopped Agent Pool stops all of its VMs and does not accrue billing charges. An Agent Pool can only be stopped if it is Running and provisioning state is Succeeded

proximity_placement_group_id str

The ID for Proximity Placement Group.

scale_down_mode str

This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete.

scale_set_eviction_policy str

This cannot be specified unless the scaleSetPriority is 'Spot'. If not specified, the default is 'Delete'.

scale_set_priority str

The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'.

spot_max_price float

Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see spot VMs pricing

tags Mapping[str, str]

The tags to be persisted on the agent pool virtual machine scale set.

upgrade_settings AgentPoolUpgradeSettingsResponse

Settings for upgrading the agentpool

vm_size str

VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions

vnet_subnet_id str

If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}

workload_runtime str

Determines the type of workload a node can run.

currentOrchestratorVersion String

If orchestratorVersion is a fully specified version <major.minor.patch>, this field will be exactly equal to it. If orchestratorVersion is <major.minor>, this field will contain the full <major.minor.patch> version being used.

id String

Resource ID.

name String

The name of the resource that is unique within a resource group. This name can be used to access the resource.

nodeImageVersion String

The version of node image

provisioningState String

The current deployment or provisioning state.

type String

Resource type

availabilityZones List<String>

The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'.

count Number

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

creationData Property Map

CreationData to be used to specify the source Snapshot ID if the node pool will be created/upgraded using a snapshot.

enableAutoScaling Boolean

Whether to enable auto-scaler

enableEncryptionAtHost Boolean

This is only supported on certain VM sizes and in certain Azure regions. For more information, see: https://docs.microsoft.com/azure/aks/enable-host-encryption

enableFIPS Boolean

See Add a FIPS-enabled node pool for more details.

enableNodePublicIP Boolean

Some scenarios may require nodes in a node pool to receive their own dedicated public IP addresses. A common scenario is for gaming workloads, where a console needs to make a direct connection to a cloud virtual machine to minimize hops. For more information see assigning a public IP per node. The default is false.

enableUltraSSD Boolean

Whether to enable UltraSSD

gpuInstanceProfile String

GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU.

hostGroupID String

This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. For more information see Azure dedicated hosts.

kubeletConfig Property Map

The Kubelet configuration on the agent pool nodes.

kubeletDiskType String

Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage.

linuxOSConfig Property Map

The OS configuration of Linux agent nodes.

maxCount Number

The maximum number of nodes for auto-scaling

maxPods Number

The maximum number of pods that can run on a node.

minCount Number

The minimum number of nodes for auto-scaling

mode String

A cluster must have at least one 'System' Agent Pool at all times. For additional information on agent pool restrictions and best practices, see: https://docs.microsoft.com/azure/aks/use-system-pools

nodeLabels Map<String>

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

nodePublicIPPrefixID String

This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}

nodeTaints List<String>

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

orchestratorVersion String

Both patch version <major.minor.patch> (e.g. 1.20.13) and <major.minor> (e.g. 1.20) are supported. When <major.minor> is specified, the latest supported GA patch version is chosen automatically. Updating the cluster with the same <major.minor> once it has been created (e.g. 1.14.x -> 1.14) will not trigger an upgrade, even if a newer patch version is available. As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see upgrading a node pool.

osDiskSizeGB Number

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

osDiskType String

The default is 'Ephemeral' if the VM supports it and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed after creation. For more information see Ephemeral OS.

osSKU String

Specifies the OS SKU used by the agent pool. The default is Ubuntu if OSType is Linux. The default is Windows2019 when Kubernetes <= 1.24 or Windows2022 when Kubernetes >= 1.25 if OSType is Windows.

osType String

The operating system type. The default is Linux.

podSubnetID String

If omitted, pod IPs are statically assigned on the node subnet (see vnetSubnetID for more details). This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}

powerState Property Map

When an Agent Pool is first created it is initially Running. The Agent Pool can be stopped by setting this field to Stopped. A stopped Agent Pool stops all of its VMs and does not accrue billing charges. An Agent Pool can only be stopped if it is Running and provisioning state is Succeeded

proximityPlacementGroupID String

The ID for Proximity Placement Group.

scaleDownMode String

This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete.

scaleSetEvictionPolicy String

This cannot be specified unless the scaleSetPriority is 'Spot'. If not specified, the default is 'Delete'.

scaleSetPriority String

The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'.

spotMaxPrice Number

Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see spot VMs pricing

tags Map<String>

The tags to be persisted on the agent pool virtual machine scale set.

upgradeSettings Property Map

Settings for upgrading the agentpool

vmSize String

VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions

vnetSubnetID String

If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}

workloadRuntime String

Determines the type of workload a node can run.

MaxSurge string

This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 1. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade

MaxSurge string

This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 1. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade

maxSurge String

This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 1. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade

maxSurge string

This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 1. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade

max_surge str

This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 1. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade

maxSurge String

This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 1. For more information, including best practices, see: https://docs.microsoft.com/azure/aks/upgrade-cluster#customize-node-surge-upgrade

SourceResourceId string

This is the ARM ID of the source object to be used to create the target object.

SourceResourceId string

This is the ARM ID of the source object to be used to create the target object.

sourceResourceId String

This is the ARM ID of the source object to be used to create the target object.

sourceResourceId string

This is the ARM ID of the source object to be used to create the target object.

source_resource_id str

This is the ARM ID of the source object to be used to create the target object.

sourceResourceId String

This is the ARM ID of the source object to be used to create the target object.

AllowedUnsafeSysctls List<string>

Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in *).

ContainerLogMaxFiles int

The maximum number of container log files that can be present for a container. The number must be ≥ 2.

ContainerLogMaxSizeMB int

The maximum size (e.g. 10Mi) of container log file before it is rotated.

CpuCfsQuota bool

The default is true.

CpuCfsQuotaPeriod string

The default is '100ms.' Valid values are a sequence of decimal numbers with an optional fraction and a unit suffix. For example: '300ms', '2h45m'. Supported units are 'ns', 'us', 'ms', 's', 'm', and 'h'.

CpuManagerPolicy string

The default is 'none'. See Kubernetes CPU management policies for more information. Allowed values are 'none' and 'static'.

FailSwapOn bool

If set to true it will make the Kubelet fail to start if swap is enabled on the node.

ImageGcHighThreshold int

To disable image garbage collection, set to 100. The default is 85%

ImageGcLowThreshold int

This cannot be set higher than imageGcHighThreshold. The default is 80%

PodMaxPids int

The maximum number of processes per pod.

TopologyManagerPolicy string

For more information see Kubernetes Topology Manager. The default is 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'.

AllowedUnsafeSysctls []string

Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in *).

ContainerLogMaxFiles int

The maximum number of container log files that can be present for a container. The number must be ≥ 2.

ContainerLogMaxSizeMB int

The maximum size (e.g. 10Mi) of container log file before it is rotated.

CpuCfsQuota bool

The default is true.

CpuCfsQuotaPeriod string

The default is '100ms.' Valid values are a sequence of decimal numbers with an optional fraction and a unit suffix. For example: '300ms', '2h45m'. Supported units are 'ns', 'us', 'ms', 's', 'm', and 'h'.

CpuManagerPolicy string

The default is 'none'. See Kubernetes CPU management policies for more information. Allowed values are 'none' and 'static'.

FailSwapOn bool

If set to true it will make the Kubelet fail to start if swap is enabled on the node.

ImageGcHighThreshold int

To disable image garbage collection, set to 100. The default is 85%

ImageGcLowThreshold int

This cannot be set higher than imageGcHighThreshold. The default is 80%

PodMaxPids int

The maximum number of processes per pod.

TopologyManagerPolicy string

For more information see Kubernetes Topology Manager. The default is 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'.

allowedUnsafeSysctls List<String>

Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in *).

containerLogMaxFiles Integer

The maximum number of container log files that can be present for a container. The number must be ≥ 2.

containerLogMaxSizeMB Integer

The maximum size (e.g. 10Mi) of container log file before it is rotated.

cpuCfsQuota Boolean

The default is true.

cpuCfsQuotaPeriod String

The default is '100ms.' Valid values are a sequence of decimal numbers with an optional fraction and a unit suffix. For example: '300ms', '2h45m'. Supported units are 'ns', 'us', 'ms', 's', 'm', and 'h'.

cpuManagerPolicy String

The default is 'none'. See Kubernetes CPU management policies for more information. Allowed values are 'none' and 'static'.

failSwapOn Boolean

If set to true it will make the Kubelet fail to start if swap is enabled on the node.

imageGcHighThreshold Integer

To disable image garbage collection, set to 100. The default is 85%

imageGcLowThreshold Integer

This cannot be set higher than imageGcHighThreshold. The default is 80%

podMaxPids Integer

The maximum number of processes per pod.

topologyManagerPolicy String

For more information see Kubernetes Topology Manager. The default is 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'.

allowedUnsafeSysctls string[]

Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in *).

containerLogMaxFiles number

The maximum number of container log files that can be present for a container. The number must be ≥ 2.

containerLogMaxSizeMB number

The maximum size (e.g. 10Mi) of container log file before it is rotated.

cpuCfsQuota boolean

The default is true.

cpuCfsQuotaPeriod string

The default is '100ms.' Valid values are a sequence of decimal numbers with an optional fraction and a unit suffix. For example: '300ms', '2h45m'. Supported units are 'ns', 'us', 'ms', 's', 'm', and 'h'.

cpuManagerPolicy string

The default is 'none'. See Kubernetes CPU management policies for more information. Allowed values are 'none' and 'static'.

failSwapOn boolean

If set to true it will make the Kubelet fail to start if swap is enabled on the node.

imageGcHighThreshold number

To disable image garbage collection, set to 100. The default is 85%

imageGcLowThreshold number

This cannot be set higher than imageGcHighThreshold. The default is 80%

podMaxPids number

The maximum number of processes per pod.

topologyManagerPolicy string

For more information see Kubernetes Topology Manager. The default is 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'.

allowed_unsafe_sysctls Sequence[str]

Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in *).

container_log_max_files int

The maximum number of container log files that can be present for a container. The number must be ≥ 2.

container_log_max_size_mb int

The maximum size (e.g. 10Mi) of container log file before it is rotated.

cpu_cfs_quota bool

The default is true.

cpu_cfs_quota_period str

The default is '100ms.' Valid values are a sequence of decimal numbers with an optional fraction and a unit suffix. For example: '300ms', '2h45m'. Supported units are 'ns', 'us', 'ms', 's', 'm', and 'h'.

cpu_manager_policy str

The default is 'none'. See Kubernetes CPU management policies for more information. Allowed values are 'none' and 'static'.

fail_swap_on bool

If set to true it will make the Kubelet fail to start if swap is enabled on the node.

image_gc_high_threshold int

To disable image garbage collection, set to 100. The default is 85%

image_gc_low_threshold int

This cannot be set higher than imageGcHighThreshold. The default is 80%

pod_max_pids int

The maximum number of processes per pod.

topology_manager_policy str

For more information see Kubernetes Topology Manager. The default is 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'.

allowedUnsafeSysctls List<String>

Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in *).

containerLogMaxFiles Number

The maximum number of container log files that can be present for a container. The number must be ≥ 2.

containerLogMaxSizeMB Number

The maximum size (e.g. 10Mi) of container log file before it is rotated.

cpuCfsQuota Boolean

The default is true.

cpuCfsQuotaPeriod String

The default is '100ms.' Valid values are a sequence of decimal numbers with an optional fraction and a unit suffix. For example: '300ms', '2h45m'. Supported units are 'ns', 'us', 'ms', 's', 'm', and 'h'.

cpuManagerPolicy String

The default is 'none'. See Kubernetes CPU management policies for more information. Allowed values are 'none' and 'static'.

failSwapOn Boolean

If set to true it will make the Kubelet fail to start if swap is enabled on the node.

imageGcHighThreshold Number

To disable image garbage collection, set to 100. The default is 85%

imageGcLowThreshold Number

This cannot be set higher than imageGcHighThreshold. The default is 80%

podMaxPids Number

The maximum number of processes per pod.

topologyManagerPolicy String

For more information see Kubernetes Topology Manager. The default is 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'.

SwapFileSizeMB int

The size in MB of a swap file that will be created on each node.

Sysctls Pulumi.AzureNative.ContainerService.Inputs.SysctlConfigResponse

Sysctl settings for Linux agent nodes.

TransparentHugePageDefrag string

Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see Transparent Hugepages.

TransparentHugePageEnabled string

Valid values are 'always', 'madvise', and 'never'. The default is 'always'. For more information see Transparent Hugepages.

SwapFileSizeMB int

The size in MB of a swap file that will be created on each node.

Sysctls SysctlConfigResponse

Sysctl settings for Linux agent nodes.

TransparentHugePageDefrag string

Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see Transparent Hugepages.

TransparentHugePageEnabled string

Valid values are 'always', 'madvise', and 'never'. The default is 'always'. For more information see Transparent Hugepages.

swapFileSizeMB Integer

The size in MB of a swap file that will be created on each node.

sysctls SysctlConfigResponse

Sysctl settings for Linux agent nodes.

transparentHugePageDefrag String

Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see Transparent Hugepages.

transparentHugePageEnabled String

Valid values are 'always', 'madvise', and 'never'. The default is 'always'. For more information see Transparent Hugepages.

swapFileSizeMB number

The size in MB of a swap file that will be created on each node.

sysctls SysctlConfigResponse

Sysctl settings for Linux agent nodes.

transparentHugePageDefrag string

Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see Transparent Hugepages.

transparentHugePageEnabled string

Valid values are 'always', 'madvise', and 'never'. The default is 'always'. For more information see Transparent Hugepages.

swap_file_size_mb int

The size in MB of a swap file that will be created on each node.

sysctls SysctlConfigResponse

Sysctl settings for Linux agent nodes.

transparent_huge_page_defrag str

Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see Transparent Hugepages.

transparent_huge_page_enabled str

Valid values are 'always', 'madvise', and 'never'. The default is 'always'. For more information see Transparent Hugepages.

swapFileSizeMB Number

The size in MB of a swap file that will be created on each node.

sysctls Property Map

Sysctl settings for Linux agent nodes.

transparentHugePageDefrag String

Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see Transparent Hugepages.

transparentHugePageEnabled String

Valid values are 'always', 'madvise', and 'never'. The default is 'always'. For more information see Transparent Hugepages.

Code string

Tells whether the cluster is Running or Stopped

Code string

Tells whether the cluster is Running or Stopped

code String

Tells whether the cluster is Running or Stopped

code string

Tells whether the cluster is Running or Stopped

code str

Tells whether the cluster is Running or Stopped

code String

Tells whether the cluster is Running or Stopped

FsAioMaxNr int

Sysctl setting fs.aio-max-nr.

FsFileMax int

Sysctl setting fs.file-max.

FsInotifyMaxUserWatches int

Sysctl setting fs.inotify.max_user_watches.

FsNrOpen int

Sysctl setting fs.nr_open.

KernelThreadsMax int

Sysctl setting kernel.threads-max.

NetCoreNetdevMaxBacklog int

Sysctl setting net.core.netdev_max_backlog.

NetCoreOptmemMax int

Sysctl setting net.core.optmem_max.

NetCoreRmemDefault int

Sysctl setting net.core.rmem_default.

NetCoreRmemMax int

Sysctl setting net.core.rmem_max.

NetCoreSomaxconn int

Sysctl setting net.core.somaxconn.

NetCoreWmemDefault int

Sysctl setting net.core.wmem_default.

NetCoreWmemMax int

Sysctl setting net.core.wmem_max.

NetIpv4IpLocalPortRange string

Sysctl setting net.ipv4.ip_local_port_range.

NetIpv4NeighDefaultGcThresh1 int

Sysctl setting net.ipv4.neigh.default.gc_thresh1.

NetIpv4NeighDefaultGcThresh2 int

Sysctl setting net.ipv4.neigh.default.gc_thresh2.

NetIpv4NeighDefaultGcThresh3 int

Sysctl setting net.ipv4.neigh.default.gc_thresh3.

NetIpv4TcpFinTimeout int

Sysctl setting net.ipv4.tcp_fin_timeout.

NetIpv4TcpKeepaliveProbes int

Sysctl setting net.ipv4.tcp_keepalive_probes.

NetIpv4TcpKeepaliveTime int

Sysctl setting net.ipv4.tcp_keepalive_time.

NetIpv4TcpMaxSynBacklog int

Sysctl setting net.ipv4.tcp_max_syn_backlog.

NetIpv4TcpMaxTwBuckets int

Sysctl setting net.ipv4.tcp_max_tw_buckets.

NetIpv4TcpTwReuse bool

Sysctl setting net.ipv4.tcp_tw_reuse.

NetIpv4TcpkeepaliveIntvl int

Sysctl setting net.ipv4.tcp_keepalive_intvl.

NetNetfilterNfConntrackBuckets int

Sysctl setting net.netfilter.nf_conntrack_buckets.

NetNetfilterNfConntrackMax int

Sysctl setting net.netfilter.nf_conntrack_max.

VmMaxMapCount int

Sysctl setting vm.max_map_count.

VmSwappiness int

Sysctl setting vm.swappiness.

VmVfsCachePressure int

Sysctl setting vm.vfs_cache_pressure.

FsAioMaxNr int

Sysctl setting fs.aio-max-nr.

FsFileMax int

Sysctl setting fs.file-max.

FsInotifyMaxUserWatches int

Sysctl setting fs.inotify.max_user_watches.

FsNrOpen int

Sysctl setting fs.nr_open.

KernelThreadsMax int

Sysctl setting kernel.threads-max.

NetCoreNetdevMaxBacklog int

Sysctl setting net.core.netdev_max_backlog.

NetCoreOptmemMax int

Sysctl setting net.core.optmem_max.

NetCoreRmemDefault int

Sysctl setting net.core.rmem_default.

NetCoreRmemMax int

Sysctl setting net.core.rmem_max.

NetCoreSomaxconn int

Sysctl setting net.core.somaxconn.

NetCoreWmemDefault int

Sysctl setting net.core.wmem_default.

NetCoreWmemMax int

Sysctl setting net.core.wmem_max.

NetIpv4IpLocalPortRange string

Sysctl setting net.ipv4.ip_local_port_range.

NetIpv4NeighDefaultGcThresh1 int

Sysctl setting net.ipv4.neigh.default.gc_thresh1.

NetIpv4NeighDefaultGcThresh2 int

Sysctl setting net.ipv4.neigh.default.gc_thresh2.

NetIpv4NeighDefaultGcThresh3 int

Sysctl setting net.ipv4.neigh.default.gc_thresh3.

NetIpv4TcpFinTimeout int

Sysctl setting net.ipv4.tcp_fin_timeout.

NetIpv4TcpKeepaliveProbes int

Sysctl setting net.ipv4.tcp_keepalive_probes.

NetIpv4TcpKeepaliveTime int

Sysctl setting net.ipv4.tcp_keepalive_time.

NetIpv4TcpMaxSynBacklog int

Sysctl setting net.ipv4.tcp_max_syn_backlog.

NetIpv4TcpMaxTwBuckets int

Sysctl setting net.ipv4.tcp_max_tw_buckets.

NetIpv4TcpTwReuse bool

Sysctl setting net.ipv4.tcp_tw_reuse.

NetIpv4TcpkeepaliveIntvl int

Sysctl setting net.ipv4.tcp_keepalive_intvl.

NetNetfilterNfConntrackBuckets int

Sysctl setting net.netfilter.nf_conntrack_buckets.

NetNetfilterNfConntrackMax int

Sysctl setting net.netfilter.nf_conntrack_max.

VmMaxMapCount int

Sysctl setting vm.max_map_count.

VmSwappiness int

Sysctl setting vm.swappiness.

VmVfsCachePressure int

Sysctl setting vm.vfs_cache_pressure.

fsAioMaxNr Integer

Sysctl setting fs.aio-max-nr.

fsFileMax Integer

Sysctl setting fs.file-max.

fsInotifyMaxUserWatches Integer

Sysctl setting fs.inotify.max_user_watches.

fsNrOpen Integer

Sysctl setting fs.nr_open.

kernelThreadsMax Integer

Sysctl setting kernel.threads-max.

netCoreNetdevMaxBacklog Integer

Sysctl setting net.core.netdev_max_backlog.

netCoreOptmemMax Integer

Sysctl setting net.core.optmem_max.

netCoreRmemDefault Integer

Sysctl setting net.core.rmem_default.

netCoreRmemMax Integer

Sysctl setting net.core.rmem_max.

netCoreSomaxconn Integer

Sysctl setting net.core.somaxconn.

netCoreWmemDefault Integer

Sysctl setting net.core.wmem_default.

netCoreWmemMax Integer

Sysctl setting net.core.wmem_max.

netIpv4IpLocalPortRange String

Sysctl setting net.ipv4.ip_local_port_range.

netIpv4NeighDefaultGcThresh1 Integer

Sysctl setting net.ipv4.neigh.default.gc_thresh1.

netIpv4NeighDefaultGcThresh2 Integer

Sysctl setting net.ipv4.neigh.default.gc_thresh2.

netIpv4NeighDefaultGcThresh3 Integer

Sysctl setting net.ipv4.neigh.default.gc_thresh3.

netIpv4TcpFinTimeout Integer

Sysctl setting net.ipv4.tcp_fin_timeout.

netIpv4TcpKeepaliveProbes Integer

Sysctl setting net.ipv4.tcp_keepalive_probes.

netIpv4TcpKeepaliveTime Integer

Sysctl setting net.ipv4.tcp_keepalive_time.

netIpv4TcpMaxSynBacklog Integer

Sysctl setting net.ipv4.tcp_max_syn_backlog.

netIpv4TcpMaxTwBuckets Integer

Sysctl setting net.ipv4.tcp_max_tw_buckets.

netIpv4TcpTwReuse Boolean

Sysctl setting net.ipv4.tcp_tw_reuse.

netIpv4TcpkeepaliveIntvl Integer

Sysctl setting net.ipv4.tcp_keepalive_intvl.

netNetfilterNfConntrackBuckets Integer

Sysctl setting net.netfilter.nf_conntrack_buckets.

netNetfilterNfConntrackMax Integer

Sysctl setting net.netfilter.nf_conntrack_max.

vmMaxMapCount Integer

Sysctl setting vm.max_map_count.

vmSwappiness Integer

Sysctl setting vm.swappiness.

vmVfsCachePressure Integer

Sysctl setting vm.vfs_cache_pressure.

fsAioMaxNr number

Sysctl setting fs.aio-max-nr.

fsFileMax number

Sysctl setting fs.file-max.

fsInotifyMaxUserWatches number

Sysctl setting fs.inotify.max_user_watches.

fsNrOpen number

Sysctl setting fs.nr_open.

kernelThreadsMax number

Sysctl setting kernel.threads-max.

netCoreNetdevMaxBacklog number

Sysctl setting net.core.netdev_max_backlog.

netCoreOptmemMax number

Sysctl setting net.core.optmem_max.

netCoreRmemDefault number

Sysctl setting net.core.rmem_default.

netCoreRmemMax number

Sysctl setting net.core.rmem_max.

netCoreSomaxconn number

Sysctl setting net.core.somaxconn.

netCoreWmemDefault number

Sysctl setting net.core.wmem_default.

netCoreWmemMax number

Sysctl setting net.core.wmem_max.

netIpv4IpLocalPortRange string

Sysctl setting net.ipv4.ip_local_port_range.

netIpv4NeighDefaultGcThresh1 number

Sysctl setting net.ipv4.neigh.default.gc_thresh1.

netIpv4NeighDefaultGcThresh2 number

Sysctl setting net.ipv4.neigh.default.gc_thresh2.

netIpv4NeighDefaultGcThresh3 number

Sysctl setting net.ipv4.neigh.default.gc_thresh3.

netIpv4TcpFinTimeout number

Sysctl setting net.ipv4.tcp_fin_timeout.

netIpv4TcpKeepaliveProbes number

Sysctl setting net.ipv4.tcp_keepalive_probes.

netIpv4TcpKeepaliveTime number

Sysctl setting net.ipv4.tcp_keepalive_time.

netIpv4TcpMaxSynBacklog number

Sysctl setting net.ipv4.tcp_max_syn_backlog.

netIpv4TcpMaxTwBuckets number

Sysctl setting net.ipv4.tcp_max_tw_buckets.

netIpv4TcpTwReuse boolean

Sysctl setting net.ipv4.tcp_tw_reuse.

netIpv4TcpkeepaliveIntvl number

Sysctl setting net.ipv4.tcp_keepalive_intvl.

netNetfilterNfConntrackBuckets number

Sysctl setting net.netfilter.nf_conntrack_buckets.

netNetfilterNfConntrackMax number

Sysctl setting net.netfilter.nf_conntrack_max.

vmMaxMapCount number

Sysctl setting vm.max_map_count.

vmSwappiness number

Sysctl setting vm.swappiness.

vmVfsCachePressure number

Sysctl setting vm.vfs_cache_pressure.

fs_aio_max_nr int

Sysctl setting fs.aio-max-nr.

fs_file_max int

Sysctl setting fs.file-max.

fs_inotify_max_user_watches int

Sysctl setting fs.inotify.max_user_watches.

fs_nr_open int

Sysctl setting fs.nr_open.

kernel_threads_max int

Sysctl setting kernel.threads-max.

net_core_netdev_max_backlog int

Sysctl setting net.core.netdev_max_backlog.

net_core_optmem_max int

Sysctl setting net.core.optmem_max.

net_core_rmem_default int

Sysctl setting net.core.rmem_default.

net_core_rmem_max int

Sysctl setting net.core.rmem_max.

net_core_somaxconn int

Sysctl setting net.core.somaxconn.

net_core_wmem_default int

Sysctl setting net.core.wmem_default.

net_core_wmem_max int

Sysctl setting net.core.wmem_max.

net_ipv4_ip_local_port_range str

Sysctl setting net.ipv4.ip_local_port_range.

net_ipv4_neigh_default_gc_thresh1 int

Sysctl setting net.ipv4.neigh.default.gc_thresh1.

net_ipv4_neigh_default_gc_thresh2 int

Sysctl setting net.ipv4.neigh.default.gc_thresh2.

net_ipv4_neigh_default_gc_thresh3 int

Sysctl setting net.ipv4.neigh.default.gc_thresh3.

net_ipv4_tcp_fin_timeout int

Sysctl setting net.ipv4.tcp_fin_timeout.

net_ipv4_tcp_keepalive_probes int

Sysctl setting net.ipv4.tcp_keepalive_probes.

net_ipv4_tcp_keepalive_time int

Sysctl setting net.ipv4.tcp_keepalive_time.

net_ipv4_tcp_max_syn_backlog int

Sysctl setting net.ipv4.tcp_max_syn_backlog.

net_ipv4_tcp_max_tw_buckets int

Sysctl setting net.ipv4.tcp_max_tw_buckets.

net_ipv4_tcp_tw_reuse bool

Sysctl setting net.ipv4.tcp_tw_reuse.

net_ipv4_tcpkeepalive_intvl int

Sysctl setting net.ipv4.tcp_keepalive_intvl.

net_netfilter_nf_conntrack_buckets int

Sysctl setting net.netfilter.nf_conntrack_buckets.

net_netfilter_nf_conntrack_max int

Sysctl setting net.netfilter.nf_conntrack_max.

vm_max_map_count int

Sysctl setting vm.max_map_count.

vm_swappiness int

Sysctl setting vm.swappiness.

vm_vfs_cache_pressure int

Sysctl setting vm.vfs_cache_pressure.

fsAioMaxNr Number

Sysctl setting fs.aio-max-nr.

fsFileMax Number

Sysctl setting fs.file-max.

fsInotifyMaxUserWatches Number

Sysctl setting fs.inotify.max_user_watches.

fsNrOpen Number

Sysctl setting fs.nr_open.

kernelThreadsMax Number

Sysctl setting kernel.threads-max.

netCoreNetdevMaxBacklog Number

Sysctl setting net.core.netdev_max_backlog.

netCoreOptmemMax Number

Sysctl setting net.core.optmem_max.

netCoreRmemDefault Number

Sysctl setting net.core.rmem_default.

netCoreRmemMax Number

Sysctl setting net.core.rmem_max.

netCoreSomaxconn Number

Sysctl setting net.core.somaxconn.

netCoreWmemDefault Number

Sysctl setting net.core.wmem_default.

netCoreWmemMax Number

Sysctl setting net.core.wmem_max.

netIpv4IpLocalPortRange String

Sysctl setting net.ipv4.ip_local_port_range.

netIpv4NeighDefaultGcThresh1 Number

Sysctl setting net.ipv4.neigh.default.gc_thresh1.

netIpv4NeighDefaultGcThresh2 Number

Sysctl setting net.ipv4.neigh.default.gc_thresh2.

netIpv4NeighDefaultGcThresh3 Number

Sysctl setting net.ipv4.neigh.default.gc_thresh3.

netIpv4TcpFinTimeout Number

Sysctl setting net.ipv4.tcp_fin_timeout.

netIpv4TcpKeepaliveProbes Number

Sysctl setting net.ipv4.tcp_keepalive_probes.

netIpv4TcpKeepaliveTime Number

Sysctl setting net.ipv4.tcp_keepalive_time.

netIpv4TcpMaxSynBacklog Number

Sysctl setting net.ipv4.tcp_max_syn_backlog.

netIpv4TcpMaxTwBuckets Number

Sysctl setting net.ipv4.tcp_max_tw_buckets.

netIpv4TcpTwReuse Boolean

Sysctl setting net.ipv4.tcp_tw_reuse.

netIpv4TcpkeepaliveIntvl Number

Sysctl setting net.ipv4.tcp_keepalive_intvl.

netNetfilterNfConntrackBuckets Number

Sysctl setting net.netfilter.nf_conntrack_buckets.

netNetfilterNfConntrackMax Number

Sysctl setting net.netfilter.nf_conntrack_max.

vmMaxMapCount Number

Sysctl setting vm.max_map_count.

vmSwappiness Number

Sysctl setting vm.swappiness.

vmVfsCachePressure Number

Sysctl setting vm.vfs_cache_pressure.