We recommend using Azure Native.
Azure v6.13.0 published on Monday, Dec 9, 2024 by Pulumi
azure.containerservice.getClusterNodePool
Explore with Pulumi AI
Use this data source to access information about an existing Kubernetes Cluster Node Pool.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const example = azure.containerservice.getClusterNodePool({
name: "existing",
kubernetesClusterName: "existing-cluster",
resourceGroupName: "existing-resource-group",
});
export const id = example.then(example => example.id);
import pulumi
import pulumi_azure as azure
example = azure.containerservice.get_cluster_node_pool(name="existing",
kubernetes_cluster_name="existing-cluster",
resource_group_name="existing-resource-group")
pulumi.export("id", example.id)
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/containerservice"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := containerservice.GetClusterNodePool(ctx, &containerservice.GetClusterNodePoolArgs{
Name: "existing",
KubernetesClusterName: "existing-cluster",
ResourceGroupName: "existing-resource-group",
}, nil)
if err != nil {
return err
}
ctx.Export("id", example.Id)
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var example = Azure.ContainerService.GetClusterNodePool.Invoke(new()
{
Name = "existing",
KubernetesClusterName = "existing-cluster",
ResourceGroupName = "existing-resource-group",
});
return new Dictionary<string, object?>
{
["id"] = example.Apply(getClusterNodePoolResult => getClusterNodePoolResult.Id),
};
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.containerservice.ContainerserviceFunctions;
import com.pulumi.azure.containerservice.inputs.GetClusterNodePoolArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var example = ContainerserviceFunctions.getClusterNodePool(GetClusterNodePoolArgs.builder()
.name("existing")
.kubernetesClusterName("existing-cluster")
.resourceGroupName("existing-resource-group")
.build());
ctx.export("id", example.applyValue(getClusterNodePoolResult -> getClusterNodePoolResult.id()));
}
}
variables:
example:
fn::invoke:
Function: azure:containerservice:getClusterNodePool
Arguments:
name: existing
kubernetesClusterName: existing-cluster
resourceGroupName: existing-resource-group
outputs:
id: ${example.id}
Using getClusterNodePool
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 getClusterNodePool(args: GetClusterNodePoolArgs, opts?: InvokeOptions): Promise<GetClusterNodePoolResult>
function getClusterNodePoolOutput(args: GetClusterNodePoolOutputArgs, opts?: InvokeOptions): Output<GetClusterNodePoolResult>
def get_cluster_node_pool(kubernetes_cluster_name: Optional[str] = None,
name: Optional[str] = None,
resource_group_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetClusterNodePoolResult
def get_cluster_node_pool_output(kubernetes_cluster_name: Optional[pulumi.Input[str]] = None,
name: Optional[pulumi.Input[str]] = None,
resource_group_name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetClusterNodePoolResult]
func GetClusterNodePool(ctx *Context, args *GetClusterNodePoolArgs, opts ...InvokeOption) (*GetClusterNodePoolResult, error)
func GetClusterNodePoolOutput(ctx *Context, args *GetClusterNodePoolOutputArgs, opts ...InvokeOption) GetClusterNodePoolResultOutput
> Note: This function is named GetClusterNodePool
in the Go SDK.
public static class GetClusterNodePool
{
public static Task<GetClusterNodePoolResult> InvokeAsync(GetClusterNodePoolArgs args, InvokeOptions? opts = null)
public static Output<GetClusterNodePoolResult> Invoke(GetClusterNodePoolInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetClusterNodePoolResult> getClusterNodePool(GetClusterNodePoolArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: azure:containerservice/getClusterNodePool:getClusterNodePool
arguments:
# arguments dictionary
The following arguments are supported:
- Kubernetes
Cluster stringName - The Name of the Kubernetes Cluster where this Node Pool is located.
- Name string
- The name of this Kubernetes Cluster Node Pool.
- Resource
Group stringName - The name of the Resource Group where the Kubernetes Cluster exists.
- Kubernetes
Cluster stringName - The Name of the Kubernetes Cluster where this Node Pool is located.
- Name string
- The name of this Kubernetes Cluster Node Pool.
- Resource
Group stringName - The name of the Resource Group where the Kubernetes Cluster exists.
- kubernetes
Cluster StringName - The Name of the Kubernetes Cluster where this Node Pool is located.
- name String
- The name of this Kubernetes Cluster Node Pool.
- resource
Group StringName - The name of the Resource Group where the Kubernetes Cluster exists.
- kubernetes
Cluster stringName - The Name of the Kubernetes Cluster where this Node Pool is located.
- name string
- The name of this Kubernetes Cluster Node Pool.
- resource
Group stringName - The name of the Resource Group where the Kubernetes Cluster exists.
- kubernetes_
cluster_ strname - The Name of the Kubernetes Cluster where this Node Pool is located.
- name str
- The name of this Kubernetes Cluster Node Pool.
- resource_
group_ strname - The name of the Resource Group where the Kubernetes Cluster exists.
- kubernetes
Cluster StringName - The Name of the Kubernetes Cluster where this Node Pool is located.
- name String
- The name of this Kubernetes Cluster Node Pool.
- resource
Group StringName - The name of the Resource Group where the Kubernetes Cluster exists.
getClusterNodePool Result
The following output properties are available:
- Auto
Scaling boolEnabled - Does this Node Pool have Auto-Scaling enabled?
- Eviction
Policy string - The eviction policy used for Virtual Machines in the Virtual Machine Scale Set, when
priority
is set toSpot
. - Id string
- The provider-assigned unique ID for this managed resource.
- Kubernetes
Cluster stringName - Max
Count int - The maximum number of Nodes allowed when auto-scaling is enabled.
- Max
Pods int - The maximum number of Pods allowed on each Node in this Node Pool.
- Min
Count int - The minimum number of Nodes allowed when auto-scaling is enabled.
- Mode string
- The Mode for this Node Pool, specifying how these Nodes should be used (for either System or User resources).
- Name string
- Node
Count int - The current number of Nodes in the Node Pool.
- Node
Labels Dictionary<string, string> - A map of Kubernetes Labels applied to each Node in this Node Pool.
- Node
Public boolIp Enabled - Do nodes in this Node Pool have a Public IP Address?
- Node
Public stringIp Prefix Id - Resource ID for the Public IP Addresses Prefix for the nodes in this Agent Pool.
- Node
Taints List<string> - A map of Kubernetes Taints applied to each Node in this Node Pool.
- Orchestrator
Version string - The version of Kubernetes configured on each Node in this Node Pool.
- Os
Disk intSize Gb - The size of the OS Disk on each Node in this Node Pool.
- Os
Disk stringType - The type of the OS Disk on each Node in this Node Pool.
- Os
Type string - The operating system used on each Node in this Node Pool.
- Priority string
- The priority of the Virtual Machines in the Virtual Machine Scale Set backing this Node Pool.
- Proximity
Placement stringGroup Id - The ID of the Proximity Placement Group where the Virtual Machine Scale Set backing this Node Pool will be placed.
- Resource
Group stringName - Spot
Max doublePrice - The maximum price being paid for Virtual Machines in this Scale Set.
-1
means the current on-demand price for a Virtual Machine. - Dictionary<string, string>
- A mapping of tags assigned to the Kubernetes Cluster Node Pool.
- Upgrade
Settings List<GetCluster Node Pool Upgrade Setting> - A
upgrade_settings
block as documented below. - Vm
Size string - The size of the Virtual Machines used in the Virtual Machine Scale Set backing this Node Pool.
- Vnet
Subnet stringId - The ID of the Subnet in which this Node Pool exists.
- Zones List<string>
- A list of the Availability Zones where the Nodes in this Node Pool exist.
- Auto
Scaling boolEnabled - Does this Node Pool have Auto-Scaling enabled?
- Eviction
Policy string - The eviction policy used for Virtual Machines in the Virtual Machine Scale Set, when
priority
is set toSpot
. - Id string
- The provider-assigned unique ID for this managed resource.
- Kubernetes
Cluster stringName - Max
Count int - The maximum number of Nodes allowed when auto-scaling is enabled.
- Max
Pods int - The maximum number of Pods allowed on each Node in this Node Pool.
- Min
Count int - The minimum number of Nodes allowed when auto-scaling is enabled.
- Mode string
- The Mode for this Node Pool, specifying how these Nodes should be used (for either System or User resources).
- Name string
- Node
Count int - The current number of Nodes in the Node Pool.
- Node
Labels map[string]string - A map of Kubernetes Labels applied to each Node in this Node Pool.
- Node
Public boolIp Enabled - Do nodes in this Node Pool have a Public IP Address?
- Node
Public stringIp Prefix Id - Resource ID for the Public IP Addresses Prefix for the nodes in this Agent Pool.
- Node
Taints []string - A map of Kubernetes Taints applied to each Node in this Node Pool.
- Orchestrator
Version string - The version of Kubernetes configured on each Node in this Node Pool.
- Os
Disk intSize Gb - The size of the OS Disk on each Node in this Node Pool.
- Os
Disk stringType - The type of the OS Disk on each Node in this Node Pool.
- Os
Type string - The operating system used on each Node in this Node Pool.
- Priority string
- The priority of the Virtual Machines in the Virtual Machine Scale Set backing this Node Pool.
- Proximity
Placement stringGroup Id - The ID of the Proximity Placement Group where the Virtual Machine Scale Set backing this Node Pool will be placed.
- Resource
Group stringName - Spot
Max float64Price - The maximum price being paid for Virtual Machines in this Scale Set.
-1
means the current on-demand price for a Virtual Machine. - map[string]string
- A mapping of tags assigned to the Kubernetes Cluster Node Pool.
- Upgrade
Settings []GetCluster Node Pool Upgrade Setting - A
upgrade_settings
block as documented below. - Vm
Size string - The size of the Virtual Machines used in the Virtual Machine Scale Set backing this Node Pool.
- Vnet
Subnet stringId - The ID of the Subnet in which this Node Pool exists.
- Zones []string
- A list of the Availability Zones where the Nodes in this Node Pool exist.
- auto
Scaling BooleanEnabled - Does this Node Pool have Auto-Scaling enabled?
- eviction
Policy String - The eviction policy used for Virtual Machines in the Virtual Machine Scale Set, when
priority
is set toSpot
. - id String
- The provider-assigned unique ID for this managed resource.
- kubernetes
Cluster StringName - max
Count Integer - The maximum number of Nodes allowed when auto-scaling is enabled.
- max
Pods Integer - The maximum number of Pods allowed on each Node in this Node Pool.
- min
Count Integer - The minimum number of Nodes allowed when auto-scaling is enabled.
- mode String
- The Mode for this Node Pool, specifying how these Nodes should be used (for either System or User resources).
- name String
- node
Count Integer - The current number of Nodes in the Node Pool.
- node
Labels Map<String,String> - A map of Kubernetes Labels applied to each Node in this Node Pool.
- node
Public BooleanIp Enabled - Do nodes in this Node Pool have a Public IP Address?
- node
Public StringIp Prefix Id - Resource ID for the Public IP Addresses Prefix for the nodes in this Agent Pool.
- node
Taints List<String> - A map of Kubernetes Taints applied to each Node in this Node Pool.
- orchestrator
Version String - The version of Kubernetes configured on each Node in this Node Pool.
- os
Disk IntegerSize Gb - The size of the OS Disk on each Node in this Node Pool.
- os
Disk StringType - The type of the OS Disk on each Node in this Node Pool.
- os
Type String - The operating system used on each Node in this Node Pool.
- priority String
- The priority of the Virtual Machines in the Virtual Machine Scale Set backing this Node Pool.
- proximity
Placement StringGroup Id - The ID of the Proximity Placement Group where the Virtual Machine Scale Set backing this Node Pool will be placed.
- resource
Group StringName - spot
Max DoublePrice - The maximum price being paid for Virtual Machines in this Scale Set.
-1
means the current on-demand price for a Virtual Machine. - Map<String,String>
- A mapping of tags assigned to the Kubernetes Cluster Node Pool.
- upgrade
Settings List<GetCluster Node Pool Upgrade Setting> - A
upgrade_settings
block as documented below. - vm
Size String - The size of the Virtual Machines used in the Virtual Machine Scale Set backing this Node Pool.
- vnet
Subnet StringId - The ID of the Subnet in which this Node Pool exists.
- zones List<String>
- A list of the Availability Zones where the Nodes in this Node Pool exist.
- auto
Scaling booleanEnabled - Does this Node Pool have Auto-Scaling enabled?
- eviction
Policy string - The eviction policy used for Virtual Machines in the Virtual Machine Scale Set, when
priority
is set toSpot
. - id string
- The provider-assigned unique ID for this managed resource.
- kubernetes
Cluster stringName - max
Count number - The maximum number of Nodes allowed when auto-scaling is enabled.
- max
Pods number - The maximum number of Pods allowed on each Node in this Node Pool.
- min
Count number - The minimum number of Nodes allowed when auto-scaling is enabled.
- mode string
- The Mode for this Node Pool, specifying how these Nodes should be used (for either System or User resources).
- name string
- node
Count number - The current number of Nodes in the Node Pool.
- node
Labels {[key: string]: string} - A map of Kubernetes Labels applied to each Node in this Node Pool.
- node
Public booleanIp Enabled - Do nodes in this Node Pool have a Public IP Address?
- node
Public stringIp Prefix Id - Resource ID for the Public IP Addresses Prefix for the nodes in this Agent Pool.
- node
Taints string[] - A map of Kubernetes Taints applied to each Node in this Node Pool.
- orchestrator
Version string - The version of Kubernetes configured on each Node in this Node Pool.
- os
Disk numberSize Gb - The size of the OS Disk on each Node in this Node Pool.
- os
Disk stringType - The type of the OS Disk on each Node in this Node Pool.
- os
Type string - The operating system used on each Node in this Node Pool.
- priority string
- The priority of the Virtual Machines in the Virtual Machine Scale Set backing this Node Pool.
- proximity
Placement stringGroup Id - The ID of the Proximity Placement Group where the Virtual Machine Scale Set backing this Node Pool will be placed.
- resource
Group stringName - spot
Max numberPrice - The maximum price being paid for Virtual Machines in this Scale Set.
-1
means the current on-demand price for a Virtual Machine. - {[key: string]: string}
- A mapping of tags assigned to the Kubernetes Cluster Node Pool.
- upgrade
Settings GetCluster Node Pool Upgrade Setting[] - A
upgrade_settings
block as documented below. - vm
Size string - The size of the Virtual Machines used in the Virtual Machine Scale Set backing this Node Pool.
- vnet
Subnet stringId - The ID of the Subnet in which this Node Pool exists.
- zones string[]
- A list of the Availability Zones where the Nodes in this Node Pool exist.
- auto_
scaling_ boolenabled - Does this Node Pool have Auto-Scaling enabled?
- eviction_
policy str - The eviction policy used for Virtual Machines in the Virtual Machine Scale Set, when
priority
is set toSpot
. - id str
- The provider-assigned unique ID for this managed resource.
- kubernetes_
cluster_ strname - max_
count int - The maximum number of Nodes allowed when auto-scaling is enabled.
- max_
pods int - The maximum number of Pods allowed on each Node in this Node Pool.
- min_
count int - The minimum number of Nodes allowed when auto-scaling is enabled.
- mode str
- The Mode for this Node Pool, specifying how these Nodes should be used (for either System or User resources).
- name str
- node_
count int - The current number of Nodes in the Node Pool.
- node_
labels Mapping[str, str] - A map of Kubernetes Labels applied to each Node in this Node Pool.
- node_
public_ boolip_ enabled - Do nodes in this Node Pool have a Public IP Address?
- node_
public_ strip_ prefix_ id - Resource ID for the Public IP Addresses Prefix for the nodes in this Agent Pool.
- node_
taints Sequence[str] - A map of Kubernetes Taints applied to each Node in this Node Pool.
- orchestrator_
version str - The version of Kubernetes configured on each Node in this Node Pool.
- os_
disk_ intsize_ gb - The size of the OS Disk on each Node in this Node Pool.
- os_
disk_ strtype - The type of the OS Disk on each Node in this Node Pool.
- os_
type str - The operating system used on each Node in this Node Pool.
- priority str
- The priority of the Virtual Machines in the Virtual Machine Scale Set backing this Node Pool.
- proximity_
placement_ strgroup_ id - The ID of the Proximity Placement Group where the Virtual Machine Scale Set backing this Node Pool will be placed.
- resource_
group_ strname - spot_
max_ floatprice - The maximum price being paid for Virtual Machines in this Scale Set.
-1
means the current on-demand price for a Virtual Machine. - Mapping[str, str]
- A mapping of tags assigned to the Kubernetes Cluster Node Pool.
- upgrade_
settings Sequence[GetCluster Node Pool Upgrade Setting] - A
upgrade_settings
block as documented below. - vm_
size str - The size of the Virtual Machines used in the Virtual Machine Scale Set backing this Node Pool.
- vnet_
subnet_ strid - The ID of the Subnet in which this Node Pool exists.
- zones Sequence[str]
- A list of the Availability Zones where the Nodes in this Node Pool exist.
- auto
Scaling BooleanEnabled - Does this Node Pool have Auto-Scaling enabled?
- eviction
Policy String - The eviction policy used for Virtual Machines in the Virtual Machine Scale Set, when
priority
is set toSpot
. - id String
- The provider-assigned unique ID for this managed resource.
- kubernetes
Cluster StringName - max
Count Number - The maximum number of Nodes allowed when auto-scaling is enabled.
- max
Pods Number - The maximum number of Pods allowed on each Node in this Node Pool.
- min
Count Number - The minimum number of Nodes allowed when auto-scaling is enabled.
- mode String
- The Mode for this Node Pool, specifying how these Nodes should be used (for either System or User resources).
- name String
- node
Count Number - The current number of Nodes in the Node Pool.
- node
Labels Map<String> - A map of Kubernetes Labels applied to each Node in this Node Pool.
- node
Public BooleanIp Enabled - Do nodes in this Node Pool have a Public IP Address?
- node
Public StringIp Prefix Id - Resource ID for the Public IP Addresses Prefix for the nodes in this Agent Pool.
- node
Taints List<String> - A map of Kubernetes Taints applied to each Node in this Node Pool.
- orchestrator
Version String - The version of Kubernetes configured on each Node in this Node Pool.
- os
Disk NumberSize Gb - The size of the OS Disk on each Node in this Node Pool.
- os
Disk StringType - The type of the OS Disk on each Node in this Node Pool.
- os
Type String - The operating system used on each Node in this Node Pool.
- priority String
- The priority of the Virtual Machines in the Virtual Machine Scale Set backing this Node Pool.
- proximity
Placement StringGroup Id - The ID of the Proximity Placement Group where the Virtual Machine Scale Set backing this Node Pool will be placed.
- resource
Group StringName - spot
Max NumberPrice - The maximum price being paid for Virtual Machines in this Scale Set.
-1
means the current on-demand price for a Virtual Machine. - Map<String>
- A mapping of tags assigned to the Kubernetes Cluster Node Pool.
- upgrade
Settings List<Property Map> - A
upgrade_settings
block as documented below. - vm
Size String - The size of the Virtual Machines used in the Virtual Machine Scale Set backing this Node Pool.
- vnet
Subnet StringId - The ID of the Subnet in which this Node Pool exists.
- zones List<String>
- A list of the Availability Zones where the Nodes in this Node Pool exist.
Supporting Types
GetClusterNodePoolUpgradeSetting
- Drain
Timeout intIn Minutes - 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.
- Max
Surge string - The maximum number or percentage of nodes which will be added to the Node Pool size during an upgrade.
- Node
Soak intDuration In Minutes - The amount of time in minutes to wait after draining a node and before reimaging it and moving on to next node.
- Drain
Timeout intIn Minutes - 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.
- Max
Surge string - The maximum number or percentage of nodes which will be added to the Node Pool size during an upgrade.
- Node
Soak intDuration In Minutes - The amount of time in minutes to wait after draining a node and before reimaging it and moving on to next node.
- drain
Timeout IntegerIn Minutes - 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.
- max
Surge String - The maximum number or percentage of nodes which will be added to the Node Pool size during an upgrade.
- node
Soak IntegerDuration In Minutes - The amount of time in minutes to wait after draining a node and before reimaging it and moving on to next node.
- drain
Timeout numberIn Minutes - 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.
- max
Surge string - The maximum number or percentage of nodes which will be added to the Node Pool size during an upgrade.
- node
Soak numberDuration In Minutes - The amount of time in minutes to wait after draining a node and before reimaging it and moving on to next node.
- drain_
timeout_ intin_ minutes - 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.
- max_
surge str - The maximum number or percentage of nodes which will be added to the Node Pool size during an upgrade.
- node_
soak_ intduration_ in_ minutes - The amount of time in minutes to wait after draining a node and before reimaging it and moving on to next node.
- drain
Timeout NumberIn Minutes - 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.
- max
Surge String - The maximum number or percentage of nodes which will be added to the Node Pool size during an upgrade.
- node
Soak NumberDuration In Minutes - The amount of time in minutes to wait after draining a node and before reimaging it and moving on to next node.
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
azurerm
Terraform Provider.