@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 17.3 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Agent Pool.
*
* Uses Azure REST API version 2025-08-01.
*
* 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](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getAgentPool(args: GetAgentPoolArgs, opts?: pulumi.InvokeOptions): Promise<GetAgentPoolResult>;
export interface GetAgentPoolArgs {
/**
* The name of the agent pool.
*/
agentPoolName: string;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: string;
/**
* The name of the managed cluster resource.
*/
resourceName: string;
}
/**
* Agent Pool.
*/
export interface GetAgentPoolResult {
/**
* The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'.
*/
readonly availabilityZones?: string[];
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: string;
/**
* AKS will associate the specified agent pool with the Capacity Reservation Group.
*/
readonly capacityReservationGroupID?: string;
/**
* 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.
*/
readonly count?: number;
/**
* CreationData to be used to specify the source Snapshot ID if the node pool will be created/upgraded using a snapshot.
*/
readonly creationData?: outputs.containerservice.CreationDataResponse;
/**
* 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.
*/
readonly currentOrchestratorVersion: 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.
*/
readonly eTag: string;
/**
* Whether to enable auto-scaler
*/
readonly enableAutoScaling?: 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
*/
readonly enableEncryptionAtHost?: boolean;
/**
* Whether to use a FIPS-enabled OS. See [Add a FIPS-enabled node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#add-a-fips-enabled-node-pool-preview) for more details.
*/
readonly enableFIPS?: 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](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#assign-a-public-ip-per-node-for-your-node-pools). The default is false.
*/
readonly enableNodePublicIP?: boolean;
/**
* Whether to enable UltraSSD
*/
readonly enableUltraSSD?: boolean;
/**
* Profile specific to a managed agent pool in Gateway mode. This field cannot be set if agent pool mode is not Gateway.
*/
readonly gatewayProfile?: outputs.containerservice.AgentPoolGatewayProfileResponse;
/**
* GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU.
*/
readonly gpuInstanceProfile?: string;
/**
* GPU settings for the Agent Pool.
*/
readonly gpuProfile?: outputs.containerservice.GPUProfileResponse;
/**
* 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](https://docs.microsoft.com/azure/virtual-machines/dedicated-hosts).
*/
readonly hostGroupID?: string;
/**
* Resource ID.
*/
readonly id: string;
/**
* The Kubelet configuration on the agent pool nodes.
*/
readonly kubeletConfig?: outputs.containerservice.KubeletConfigResponse;
/**
* Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage.
*/
readonly kubeletDiskType?: string;
/**
* The OS configuration of Linux agent nodes.
*/
readonly linuxOSConfig?: outputs.containerservice.LinuxOSConfigResponse;
/**
* The maximum number of nodes for auto-scaling
*/
readonly maxCount?: number;
/**
* The maximum number of pods that can run on a node.
*/
readonly maxPods?: number;
/**
* 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).
*/
readonly messageOfTheDay?: string;
/**
* The minimum number of nodes for auto-scaling
*/
readonly minCount?: number;
/**
* 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
*/
readonly mode?: string;
/**
* The name of the resource that is unique within a resource group. This name can be used to access the resource.
*/
readonly name: string;
/**
* Network-related settings of an agent pool.
*/
readonly networkProfile?: outputs.containerservice.AgentPoolNetworkProfileResponse;
/**
* The version of node image
*/
readonly nodeImageVersion: string;
/**
* The node labels to be persisted across all nodes in agent pool.
*/
readonly nodeLabels?: {
[key: string]: 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}
*/
readonly nodePublicIPPrefixID?: string;
/**
* The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule.
*/
readonly nodeTaints?: 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](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#upgrade-a-node-pool).
*/
readonly orchestratorVersion?: string;
/**
* 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.
*/
readonly osDiskSizeGB?: number;
/**
* 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](https://docs.microsoft.com/azure/aks/cluster-configuration#ephemeral-os).
*/
readonly osDiskType?: 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.
*/
readonly osSKU?: string;
/**
* The operating system type. The default is Linux.
*/
readonly osType?: string;
/**
* Pod IP Allocation Mode. The IP allocation mode for pods in the agent pool. Must be used with podSubnetId. The default is 'DynamicIndividual'.
*/
readonly podIPAllocationMode?: 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}
*/
readonly podSubnetID?: string;
/**
* 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
*/
readonly powerState?: outputs.containerservice.PowerStateResponse;
/**
* The current deployment or provisioning state.
*/
readonly provisioningState: string;
/**
* The ID for Proximity Placement Group.
*/
readonly proximityPlacementGroupID?: 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.
*/
readonly scaleDownMode?: 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'.
*/
readonly scaleSetEvictionPolicy?: string;
/**
* The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'.
*/
readonly scaleSetPriority?: string;
/**
* The security settings of an agent pool.
*/
readonly securityProfile?: outputs.containerservice.AgentPoolSecurityProfileResponse;
/**
* 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](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing)
*/
readonly spotMaxPrice?: number;
/**
* Contains read-only information about the Agent Pool.
*/
readonly status?: outputs.containerservice.AgentPoolStatusResponse;
/**
* The tags to be persisted on the agent pool virtual machine scale set.
*/
readonly tags?: {
[key: string]: string;
};
/**
* Resource type
*/
readonly type: string;
/**
* Settings for upgrading the agentpool
*/
readonly upgradeSettings?: outputs.containerservice.AgentPoolUpgradeSettingsResponse;
/**
* The status of nodes in a VirtualMachines agent pool.
*/
readonly virtualMachineNodesStatus?: outputs.containerservice.VirtualMachineNodesResponse[];
/**
* Specifications on VirtualMachines agent pool.
*/
readonly virtualMachinesProfile?: outputs.containerservice.VirtualMachinesProfileResponse;
/**
* 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
*/
readonly vmSize?: 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}
*/
readonly vnetSubnetID?: string;
/**
* The Windows agent pool's specific profile.
*/
readonly windowsProfile?: outputs.containerservice.AgentPoolWindowsProfileResponse;
/**
* Determines the type of workload a node can run.
*/
readonly workloadRuntime?: string;
}
/**
* Agent Pool.
*
* Uses Azure REST API version 2025-08-01.
*
* 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](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getAgentPoolOutput(args: GetAgentPoolOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetAgentPoolResult>;
export interface GetAgentPoolOutputArgs {
/**
* The name of the agent pool.
*/
agentPoolName: pulumi.Input<string>;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
/**
* The name of the managed cluster resource.
*/
resourceName: pulumi.Input<string>;
}