GetClusterNodePool

Use this data source to access information about an existing Kubernetes Cluster Node Pool.

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var example = Output.Create(Azure.ContainerService.GetClusterNodePool.InvokeAsync(new Azure.ContainerService.GetClusterNodePoolArgs
        {
            Name = "existing",
            KubernetesClusterName = "existing-cluster",
            ResourceGroupName = "existing-resource-group",
        }));
        this.Id = example.Apply(example => example.Id);
    }

    [Output("id")]
    public Output<string> Id { get; set; }
}

package main

import (
    "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/containerservice"
    "github.com/pulumi/pulumi/sdk/v2/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
    })
}

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)

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);

Using GetClusterNodePool

function getClusterNodePool(args: GetClusterNodePoolArgs, opts?: InvokeOptions): Promise<GetClusterNodePoolResult>

function  get_cluster_node_pool(kubernetes_cluster_name=None, name=None, resource_group_name=None, opts=None)

func GetClusterNodePool(ctx *Context, args *GetClusterNodePoolArgs, opts ...InvokeOption) (*GetClusterNodePoolResult, error)

public static class GetClusterNodePool {
    public static Task<GetClusterNodePoolResult> InvokeAsync(GetClusterNodePoolArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

KubernetesClusterName string: The Name of the Kubernetes Cluster where this Node Pool is located.
Name string: The name of this Kubernetes Cluster Node Pool.
ResourceGroupName string: The name of the Resource Group where the Kubernetes Cluster exists.

KubernetesClusterName string: The Name of the Kubernetes Cluster where this Node Pool is located.
Name string: The name of this Kubernetes Cluster Node Pool.
ResourceGroupName string: The name of the Resource Group where the Kubernetes Cluster exists.

kubernetesClusterName string: The Name of the Kubernetes Cluster where this Node Pool is located.
name string: The name of this Kubernetes Cluster Node Pool.
resourceGroupName string: The name of the Resource Group where the Kubernetes Cluster exists.

kubernetes_cluster_name str: The Name of the Kubernetes Cluster where this Node Pool is located.
name str: The name of this Kubernetes Cluster Node Pool.
resource_group_name str: The name of the Resource Group where the Kubernetes Cluster exists.

GetClusterNodePool Result

The following output properties are available:

AvailabilityZones List<string>: A list of Availability Zones in which the Nodes in this Node Pool exists.
EnableAutoScaling bool: Does this Node Pool have Auto-Scaling enabled?
EnableNodePublicIp bool: Do nodes in this Node Pool have a Public IP Address?
EvictionPolicy string: The eviction policy used for Virtual Machines in the Virtual Machine Scale Set, when priority is set to Spot.
Id string: The provider-assigned unique ID for this managed resource.
KubernetesClusterName string
MaxCount int: The maximum number of Nodes allowed when auto-scaling is enabled.
MaxPods int: The maximum number of Pods allowed on each Node in this Node Pool.
MinCount 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
NodeCount int: The current number of Nodes in the Node Pool.
NodeLabels Dictionary<string, string>: A map of Kubernetes Labels applied to each Node in this Node Pool.
NodeTaints List<string>: A map of Kubernetes Taints applied to each Node in this Node Pool.
OrchestratorVersion string: The version of Kubernetes configured on each Node in this Node Pool.
OsDiskSizeGb int: The size of the OS Disk on each Node in this Node Pool.
OsType 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.
ResourceGroupName string
SpotMaxPrice double: The maximum price being paid for Virtual Machines in this Scale Set. -1 means the current on-demand price for a Virtual Machine.
Tags Dictionary<string, string>: A mapping of tags assigned to the Kubernetes Cluster Node Pool.
VmSize string: The size of the Virtual Machines used in the Virtual Machine Scale Set backing this Node Pool.
VnetSubnetId string: The ID of the Subnet in which this Node Pool exists.

AvailabilityZones []string: A list of Availability Zones in which the Nodes in this Node Pool exists.
EnableAutoScaling bool: Does this Node Pool have Auto-Scaling enabled?
EnableNodePublicIp bool: Do nodes in this Node Pool have a Public IP Address?
EvictionPolicy string: The eviction policy used for Virtual Machines in the Virtual Machine Scale Set, when priority is set to Spot.
Id string: The provider-assigned unique ID for this managed resource.
KubernetesClusterName string
MaxCount int: The maximum number of Nodes allowed when auto-scaling is enabled.
MaxPods int: The maximum number of Pods allowed on each Node in this Node Pool.
MinCount 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
NodeCount int: The current number of Nodes in the Node Pool.
NodeLabels map[string]string: A map of Kubernetes Labels applied to each Node in this Node Pool.
NodeTaints []string: A map of Kubernetes Taints applied to each Node in this Node Pool.
OrchestratorVersion string: The version of Kubernetes configured on each Node in this Node Pool.
OsDiskSizeGb int: The size of the OS Disk on each Node in this Node Pool.
OsType 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.
ResourceGroupName string
SpotMaxPrice float64: The maximum price being paid for Virtual Machines in this Scale Set. -1 means the current on-demand price for a Virtual Machine.
Tags map[string]string: A mapping of tags assigned to the Kubernetes Cluster Node Pool.
VmSize string: The size of the Virtual Machines used in the Virtual Machine Scale Set backing this Node Pool.
VnetSubnetId string: The ID of the Subnet in which this Node Pool exists.

availabilityZones string[]: A list of Availability Zones in which the Nodes in this Node Pool exists.
enableAutoScaling boolean: Does this Node Pool have Auto-Scaling enabled?
enableNodePublicIp boolean: Do nodes in this Node Pool have a Public IP Address?
evictionPolicy string: The eviction policy used for Virtual Machines in the Virtual Machine Scale Set, when priority is set to Spot.
id string: The provider-assigned unique ID for this managed resource.
kubernetesClusterName string
maxCount number: The maximum number of Nodes allowed when auto-scaling is enabled.
maxPods number: The maximum number of Pods allowed on each Node in this Node Pool.
minCount 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
nodeCount number: The current number of Nodes in the Node Pool.
nodeLabels {[key: string]: string}: A map of Kubernetes Labels applied to each Node in this Node Pool.
nodeTaints string[]: A map of Kubernetes Taints applied to each Node in this Node Pool.
orchestratorVersion string: The version of Kubernetes configured on each Node in this Node Pool.
osDiskSizeGb number: The size of the OS Disk on each Node in this Node Pool.
osType 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.
resourceGroupName string
spotMaxPrice number: The maximum price being paid for Virtual Machines in this Scale Set. -1 means the current on-demand price for a Virtual Machine.
tags {[key: string]: string}: A mapping of tags assigned to the Kubernetes Cluster Node Pool.
vmSize string: The size of the Virtual Machines used in the Virtual Machine Scale Set backing this Node Pool.
vnetSubnetId string: The ID of the Subnet in which this Node Pool exists.

availability_zones List[str]: A list of Availability Zones in which the Nodes in this Node Pool exists.
enable_auto_scaling bool: Does this Node Pool have Auto-Scaling enabled?
enable_node_public_ip bool: Do nodes in this Node Pool have a Public IP Address?
eviction_policy str: The eviction policy used for Virtual Machines in the Virtual Machine Scale Set, when priority is set to Spot.
id str: The provider-assigned unique ID for this managed resource.
kubernetes_cluster_name str
max_count float: The maximum number of Nodes allowed when auto-scaling is enabled.
max_pods float: The maximum number of Pods allowed on each Node in this Node Pool.
min_count float: 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 float: The current number of Nodes in the Node Pool.
node_labels Dict[str, str]: A map of Kubernetes Labels applied to each Node in this Node Pool.
node_taints List[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_size_gb float: The size 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.
resource_group_name str
spot_max_price float: The maximum price being paid for Virtual Machines in this Scale Set. -1 means the current on-demand price for a Virtual Machine.
tags Dict[str, str]: A mapping of tags assigned to the Kubernetes Cluster Node Pool.
vm_size str: The size of the Virtual Machines used in the Virtual Machine Scale Set backing this Node Pool.
vnet_subnet_id str: The ID of the Subnet in which this Node Pool exists.

Package Details

Repository: https://github.com/pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

GetClusterNodePool

Example Usage

Using GetClusterNodePool

GetClusterNodePool Result

Package Details

On This Page