Class KubernetesClusterNodePool

Manages a Node Pool within a Kubernetes Cluster

NOTE: Multiple Node Pools are only supported when the Kubernetes Cluster is using Virtual Machine Scale Sets.

Inheritance

System.Object

Resource

CustomResource

KubernetesClusterNodePool

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Azure.ContainerService

Assembly: Pulumi.Azure.dll

Syntax

public class KubernetesClusterNodePool : CustomResource

Constructors

KubernetesClusterNodePool(String, KubernetesClusterNodePoolArgs, CustomResourceOptions)

Create a KubernetesClusterNodePool resource with the given unique name, arguments, and options.

Declaration

public KubernetesClusterNodePool(string name, KubernetesClusterNodePoolArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
KubernetesClusterNodePoolArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

AvailabilityZones

A list of Availability Zones where the Nodes in this Node Pool should be created in.

Declaration

public Output<ImmutableArray<string>> AvailabilityZones { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

EnableAutoScaling

Whether to enable auto-scaler. Defaults to false.

Declaration

public Output<bool?> EnableAutoScaling { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

EnableNodePublicIp

Should each node have a Public IP Address? Defaults to false.

Declaration

public Output<bool?> EnableNodePublicIp { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

KubernetesClusterId

The ID of the Kubernetes Cluster where this Node Pool should exist. Changing this forces a new resource to be created.

Declaration

public Output<string> KubernetesClusterId { get; }

Property Value

Type	Description
Output<System.String>

MaxCount

The maximum number of nodes which should exist within this Node Pool. Valid values are between 1 and 100 and must be greater than or equal to min_count.

Declaration

public Output<int?> MaxCount { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

MaxPods

The maximum number of pods that can run on each agent. Changing this forces a new resource to be created.

Declaration

public Output<int> MaxPods { get; }

Property Value

Type	Description
Output<System.Int32>

MinCount

The minimum number of nodes which should exist within this Node Pool. Valid values are between 1 and 100 and must be less than or equal to max_count.

Declaration

public Output<int?> MinCount { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

Name

The name of the Node Pool which should be created within the Kubernetes Cluster. Changing this forces a new resource to be created.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

NodeCount

The initial number of nodes which should exist within this Node Pool. Valid values are between 1 and 100 and must be a value in the range min_count - max_count.

Declaration

public Output<int> NodeCount { get; }

Property Value

Type	Description
Output<System.Int32>

NodeLabels

A map of Kubernetes labels which should be applied to nodes in this Node Pool.

Declaration

public Output<ImmutableDictionary<string, string>> NodeLabels { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.String>>

NodeTaints

A list of Kubernetes taints which should be applied to nodes in the agent pool (e.g key=value:NoSchedule).

Declaration

public Output<ImmutableArray<string>> NodeTaints { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

OsDiskSizeGb

The Agent Operating System disk size in GB. Changing this forces a new resource to be created.

Declaration

public Output<int> OsDiskSizeGb { get; }

Property Value

Type	Description
Output<System.Int32>

OsType

The Operating System which should be used for this Node Pool. Changing this forces a new resource to be created. Possible values are Linux and Windows. Defaults to Linux.

Declaration

public Output<string> OsType { get; }

Property Value

Type	Description
Output<System.String>

Tags

A mapping of tags to assign to the resource.

Declaration

public Output<ImmutableDictionary<string, string>> Tags { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.String>>

VmSize

The SKU which should be used for the Virtual Machines used in this Node Pool. Changing this forces a new resource to be created.

Declaration

public Output<string> VmSize { get; }

Property Value

Type	Description
Output<System.String>

VnetSubnetId

The ID of the Subnet where this Node Pool should exist.

Declaration

public Output<string> VnetSubnetId { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, KubernetesClusterNodePoolState, CustomResourceOptions)

Get an existing KubernetesClusterNodePool resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static KubernetesClusterNodePool Get(string name, Input<string> id, KubernetesClusterNodePoolState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
KubernetesClusterNodePoolState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
KubernetesClusterNodePool