azure-native.containerservice.getAgentPool

Azure Native v3.11.0, Dec 5 25

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.

Azure Native v3.11.0 published on Friday, Dec 5, 2025 by Pulumi

Schema (JSON)

pulumi/pulumi-azure-native

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.

Azure Native v3.11.0 published on Friday, Dec 5, 2025 by Pulumi

Schema (JSON)

pulumi/pulumi-azure-native

Other available API versions: 2019-11-01, 2020-01-01, 2020-02-01, 2020-03-01, 2020-04-01, 2020-06-01, 2020-07-01, 2020-09-01, 2020-11-01, 2020-12-01, 2021-02-01, 2021-03-01, 2021-05-01, 2021-07-01, 2021-08-01, 2021-09-01, 2021-10-01, 2021-11-01-preview, 2022-01-01, 2022-01-02-preview, 2022-02-01, 2022-02-02-preview, 2022-03-01, 2022-03-02-preview, 2022-04-01, 2022-04-02-preview, 2022-05-02-preview, 2022-06-01, 2022-06-02-preview, 2022-07-01, 2022-07-02-preview, 2022-08-02-preview, 2022-08-03-preview, 2022-09-01, 2022-09-02-preview, 2022-10-02-preview, 2022-11-01, 2022-11-02-preview, 2023-01-01, 2023-01-02-preview, 2023-02-01, 2023-02-02-preview, 2023-03-01, 2023-03-02-preview, 2023-04-01, 2023-04-02-preview, 2023-05-01, 2023-05-02-preview, 2023-06-01, 2023-06-02-preview, 2023-07-01, 2023-07-02-preview, 2023-08-01, 2023-08-02-preview, 2023-09-01, 2023-09-02-preview, 2023-10-01, 2023-10-02-preview, 2023-11-01, 2023-11-02-preview, 2024-01-01, 2024-01-02-preview, 2024-02-01, 2024-02-02-preview, 2024-03-02-preview, 2024-04-02-preview, 2024-05-01, 2024-05-02-preview, 2024-06-02-preview, 2024-07-01, 2024-07-02-preview, 2024-08-01, 2024-09-01, 2024-09-02-preview, 2024-10-01, 2024-10-02-preview, 2025-01-01, 2025-01-02-preview, 2025-02-01, 2025-02-02-preview, 2025-03-01, 2025-03-02-preview, 2025-04-01, 2025-04-02-preview, 2025-05-01, 2025-05-02-preview, 2025-06-02-preview, 2025-07-01, 2025-07-02-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native containerservice [ApiVersion]. See the version guide for details.

Using getAgentPool

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getAgentPool(args: GetAgentPoolArgs, opts?: InvokeOptions): Promise<GetAgentPoolResult>
function getAgentPoolOutput(args: GetAgentPoolOutputArgs, opts?: InvokeOptions): Output<GetAgentPoolResult>

def get_agent_pool(agent_pool_name: Optional[str] = None,
                   resource_group_name: Optional[str] = None,
                   resource_name: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetAgentPoolResult
def get_agent_pool_output(agent_pool_name: Optional[pulumi.Input[str]] = None,
                   resource_group_name: Optional[pulumi.Input[str]] = None,
                   resource_name: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetAgentPoolResult]

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.

public static class GetAgentPool 
{
    public static Task<GetAgentPoolResult> InvokeAsync(GetAgentPoolArgs args, InvokeOptions? opts = null)
    public static Output<GetAgentPoolResult> Invoke(GetAgentPoolInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetAgentPoolResult> getAgentPool(GetAgentPoolArgs args, InvokeOptions options)
public static Output<GetAgentPoolResult> getAgentPool(GetAgentPoolArgs args, InvokeOptions options)

fn::invoke:
  function: azure-native:containerservice:getAgentPool
  arguments:
    # arguments dictionary

The following arguments are supported:

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.

getAgentPool Result

The following output properties are available:

AzureApiVersion string: The Azure API version of the resource.
CurrentOrchestratorVersion string: The version of Kubernetes the Agent Pool is running. 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.
ETag string: Unique read-only string used to implement optimistic concurrency. The eTag value will change when the resource is updated. Specify an if-match or if-none-match header with the eTag value for a subsequent request to enable optimistic concurrency per the normal etag convention.
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'.
CapacityReservationGroupID string: AKS will associate the specified agent pool with the Capacity Reservation Group.
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: Whether to enable host based OS and data drive encryption. 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: Whether to use a FIPS-enabled OS. See Add a FIPS-enabled node pool for more details.
EnableNodePublicIP bool: Whether each node is allocated its own public IP. 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
GatewayProfile Pulumi.AzureNative.ContainerService.Outputs.AgentPoolGatewayProfileResponse: Profile specific to a managed agent pool in Gateway mode. This field cannot be set if agent pool mode is not Gateway.
GpuInstanceProfile string: GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU.
GpuProfile Pulumi.AzureNative.ContainerService.Outputs.GPUProfileResponse: GPU settings for the Agent Pool.
HostGroupID string: The fully qualified resource ID of the Dedicated Host Group to provision virtual machines from, used only in creation scenario and not allowed to changed once set. 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.
MessageOfTheDay string: Message of the day for Linux nodes, base64-encoded. A base64-encoded string which will be written to /etc/motd after decoding. This allows customization of the message of the day for Linux nodes. It must not be specified for Windows nodes. It must be a static string (i.e., will be printed raw and not be executed as a script).
MinCount int: The minimum number of nodes for auto-scaling
Mode string: The mode of an agent pool. 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
NetworkProfile Pulumi.AzureNative.ContainerService.Outputs.AgentPoolNetworkProfileResponse: Network-related settings of an agent pool.
NodeLabels Dictionary<string, string>: The node labels to be persisted across all nodes in agent pool.
NodePublicIPPrefixID string: The public IP prefix ID which VM nodes should use IPs from. 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: The version of Kubernetes specified by the user. 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 OS disk type to be used for machines in the agent pool. 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.
PodIPAllocationMode string: Pod IP Allocation Mode. The IP allocation mode for pods in the agent pool. Must be used with podSubnetId. The default is 'DynamicIndividual'.
PodSubnetID string: The ID of the subnet which pods will join when launched. 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: Whether the Agent Pool is running or stopped. 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: The scale down mode to use when scaling the Agent Pool. This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete.
ScaleSetEvictionPolicy string: The Virtual Machine Scale Set eviction policy to use. 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'.
SecurityProfile Pulumi.AzureNative.ContainerService.Outputs.AgentPoolSecurityProfileResponse: The security settings of an agent pool.
SpotMaxPrice double: The max price (in US Dollars) you are willing to pay for spot instances. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand. 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
Status Pulumi.AzureNative.ContainerService.Outputs.AgentPoolStatusResponse: Contains read-only information about the Agent Pool.
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
VirtualMachineNodesStatus List<Pulumi.AzureNative.ContainerService.Outputs.VirtualMachineNodesResponse>: The status of nodes in a VirtualMachines agent pool.
VirtualMachinesProfile Pulumi.AzureNative.ContainerService.Outputs.VirtualMachinesProfileResponse: Specifications on VirtualMachines agent pool.
VmSize string: The size of the agent pool VMs. 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: The ID of the subnet which agent pool nodes and optionally pods will join on startup. 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}
WindowsProfile Pulumi.AzureNative.ContainerService.Outputs.AgentPoolWindowsProfileResponse: The Windows agent pool's specific profile.
WorkloadRuntime string: Determines the type of workload a node can run.

AzureApiVersion string: The Azure API version of the resource.
CurrentOrchestratorVersion string: The version of Kubernetes the Agent Pool is running. 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.
ETag string: Unique read-only string used to implement optimistic concurrency. The eTag value will change when the resource is updated. Specify an if-match or if-none-match header with the eTag value for a subsequent request to enable optimistic concurrency per the normal etag convention.
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'.
CapacityReservationGroupID string: AKS will associate the specified agent pool with the Capacity Reservation Group.
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: Whether to enable host based OS and data drive encryption. 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: Whether to use a FIPS-enabled OS. See Add a FIPS-enabled node pool for more details.
EnableNodePublicIP bool: Whether each node is allocated its own public IP. 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
GatewayProfile AgentPoolGatewayProfileResponse: Profile specific to a managed agent pool in Gateway mode. This field cannot be set if agent pool mode is not Gateway.
GpuInstanceProfile string: GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU.
GpuProfile GPUProfileResponse: GPU settings for the Agent Pool.
HostGroupID string: The fully qualified resource ID of the Dedicated Host Group to provision virtual machines from, used only in creation scenario and not allowed to changed once set. 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.
MessageOfTheDay string: Message of the day for Linux nodes, base64-encoded. A base64-encoded string which will be written to /etc/motd after decoding. This allows customization of the message of the day for Linux nodes. It must not be specified for Windows nodes. It must be a static string (i.e., will be printed raw and not be executed as a script).
MinCount int: The minimum number of nodes for auto-scaling
Mode string: The mode of an agent pool. 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
NetworkProfile AgentPoolNetworkProfileResponse: Network-related settings of an agent pool.
NodeLabels map[string]string: The node labels to be persisted across all nodes in agent pool.
NodePublicIPPrefixID string: The public IP prefix ID which VM nodes should use IPs from. 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: The version of Kubernetes specified by the user. 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 OS disk type to be used for machines in the agent pool. 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.
PodIPAllocationMode string: Pod IP Allocation Mode. The IP allocation mode for pods in the agent pool. Must be used with podSubnetId. The default is 'DynamicIndividual'.
PodSubnetID string: The ID of the subnet which pods will join when launched. 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: Whether the Agent Pool is running or stopped. 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: The scale down mode to use when scaling the Agent Pool. This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete.
ScaleSetEvictionPolicy string: The Virtual Machine Scale Set eviction policy to use. 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'.
SecurityProfile AgentPoolSecurityProfileResponse: The security settings of an agent pool.
SpotMaxPrice float64: The max price (in US Dollars) you are willing to pay for spot instances. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand. 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
Status AgentPoolStatusResponse: Contains read-only information about the Agent Pool.
Tags map[string]string: The tags to be persisted on the agent pool virtual machine scale set.
UpgradeSettings AgentPoolUpgradeSettingsResponse: Settings for upgrading the agentpool
VirtualMachineNodesStatus []VirtualMachineNodesResponse: The status of nodes in a VirtualMachines agent pool.
VirtualMachinesProfile VirtualMachinesProfileResponse: Specifications on VirtualMachines agent pool.
VmSize string: The size of the agent pool VMs. 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: The ID of the subnet which agent pool nodes and optionally pods will join on startup. 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}
WindowsProfile AgentPoolWindowsProfileResponse: The Windows agent pool's specific profile.
WorkloadRuntime string: Determines the type of workload a node can run.

azureApiVersion String: The Azure API version of the resource.
currentOrchestratorVersion String: The version of Kubernetes the Agent Pool is running. 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.
eTag String: Unique read-only string used to implement optimistic concurrency. The eTag value will change when the resource is updated. Specify an if-match or if-none-match header with the eTag value for a subsequent request to enable optimistic concurrency per the normal etag convention.
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'.
capacityReservationGroupID String: AKS will associate the specified agent pool with the Capacity Reservation Group.
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: Whether to enable host based OS and data drive encryption. 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: Whether to use a FIPS-enabled OS. See Add a FIPS-enabled node pool for more details.
enableNodePublicIP Boolean: Whether each node is allocated its own public IP. 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
gatewayProfile AgentPoolGatewayProfileResponse: Profile specific to a managed agent pool in Gateway mode. This field cannot be set if agent pool mode is not Gateway.
gpuInstanceProfile String: GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU.
gpuProfile GPUProfileResponse: GPU settings for the Agent Pool.
hostGroupID String: The fully qualified resource ID of the Dedicated Host Group to provision virtual machines from, used only in creation scenario and not allowed to changed once set. 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.
messageOfTheDay String: Message of the day for Linux nodes, base64-encoded. A base64-encoded string which will be written to /etc/motd after decoding. This allows customization of the message of the day for Linux nodes. It must not be specified for Windows nodes. It must be a static string (i.e., will be printed raw and not be executed as a script).
minCount Integer: The minimum number of nodes for auto-scaling
mode String: The mode of an agent pool. 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
networkProfile AgentPoolNetworkProfileResponse: Network-related settings of an agent pool.
nodeLabels Map<String,String>: The node labels to be persisted across all nodes in agent pool.
nodePublicIPPrefixID String: The public IP prefix ID which VM nodes should use IPs from. 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: The version of Kubernetes specified by the user. 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 OS disk type to be used for machines in the agent pool. 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.
podIPAllocationMode String: Pod IP Allocation Mode. The IP allocation mode for pods in the agent pool. Must be used with podSubnetId. The default is 'DynamicIndividual'.
podSubnetID String: The ID of the subnet which pods will join when launched. 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: Whether the Agent Pool is running or stopped. 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: The scale down mode to use when scaling the Agent Pool. This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete.
scaleSetEvictionPolicy String: The Virtual Machine Scale Set eviction policy to use. 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'.
securityProfile AgentPoolSecurityProfileResponse: The security settings of an agent pool.
spotMaxPrice Double: The max price (in US Dollars) you are willing to pay for spot instances. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand. 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
status AgentPoolStatusResponse: Contains read-only information about the Agent Pool.
tags Map<String,String>: The tags to be persisted on the agent pool virtual machine scale set.
upgradeSettings AgentPoolUpgradeSettingsResponse: Settings for upgrading the agentpool
virtualMachineNodesStatus List<VirtualMachineNodesResponse>: The status of nodes in a VirtualMachines agent pool.
virtualMachinesProfile VirtualMachinesProfileResponse: Specifications on VirtualMachines agent pool.
vmSize String: The size of the agent pool VMs. 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: The ID of the subnet which agent pool nodes and optionally pods will join on startup. 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}
windowsProfile AgentPoolWindowsProfileResponse: The Windows agent pool's specific profile.
workloadRuntime String: Determines the type of workload a node can run.

azureApiVersion string: The Azure API version of the resource.
currentOrchestratorVersion string: The version of Kubernetes the Agent Pool is running. 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.
eTag string: Unique read-only string used to implement optimistic concurrency. The eTag value will change when the resource is updated. Specify an if-match or if-none-match header with the eTag value for a subsequent request to enable optimistic concurrency per the normal etag convention.
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'.
capacityReservationGroupID string: AKS will associate the specified agent pool with the Capacity Reservation Group.
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: Whether to enable host based OS and data drive encryption. 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: Whether to use a FIPS-enabled OS. See Add a FIPS-enabled node pool for more details.
enableNodePublicIP boolean: Whether each node is allocated its own public IP. 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
gatewayProfile AgentPoolGatewayProfileResponse: Profile specific to a managed agent pool in Gateway mode. This field cannot be set if agent pool mode is not Gateway.
gpuInstanceProfile string: GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU.
gpuProfile GPUProfileResponse: GPU settings for the Agent Pool.
hostGroupID string: The fully qualified resource ID of the Dedicated Host Group to provision virtual machines from, used only in creation scenario and not allowed to changed once set. 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.
messageOfTheDay string: Message of the day for Linux nodes, base64-encoded. A base64-encoded string which will be written to /etc/motd after decoding. This allows customization of the message of the day for Linux nodes. It must not be specified for Windows nodes. It must be a static string (i.e., will be printed raw and not be executed as a script).
minCount number: The minimum number of nodes for auto-scaling
mode string: The mode of an agent pool. 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
networkProfile AgentPoolNetworkProfileResponse: Network-related settings of an agent pool.
nodeLabels {[key: string]: string}: The node labels to be persisted across all nodes in agent pool.
nodePublicIPPrefixID string: The public IP prefix ID which VM nodes should use IPs from. 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: The version of Kubernetes specified by the user. 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 OS disk type to be used for machines in the agent pool. 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.
podIPAllocationMode string: Pod IP Allocation Mode. The IP allocation mode for pods in the agent pool. Must be used with podSubnetId. The default is 'DynamicIndividual'.
podSubnetID string: The ID of the subnet which pods will join when launched. 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: Whether the Agent Pool is running or stopped. 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: The scale down mode to use when scaling the Agent Pool. This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete.
scaleSetEvictionPolicy string: The Virtual Machine Scale Set eviction policy to use. 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'.
securityProfile AgentPoolSecurityProfileResponse: The security settings of an agent pool.
spotMaxPrice number: The max price (in US Dollars) you are willing to pay for spot instances. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand. 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
status AgentPoolStatusResponse: Contains read-only information about the Agent Pool.
tags {[key: string]: string}: The tags to be persisted on the agent pool virtual machine scale set.
upgradeSettings AgentPoolUpgradeSettingsResponse: Settings for upgrading the agentpool
virtualMachineNodesStatus VirtualMachineNodesResponse[]: The status of nodes in a VirtualMachines agent pool.
virtualMachinesProfile VirtualMachinesProfileResponse: Specifications on VirtualMachines agent pool.
vmSize string: The size of the agent pool VMs. 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: The ID of the subnet which agent pool nodes and optionally pods will join on startup. 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}
windowsProfile AgentPoolWindowsProfileResponse: The Windows agent pool's specific profile.
workloadRuntime string: Determines the type of workload a node can run.

azure_api_version str: The Azure API version of the resource.
current_orchestrator_version str: The version of Kubernetes the Agent Pool is running. 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.
e_tag str: Unique read-only string used to implement optimistic concurrency. The eTag value will change when the resource is updated. Specify an if-match or if-none-match header with the eTag value for a subsequent request to enable optimistic concurrency per the normal etag convention.
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'.
capacity_reservation_group_id str: AKS will associate the specified agent pool with the Capacity Reservation Group.
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: Whether to enable host based OS and data drive encryption. 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: Whether to use a FIPS-enabled OS. See Add a FIPS-enabled node pool for more details.
enable_node_public_ip bool: Whether each node is allocated its own public IP. 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
gateway_profile AgentPoolGatewayProfileResponse: Profile specific to a managed agent pool in Gateway mode. This field cannot be set if agent pool mode is not Gateway.
gpu_instance_profile str: GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU.
gpu_profile GPUProfileResponse: GPU settings for the Agent Pool.
host_group_id str: The fully qualified resource ID of the Dedicated Host Group to provision virtual machines from, used only in creation scenario and not allowed to changed once set. 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.
message_of_the_day str: Message of the day for Linux nodes, base64-encoded. A base64-encoded string which will be written to /etc/motd after decoding. This allows customization of the message of the day for Linux nodes. It must not be specified for Windows nodes. It must be a static string (i.e., will be printed raw and not be executed as a script).
min_count int: The minimum number of nodes for auto-scaling
mode str: The mode of an agent pool. 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
network_profile AgentPoolNetworkProfileResponse: Network-related settings of an agent pool.
node_labels Mapping[str, str]: The node labels to be persisted across all nodes in agent pool.
node_public_ip_prefix_id str: The public IP prefix ID which VM nodes should use IPs from. 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: The version of Kubernetes specified by the user. 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 OS disk type to be used for machines in the agent pool. 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_ip_allocation_mode str: Pod IP Allocation Mode. The IP allocation mode for pods in the agent pool. Must be used with podSubnetId. The default is 'DynamicIndividual'.
pod_subnet_id str: The ID of the subnet which pods will join when launched. 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: Whether the Agent Pool is running or stopped. 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: The scale down mode to use when scaling the Agent Pool. This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete.
scale_set_eviction_policy str: The Virtual Machine Scale Set eviction policy to use. 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'.
security_profile AgentPoolSecurityProfileResponse: The security settings of an agent pool.
spot_max_price float: The max price (in US Dollars) you are willing to pay for spot instances. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand. 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
status AgentPoolStatusResponse: Contains read-only information about the Agent Pool.
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
virtual_machine_nodes_status Sequence[VirtualMachineNodesResponse]: The status of nodes in a VirtualMachines agent pool.
virtual_machines_profile VirtualMachinesProfileResponse: Specifications on VirtualMachines agent pool.
vm_size str: The size of the agent pool VMs. 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: The ID of the subnet which agent pool nodes and optionally pods will join on startup. 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}
windows_profile AgentPoolWindowsProfileResponse: The Windows agent pool's specific profile.
workload_runtime str: Determines the type of workload a node can run.

azureApiVersion String: The Azure API version of the resource.
currentOrchestratorVersion String: The version of Kubernetes the Agent Pool is running. 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.
eTag String: Unique read-only string used to implement optimistic concurrency. The eTag value will change when the resource is updated. Specify an if-match or if-none-match header with the eTag value for a subsequent request to enable optimistic concurrency per the normal etag convention.
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'.
capacityReservationGroupID String: AKS will associate the specified agent pool with the Capacity Reservation Group.
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: Whether to enable host based OS and data drive encryption. 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: Whether to use a FIPS-enabled OS. See Add a FIPS-enabled node pool for more details.
enableNodePublicIP Boolean: Whether each node is allocated its own public IP. 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
gatewayProfile Property Map: Profile specific to a managed agent pool in Gateway mode. This field cannot be set if agent pool mode is not Gateway.
gpuInstanceProfile String: GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU.
gpuProfile Property Map: GPU settings for the Agent Pool.
hostGroupID String: The fully qualified resource ID of the Dedicated Host Group to provision virtual machines from, used only in creation scenario and not allowed to changed once set. 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.
messageOfTheDay String: Message of the day for Linux nodes, base64-encoded. A base64-encoded string which will be written to /etc/motd after decoding. This allows customization of the message of the day for Linux nodes. It must not be specified for Windows nodes. It must be a static string (i.e., will be printed raw and not be executed as a script).
minCount Number: The minimum number of nodes for auto-scaling
mode String: The mode of an agent pool. 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
networkProfile Property Map: Network-related settings of an agent pool.
nodeLabels Map<String>: The node labels to be persisted across all nodes in agent pool.
nodePublicIPPrefixID String: The public IP prefix ID which VM nodes should use IPs from. 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: The version of Kubernetes specified by the user. 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 OS disk type to be used for machines in the agent pool. 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.
podIPAllocationMode String: Pod IP Allocation Mode. The IP allocation mode for pods in the agent pool. Must be used with podSubnetId. The default is 'DynamicIndividual'.
podSubnetID String: The ID of the subnet which pods will join when launched. 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: Whether the Agent Pool is running or stopped. 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: The scale down mode to use when scaling the Agent Pool. This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete.
scaleSetEvictionPolicy String: The Virtual Machine Scale Set eviction policy to use. 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'.
securityProfile Property Map: The security settings of an agent pool.
spotMaxPrice Number: The max price (in US Dollars) you are willing to pay for spot instances. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand. 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
status Property Map: Contains read-only information about the Agent Pool.
tags Map<String>: The tags to be persisted on the agent pool virtual machine scale set.
upgradeSettings Property Map: Settings for upgrading the agentpool
virtualMachineNodesStatus List<Property Map>: The status of nodes in a VirtualMachines agent pool.
virtualMachinesProfile Property Map: Specifications on VirtualMachines agent pool.
vmSize String: The size of the agent pool VMs. 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: The ID of the subnet which agent pool nodes and optionally pods will join on startup. 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}
windowsProfile Property Map: The Windows agent pool's specific profile.
workloadRuntime String: Determines the type of workload a node can run.

Supporting Types

AgentPoolGatewayProfileResponse

PublicIPPrefixSize int: The Gateway agent pool associates one public IPPrefix for each static egress gateway to provide public egress. The size of Public IPPrefix should be selected by the user. Each node in the agent pool is assigned with one IP from the IPPrefix. The IPPrefix size thus serves as a cap on the size of the Gateway agent pool. Due to Azure public IPPrefix size limitation, the valid value range is [28, 31] (/31 = 2 nodes/IPs, /30 = 4 nodes/IPs, /29 = 8 nodes/IPs, /28 = 16 nodes/IPs). The default value is 31.

PublicIPPrefixSize int: The Gateway agent pool associates one public IPPrefix for each static egress gateway to provide public egress. The size of Public IPPrefix should be selected by the user. Each node in the agent pool is assigned with one IP from the IPPrefix. The IPPrefix size thus serves as a cap on the size of the Gateway agent pool. Due to Azure public IPPrefix size limitation, the valid value range is [28, 31] (/31 = 2 nodes/IPs, /30 = 4 nodes/IPs, /29 = 8 nodes/IPs, /28 = 16 nodes/IPs). The default value is 31.

publicIPPrefixSize Integer: The Gateway agent pool associates one public IPPrefix for each static egress gateway to provide public egress. The size of Public IPPrefix should be selected by the user. Each node in the agent pool is assigned with one IP from the IPPrefix. The IPPrefix size thus serves as a cap on the size of the Gateway agent pool. Due to Azure public IPPrefix size limitation, the valid value range is [28, 31] (/31 = 2 nodes/IPs, /30 = 4 nodes/IPs, /29 = 8 nodes/IPs, /28 = 16 nodes/IPs). The default value is 31.

publicIPPrefixSize number: The Gateway agent pool associates one public IPPrefix for each static egress gateway to provide public egress. The size of Public IPPrefix should be selected by the user. Each node in the agent pool is assigned with one IP from the IPPrefix. The IPPrefix size thus serves as a cap on the size of the Gateway agent pool. Due to Azure public IPPrefix size limitation, the valid value range is [28, 31] (/31 = 2 nodes/IPs, /30 = 4 nodes/IPs, /29 = 8 nodes/IPs, /28 = 16 nodes/IPs). The default value is 31.

public_ip_prefix_size int: The Gateway agent pool associates one public IPPrefix for each static egress gateway to provide public egress. The size of Public IPPrefix should be selected by the user. Each node in the agent pool is assigned with one IP from the IPPrefix. The IPPrefix size thus serves as a cap on the size of the Gateway agent pool. Due to Azure public IPPrefix size limitation, the valid value range is [28, 31] (/31 = 2 nodes/IPs, /30 = 4 nodes/IPs, /29 = 8 nodes/IPs, /28 = 16 nodes/IPs). The default value is 31.

publicIPPrefixSize Number: The Gateway agent pool associates one public IPPrefix for each static egress gateway to provide public egress. The size of Public IPPrefix should be selected by the user. Each node in the agent pool is assigned with one IP from the IPPrefix. The IPPrefix size thus serves as a cap on the size of the Gateway agent pool. Due to Azure public IPPrefix size limitation, the valid value range is [28, 31] (/31 = 2 nodes/IPs, /30 = 4 nodes/IPs, /29 = 8 nodes/IPs, /28 = 16 nodes/IPs). The default value is 31.

AgentPoolNetworkProfileResponse

AllowedHostPorts List<Pulumi.AzureNative.ContainerService.Inputs.PortRangeResponse>: The port ranges that are allowed to access. The specified ranges are allowed to overlap.
ApplicationSecurityGroups List<string>: The IDs of the application security groups which agent pool will associate when created.
NodePublicIPTags List<Pulumi.AzureNative.ContainerService.Inputs.IPTagResponse>: IPTags of instance-level public IPs.

AllowedHostPorts []PortRangeResponse: The port ranges that are allowed to access. The specified ranges are allowed to overlap.
ApplicationSecurityGroups []string: The IDs of the application security groups which agent pool will associate when created.
NodePublicIPTags []IPTagResponse: IPTags of instance-level public IPs.

allowedHostPorts List<PortRangeResponse>: The port ranges that are allowed to access. The specified ranges are allowed to overlap.
applicationSecurityGroups List<String>: The IDs of the application security groups which agent pool will associate when created.
nodePublicIPTags List<IPTagResponse>: IPTags of instance-level public IPs.

allowedHostPorts PortRangeResponse[]: The port ranges that are allowed to access. The specified ranges are allowed to overlap.
applicationSecurityGroups string[]: The IDs of the application security groups which agent pool will associate when created.
nodePublicIPTags IPTagResponse[]: IPTags of instance-level public IPs.

allowed_host_ports Sequence[PortRangeResponse]: The port ranges that are allowed to access. The specified ranges are allowed to overlap.
application_security_groups Sequence[str]: The IDs of the application security groups which agent pool will associate when created.
node_public_ip_tags Sequence[IPTagResponse]: IPTags of instance-level public IPs.

allowedHostPorts List<Property Map>: The port ranges that are allowed to access. The specified ranges are allowed to overlap.
applicationSecurityGroups List<String>: The IDs of the application security groups which agent pool will associate when created.
nodePublicIPTags List<Property Map>: IPTags of instance-level public IPs.

AgentPoolSecurityProfileResponse

EnableSecureBoot bool: Secure Boot is a feature of Trusted Launch which ensures that only signed operating systems and drivers can boot. For more details, see aka.ms/aks/trustedlaunch. If not specified, the default is false.
EnableVTPM bool: vTPM is a Trusted Launch feature for configuring a dedicated secure vault for keys and measurements held locally on the node. For more details, see aka.ms/aks/trustedlaunch. If not specified, the default is false.
SshAccess string: SSH access method of an agent pool.

EnableSecureBoot bool: Secure Boot is a feature of Trusted Launch which ensures that only signed operating systems and drivers can boot. For more details, see aka.ms/aks/trustedlaunch. If not specified, the default is false.
EnableVTPM bool: vTPM is a Trusted Launch feature for configuring a dedicated secure vault for keys and measurements held locally on the node. For more details, see aka.ms/aks/trustedlaunch. If not specified, the default is false.
SshAccess string: SSH access method of an agent pool.

enableSecureBoot Boolean: Secure Boot is a feature of Trusted Launch which ensures that only signed operating systems and drivers can boot. For more details, see aka.ms/aks/trustedlaunch. If not specified, the default is false.
enableVTPM Boolean: vTPM is a Trusted Launch feature for configuring a dedicated secure vault for keys and measurements held locally on the node. For more details, see aka.ms/aks/trustedlaunch. If not specified, the default is false.
sshAccess String: SSH access method of an agent pool.

enableSecureBoot boolean: Secure Boot is a feature of Trusted Launch which ensures that only signed operating systems and drivers can boot. For more details, see aka.ms/aks/trustedlaunch. If not specified, the default is false.
enableVTPM boolean: vTPM is a Trusted Launch feature for configuring a dedicated secure vault for keys and measurements held locally on the node. For more details, see aka.ms/aks/trustedlaunch. If not specified, the default is false.
sshAccess string: SSH access method of an agent pool.

enable_secure_boot bool: Secure Boot is a feature of Trusted Launch which ensures that only signed operating systems and drivers can boot. For more details, see aka.ms/aks/trustedlaunch. If not specified, the default is false.
enable_vtpm bool: vTPM is a Trusted Launch feature for configuring a dedicated secure vault for keys and measurements held locally on the node. For more details, see aka.ms/aks/trustedlaunch. If not specified, the default is false.
ssh_access str: SSH access method of an agent pool.

enableSecureBoot Boolean: Secure Boot is a feature of Trusted Launch which ensures that only signed operating systems and drivers can boot. For more details, see aka.ms/aks/trustedlaunch. If not specified, the default is false.
enableVTPM Boolean: vTPM is a Trusted Launch feature for configuring a dedicated secure vault for keys and measurements held locally on the node. For more details, see aka.ms/aks/trustedlaunch. If not specified, the default is false.
sshAccess String: SSH access method of an agent pool.

AgentPoolStatusResponse

ProvisioningError Pulumi.AzureNative.ContainerService.Inputs.ErrorDetailResponse: The error detail information of the agent pool. Preserves the detailed info of failure. If there was no error, this field is omitted.

ProvisioningError ErrorDetailResponse: The error detail information of the agent pool. Preserves the detailed info of failure. If there was no error, this field is omitted.

provisioningError ErrorDetailResponse: The error detail information of the agent pool. Preserves the detailed info of failure. If there was no error, this field is omitted.

provisioningError ErrorDetailResponse: The error detail information of the agent pool. Preserves the detailed info of failure. If there was no error, this field is omitted.

provisioning_error ErrorDetailResponse: The error detail information of the agent pool. Preserves the detailed info of failure. If there was no error, this field is omitted.

provisioningError Property Map: The error detail information of the agent pool. Preserves the detailed info of failure. If there was no error, this field is omitted.

AgentPoolUpgradeSettingsResponse

DrainTimeoutInMinutes int: The drain timeout for a node. The amount of time (in minutes) to wait on eviction of pods and graceful termination per node. This eviction wait time honors waiting on pod disruption budgets. If this time is exceeded, the upgrade fails. If not specified, the default is 30 minutes.
MaxSurge string: The maximum number or percentage of nodes that are surged during upgrade. 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 10%. For more information, including best practices, see: https://learn.microsoft.com/en-us/azure/aks/upgrade-cluster
MaxUnavailable string: The maximum number or percentage of nodes that can be simultaneously unavailable during upgrade. This can either be set to an integer (e.g. '1') or a percentage (e.g. '5%'). 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 0. For more information, including best practices, see: https://learn.microsoft.com/en-us/azure/aks/upgrade-cluster
NodeSoakDurationInMinutes int: The soak duration for a node. The amount of time (in minutes) to wait after draining a node and before reimaging it and moving on to next node. If not specified, the default is 0 minutes.
UndrainableNodeBehavior string: Defines the behavior for undrainable nodes during upgrade. The most common cause of undrainable nodes is Pod Disruption Budgets (PDBs), but other issues, such as pod termination grace period is exceeding the remaining per-node drain timeout or pod is still being in a running state, can also cause undrainable nodes.

DrainTimeoutInMinutes int: The drain timeout for a node. The amount of time (in minutes) to wait on eviction of pods and graceful termination per node. This eviction wait time honors waiting on pod disruption budgets. If this time is exceeded, the upgrade fails. If not specified, the default is 30 minutes.
MaxSurge string: The maximum number or percentage of nodes that are surged during upgrade. 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 10%. For more information, including best practices, see: https://learn.microsoft.com/en-us/azure/aks/upgrade-cluster
MaxUnavailable string: The maximum number or percentage of nodes that can be simultaneously unavailable during upgrade. This can either be set to an integer (e.g. '1') or a percentage (e.g. '5%'). 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 0. For more information, including best practices, see: https://learn.microsoft.com/en-us/azure/aks/upgrade-cluster
NodeSoakDurationInMinutes int: The soak duration for a node. The amount of time (in minutes) to wait after draining a node and before reimaging it and moving on to next node. If not specified, the default is 0 minutes.
UndrainableNodeBehavior string: Defines the behavior for undrainable nodes during upgrade. The most common cause of undrainable nodes is Pod Disruption Budgets (PDBs), but other issues, such as pod termination grace period is exceeding the remaining per-node drain timeout or pod is still being in a running state, can also cause undrainable nodes.

drainTimeoutInMinutes Integer: The drain timeout for a node. The amount of time (in minutes) to wait on eviction of pods and graceful termination per node. This eviction wait time honors waiting on pod disruption budgets. If this time is exceeded, the upgrade fails. If not specified, the default is 30 minutes.
maxSurge String: The maximum number or percentage of nodes that are surged during upgrade. 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 10%. For more information, including best practices, see: https://learn.microsoft.com/en-us/azure/aks/upgrade-cluster
maxUnavailable String: The maximum number or percentage of nodes that can be simultaneously unavailable during upgrade. This can either be set to an integer (e.g. '1') or a percentage (e.g. '5%'). 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 0. For more information, including best practices, see: https://learn.microsoft.com/en-us/azure/aks/upgrade-cluster
nodeSoakDurationInMinutes Integer: The soak duration for a node. The amount of time (in minutes) to wait after draining a node and before reimaging it and moving on to next node. If not specified, the default is 0 minutes.
undrainableNodeBehavior String: Defines the behavior for undrainable nodes during upgrade. The most common cause of undrainable nodes is Pod Disruption Budgets (PDBs), but other issues, such as pod termination grace period is exceeding the remaining per-node drain timeout or pod is still being in a running state, can also cause undrainable nodes.

drainTimeoutInMinutes number: The drain timeout for a node. The amount of time (in minutes) to wait on eviction of pods and graceful termination per node. This eviction wait time honors waiting on pod disruption budgets. If this time is exceeded, the upgrade fails. If not specified, the default is 30 minutes.
maxSurge string: The maximum number or percentage of nodes that are surged during upgrade. 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 10%. For more information, including best practices, see: https://learn.microsoft.com/en-us/azure/aks/upgrade-cluster
maxUnavailable string: The maximum number or percentage of nodes that can be simultaneously unavailable during upgrade. This can either be set to an integer (e.g. '1') or a percentage (e.g. '5%'). 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 0. For more information, including best practices, see: https://learn.microsoft.com/en-us/azure/aks/upgrade-cluster
nodeSoakDurationInMinutes number: The soak duration for a node. The amount of time (in minutes) to wait after draining a node and before reimaging it and moving on to next node. If not specified, the default is 0 minutes.
undrainableNodeBehavior string: Defines the behavior for undrainable nodes during upgrade. The most common cause of undrainable nodes is Pod Disruption Budgets (PDBs), but other issues, such as pod termination grace period is exceeding the remaining per-node drain timeout or pod is still being in a running state, can also cause undrainable nodes.

drain_timeout_in_minutes int: The drain timeout for a node. The amount of time (in minutes) to wait on eviction of pods and graceful termination per node. This eviction wait time honors waiting on pod disruption budgets. If this time is exceeded, the upgrade fails. If not specified, the default is 30 minutes.
max_surge str: The maximum number or percentage of nodes that are surged during upgrade. 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 10%. For more information, including best practices, see: https://learn.microsoft.com/en-us/azure/aks/upgrade-cluster
max_unavailable str: The maximum number or percentage of nodes that can be simultaneously unavailable during upgrade. This can either be set to an integer (e.g. '1') or a percentage (e.g. '5%'). 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 0. For more information, including best practices, see: https://learn.microsoft.com/en-us/azure/aks/upgrade-cluster
node_soak_duration_in_minutes int: The soak duration for a node. The amount of time (in minutes) to wait after draining a node and before reimaging it and moving on to next node. If not specified, the default is 0 minutes.
undrainable_node_behavior str: Defines the behavior for undrainable nodes during upgrade. The most common cause of undrainable nodes is Pod Disruption Budgets (PDBs), but other issues, such as pod termination grace period is exceeding the remaining per-node drain timeout or pod is still being in a running state, can also cause undrainable nodes.

drainTimeoutInMinutes Number: The drain timeout for a node. The amount of time (in minutes) to wait on eviction of pods and graceful termination per node. This eviction wait time honors waiting on pod disruption budgets. If this time is exceeded, the upgrade fails. If not specified, the default is 30 minutes.
maxSurge String: The maximum number or percentage of nodes that are surged during upgrade. 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 10%. For more information, including best practices, see: https://learn.microsoft.com/en-us/azure/aks/upgrade-cluster
maxUnavailable String: The maximum number or percentage of nodes that can be simultaneously unavailable during upgrade. This can either be set to an integer (e.g. '1') or a percentage (e.g. '5%'). 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 0. For more information, including best practices, see: https://learn.microsoft.com/en-us/azure/aks/upgrade-cluster
nodeSoakDurationInMinutes Number: The soak duration for a node. The amount of time (in minutes) to wait after draining a node and before reimaging it and moving on to next node. If not specified, the default is 0 minutes.
undrainableNodeBehavior String: Defines the behavior for undrainable nodes during upgrade. The most common cause of undrainable nodes is Pod Disruption Budgets (PDBs), but other issues, such as pod termination grace period is exceeding the remaining per-node drain timeout or pod is still being in a running state, can also cause undrainable nodes.

AgentPoolWindowsProfileResponse

DisableOutboundNat bool: Whether to disable OutboundNAT in windows nodes. The default value is false. Outbound NAT can only be disabled if the cluster outboundType is NAT Gateway and the Windows agent pool does not have node public IP enabled.

DisableOutboundNat bool: Whether to disable OutboundNAT in windows nodes. The default value is false. Outbound NAT can only be disabled if the cluster outboundType is NAT Gateway and the Windows agent pool does not have node public IP enabled.

disableOutboundNat Boolean: Whether to disable OutboundNAT in windows nodes. The default value is false. Outbound NAT can only be disabled if the cluster outboundType is NAT Gateway and the Windows agent pool does not have node public IP enabled.

disableOutboundNat boolean: Whether to disable OutboundNAT in windows nodes. The default value is false. Outbound NAT can only be disabled if the cluster outboundType is NAT Gateway and the Windows agent pool does not have node public IP enabled.

disable_outbound_nat bool: Whether to disable OutboundNAT in windows nodes. The default value is false. Outbound NAT can only be disabled if the cluster outboundType is NAT Gateway and the Windows agent pool does not have node public IP enabled.

disableOutboundNat Boolean: Whether to disable OutboundNAT in windows nodes. The default value is false. Outbound NAT can only be disabled if the cluster outboundType is NAT Gateway and the Windows agent pool does not have node public IP enabled.

CreationDataResponse

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.

ErrorAdditionalInfoResponse

Info object: The additional info.
Type string: The additional info type.

Info interface{}: The additional info.
Type string: The additional info type.

info Object: The additional info.
type String: The additional info type.

info any: The additional info.
type string: The additional info type.

info Any: The additional info.
type str: The additional info type.

info Any: The additional info.
type String: The additional info type.

ErrorDetailResponse

AdditionalInfo List<Pulumi.AzureNative.ContainerService.Inputs.ErrorAdditionalInfoResponse>: The error additional info.
Code string: The error code.
Details List<Pulumi.AzureNative.ContainerService.Inputs.ErrorDetailResponse>: The error details.
Message string: The error message.
Target string: The error target.

AdditionalInfo []ErrorAdditionalInfoResponse: The error additional info.
Code string: The error code.
Details []ErrorDetailResponse: The error details.
Message string: The error message.
Target string: The error target.

additionalInfo List<ErrorAdditionalInfoResponse>: The error additional info.
code String: The error code.
details List<ErrorDetailResponse>: The error details.
message String: The error message.
target String: The error target.

additionalInfo ErrorAdditionalInfoResponse[]: The error additional info.
code string: The error code.
details ErrorDetailResponse[]: The error details.
message string: The error message.
target string: The error target.

additional_info Sequence[ErrorAdditionalInfoResponse]: The error additional info.
code str: The error code.
details Sequence[ErrorDetailResponse]: The error details.
message str: The error message.
target str: The error target.

additionalInfo List<Property Map>: The error additional info.
code String: The error code.
details List<Property Map>: The error details.
message String: The error message.
target String: The error target.

GPUProfileResponse

Driver string: Whether to install GPU drivers. When it's not specified, default is Install.

Driver string: Whether to install GPU drivers. When it's not specified, default is Install.

driver String: Whether to install GPU drivers. When it's not specified, default is Install.

driver string: Whether to install GPU drivers. When it's not specified, default is Install.

driver str: Whether to install GPU drivers. When it's not specified, default is Install.

driver String: Whether to install GPU drivers. When it's not specified, default is Install.

IPTagResponse

IpTagType string: The IP tag type. Example: RoutingPreference.
Tag string: The value of the IP tag associated with the public IP. Example: Internet.

IpTagType string: The IP tag type. Example: RoutingPreference.
Tag string: The value of the IP tag associated with the public IP. Example: Internet.

ipTagType String: The IP tag type. Example: RoutingPreference.
tag String: The value of the IP tag associated with the public IP. Example: Internet.

ipTagType string: The IP tag type. Example: RoutingPreference.
tag string: The value of the IP tag associated with the public IP. Example: Internet.

ip_tag_type str: The IP tag type. Example: RoutingPreference.
tag str: The value of the IP tag associated with the public IP. Example: Internet.

ipTagType String: The IP tag type. Example: RoutingPreference.
tag String: The value of the IP tag associated with the public IP. Example: Internet.

KubeletConfigResponse

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: If CPU CFS quota enforcement is enabled for containers that specify CPU limits. The default is true.
CpuCfsQuotaPeriod string: The CPU CFS quota period value. 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 CPU Manager policy to use. 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: The percent of disk usage after which image garbage collection is always run. To disable image garbage collection, set to 100. The default is 85%
ImageGcLowThreshold int: The percent of disk usage before which image garbage collection is never run. This cannot be set higher than imageGcHighThreshold. The default is 80%
PodMaxPids int: The maximum number of processes per pod.
TopologyManagerPolicy string: The Topology Manager policy to use. 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: If CPU CFS quota enforcement is enabled for containers that specify CPU limits. The default is true.
CpuCfsQuotaPeriod string: The CPU CFS quota period value. 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 CPU Manager policy to use. 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: The percent of disk usage after which image garbage collection is always run. To disable image garbage collection, set to 100. The default is 85%
ImageGcLowThreshold int: The percent of disk usage before which image garbage collection is never run. This cannot be set higher than imageGcHighThreshold. The default is 80%
PodMaxPids int: The maximum number of processes per pod.
TopologyManagerPolicy string: The Topology Manager policy to use. 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: If CPU CFS quota enforcement is enabled for containers that specify CPU limits. The default is true.
cpuCfsQuotaPeriod String: The CPU CFS quota period value. 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 CPU Manager policy to use. 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: The percent of disk usage after which image garbage collection is always run. To disable image garbage collection, set to 100. The default is 85%
imageGcLowThreshold Integer: The percent of disk usage before which image garbage collection is never run. This cannot be set higher than imageGcHighThreshold. The default is 80%
podMaxPids Integer: The maximum number of processes per pod.
topologyManagerPolicy String: The Topology Manager policy to use. 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: If CPU CFS quota enforcement is enabled for containers that specify CPU limits. The default is true.
cpuCfsQuotaPeriod string: The CPU CFS quota period value. 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 CPU Manager policy to use. 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: The percent of disk usage after which image garbage collection is always run. To disable image garbage collection, set to 100. The default is 85%
imageGcLowThreshold number: The percent of disk usage before which image garbage collection is never run. This cannot be set higher than imageGcHighThreshold. The default is 80%
podMaxPids number: The maximum number of processes per pod.
topologyManagerPolicy string: The Topology Manager policy to use. 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: If CPU CFS quota enforcement is enabled for containers that specify CPU limits. The default is true.
cpu_cfs_quota_period str: The CPU CFS quota period value. 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 CPU Manager policy to use. 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: The percent of disk usage after which image garbage collection is always run. To disable image garbage collection, set to 100. The default is 85%
image_gc_low_threshold int: The percent of disk usage before which image garbage collection is never run. 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: The Topology Manager policy to use. 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: If CPU CFS quota enforcement is enabled for containers that specify CPU limits. The default is true.
cpuCfsQuotaPeriod String: The CPU CFS quota period value. 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 CPU Manager policy to use. 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: The percent of disk usage after which image garbage collection is always run. To disable image garbage collection, set to 100. The default is 85%
imageGcLowThreshold Number: The percent of disk usage before which image garbage collection is never run. This cannot be set higher than imageGcHighThreshold. The default is 80%
podMaxPids Number: The maximum number of processes per pod.
topologyManagerPolicy String: The Topology Manager policy to use. For more information see Kubernetes Topology Manager. The default is 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'.

LinuxOSConfigResponse

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: Whether the kernel should make aggressive use of memory compaction to make more hugepages available. Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see Transparent Hugepages.
TransparentHugePageEnabled string: Whether transparent hugepages are enabled. 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: Whether the kernel should make aggressive use of memory compaction to make more hugepages available. Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see Transparent Hugepages.
TransparentHugePageEnabled string: Whether transparent hugepages are enabled. 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: Whether the kernel should make aggressive use of memory compaction to make more hugepages available. Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see Transparent Hugepages.
transparentHugePageEnabled String: Whether transparent hugepages are enabled. 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: Whether the kernel should make aggressive use of memory compaction to make more hugepages available. Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see Transparent Hugepages.
transparentHugePageEnabled string: Whether transparent hugepages are enabled. 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: Whether the kernel should make aggressive use of memory compaction to make more hugepages available. 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: Whether transparent hugepages are enabled. 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: Whether the kernel should make aggressive use of memory compaction to make more hugepages available. Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see Transparent Hugepages.
transparentHugePageEnabled String: Whether transparent hugepages are enabled. Valid values are 'always', 'madvise', and 'never'. The default is 'always'. For more information see Transparent Hugepages.

ManualScaleProfileResponse

Count int: Number of nodes.
Size string: VM size that AKS will use when creating and scaling e.g. 'Standard_E4s_v3', 'Standard_E16s_v3' or 'Standard_D16s_v5'.

Count int: Number of nodes.
Size string: VM size that AKS will use when creating and scaling e.g. 'Standard_E4s_v3', 'Standard_E16s_v3' or 'Standard_D16s_v5'.

count Integer: Number of nodes.
size String: VM size that AKS will use when creating and scaling e.g. 'Standard_E4s_v3', 'Standard_E16s_v3' or 'Standard_D16s_v5'.

count number: Number of nodes.
size string: VM size that AKS will use when creating and scaling e.g. 'Standard_E4s_v3', 'Standard_E16s_v3' or 'Standard_D16s_v5'.

count int: Number of nodes.
size str: VM size that AKS will use when creating and scaling e.g. 'Standard_E4s_v3', 'Standard_E16s_v3' or 'Standard_D16s_v5'.

count Number: Number of nodes.
size String: VM size that AKS will use when creating and scaling e.g. 'Standard_E4s_v3', 'Standard_E16s_v3' or 'Standard_D16s_v5'.

PortRangeResponse

PortEnd int: The maximum port that is included in the range. It should be ranged from 1 to 65535, and be greater than or equal to portStart.
PortStart int: The minimum port that is included in the range. It should be ranged from 1 to 65535, and be less than or equal to portEnd.
Protocol string: The network protocol of the port.

PortEnd int: The maximum port that is included in the range. It should be ranged from 1 to 65535, and be greater than or equal to portStart.
PortStart int: The minimum port that is included in the range. It should be ranged from 1 to 65535, and be less than or equal to portEnd.
Protocol string: The network protocol of the port.

portEnd Integer: The maximum port that is included in the range. It should be ranged from 1 to 65535, and be greater than or equal to portStart.
portStart Integer: The minimum port that is included in the range. It should be ranged from 1 to 65535, and be less than or equal to portEnd.
protocol String: The network protocol of the port.

portEnd number: The maximum port that is included in the range. It should be ranged from 1 to 65535, and be greater than or equal to portStart.
portStart number: The minimum port that is included in the range. It should be ranged from 1 to 65535, and be less than or equal to portEnd.
protocol string: The network protocol of the port.

port_end int: The maximum port that is included in the range. It should be ranged from 1 to 65535, and be greater than or equal to portStart.
port_start int: The minimum port that is included in the range. It should be ranged from 1 to 65535, and be less than or equal to portEnd.
protocol str: The network protocol of the port.

portEnd Number: The maximum port that is included in the range. It should be ranged from 1 to 65535, and be greater than or equal to portStart.
portStart Number: The minimum port that is included in the range. It should be ranged from 1 to 65535, and be less than or equal to portEnd.
protocol String: The network protocol of the port.

PowerStateResponse

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

ScaleProfileResponse

Manual List<Pulumi.AzureNative.ContainerService.Inputs.ManualScaleProfileResponse>: Specifications on how to scale the VirtualMachines agent pool to a fixed size.

Manual []ManualScaleProfileResponse: Specifications on how to scale the VirtualMachines agent pool to a fixed size.

manual List<ManualScaleProfileResponse>: Specifications on how to scale the VirtualMachines agent pool to a fixed size.

manual ManualScaleProfileResponse[]: Specifications on how to scale the VirtualMachines agent pool to a fixed size.

manual Sequence[ManualScaleProfileResponse]: Specifications on how to scale the VirtualMachines agent pool to a fixed size.

manual List<Property Map>: Specifications on how to scale the VirtualMachines agent pool to a fixed size.

SysctlConfigResponse

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.

VirtualMachineNodesResponse

Count int: Number of nodes.
Size string: The VM size of the agents used to host this group of nodes.

Count int: Number of nodes.
Size string: The VM size of the agents used to host this group of nodes.

count Integer: Number of nodes.
size String: The VM size of the agents used to host this group of nodes.

count number: Number of nodes.
size string: The VM size of the agents used to host this group of nodes.

count int: Number of nodes.
size str: The VM size of the agents used to host this group of nodes.

count Number: Number of nodes.
size String: The VM size of the agents used to host this group of nodes.

VirtualMachinesProfileResponse

Scale Pulumi.AzureNative.ContainerService.Inputs.ScaleProfileResponse: Specifications on how to scale a VirtualMachines agent pool.

Scale ScaleProfileResponse: Specifications on how to scale a VirtualMachines agent pool.

scale ScaleProfileResponse: Specifications on how to scale a VirtualMachines agent pool.

scale ScaleProfileResponse: Specifications on how to scale a VirtualMachines agent pool.

scale ScaleProfileResponse: Specifications on how to scale a VirtualMachines agent pool.

scale Property Map: Specifications on how to scale a VirtualMachines agent pool.

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.

Azure Native v3.11.0 published on Friday, Dec 5, 2025 by Pulumi

Schema (JSON)

pulumi/pulumi-azure-native

azure-native.containerservice.getAgentPool

On this page

On this page

Using getAgentPool

getAgentPool Result

Supporting Types

AgentPoolGatewayProfileResponse

AgentPoolNetworkProfileResponse

AgentPoolSecurityProfileResponse

AgentPoolStatusResponse

AgentPoolUpgradeSettingsResponse

AgentPoolWindowsProfileResponse

CreationDataResponse

ErrorAdditionalInfoResponse

ErrorDetailResponse

GPUProfileResponse

IPTagResponse

KubeletConfigResponse

LinuxOSConfigResponse

ManualScaleProfileResponse

PortRangeResponse

PowerStateResponse

ScaleProfileResponse

SysctlConfigResponse

VirtualMachineNodesResponse

VirtualMachinesProfileResponse

Package Details

On this page

On this page