KubernetesClusterNodePool

Create a KubernetesClusterNodePool Resource

def KubernetesClusterNodePool(resource_name, opts=None, availability_zones=None, enable_auto_scaling=None, enable_node_public_ip=None, eviction_policy=None, kubernetes_cluster_id=None, max_count=None, max_pods=None, min_count=None, mode=None, name=None, node_count=None, node_labels=None, node_taints=None, orchestrator_version=None, os_disk_size_gb=None, os_type=None, priority=None, spot_max_price=None, tags=None, vm_size=None, vnet_subnet_id=None, __props__=None);
name string
The unique name of the resource.
args KubernetesClusterNodePoolArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args KubernetesClusterNodePoolArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args KubernetesClusterNodePoolArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

KubernetesClusterNodePool Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The KubernetesClusterNodePool resource accepts the following input properties:

KubernetesClusterId string

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

VmSize string

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

AvailabilityZones List<string>

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

EnableAutoScaling bool

Whether to enable auto-scaler. Defaults to false.

EnableNodePublicIp bool

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

EvictionPolicy string

The Eviction Policy which should be used for Virtual Machines within the Virtual Machine Scale Set powering this Node Pool. Possible values are Deallocate and Delete. Changing this forces a new resource to be created.

MaxCount int

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.

MaxPods int

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

MinCount int

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.

Mode string

Should this Node Pool be used for System or User resources? Possible values are System and User. Defaults to User.

Name string

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

NodeCount int

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.

NodeLabels Dictionary<string, string>

A map of Kubernetes labels which should be applied to nodes in this Node Pool. Changing this forces a new resource to be created.

NodeTaints List<string>

A list of Kubernetes taints which should be applied to nodes in the agent pool (e.g key=value:NoSchedule). Changing this forces a new resource to be created.

OrchestratorVersion string

Version of Kubernetes used for the Agents. If not specified, the latest recommended version will be used at provisioning time (but won’t auto-upgrade)

OsDiskSizeGb int

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

OsType string

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.

Priority string

The Priority for Virtual Machines within the Virtual Machine Scale Set that powers this Node Pool. Possible values are Regular and Spot. Defaults to Regular. Changing this forces a new resource to be created.

SpotMaxPrice double

The maximum price you’re willing to pay in USD per Virtual Machine. Valid values are -1 (the current on-demand price for a Virtual Machine) or a positive value with up to five decimal places. Changing this forces a new resource to be created.

Tags Dictionary<string, string>

A mapping of tags to assign to the resource.

VnetSubnetId string

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

KubernetesClusterId string

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

VmSize string

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

AvailabilityZones []string

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

EnableAutoScaling bool

Whether to enable auto-scaler. Defaults to false.

EnableNodePublicIp bool

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

EvictionPolicy string

The Eviction Policy which should be used for Virtual Machines within the Virtual Machine Scale Set powering this Node Pool. Possible values are Deallocate and Delete. Changing this forces a new resource to be created.

MaxCount int

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.

MaxPods int

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

MinCount int

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.

Mode string

Should this Node Pool be used for System or User resources? Possible values are System and User. Defaults to User.

Name string

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

NodeCount int

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.

NodeLabels map[string]string

A map of Kubernetes labels which should be applied to nodes in this Node Pool. Changing this forces a new resource to be created.

NodeTaints []string

A list of Kubernetes taints which should be applied to nodes in the agent pool (e.g key=value:NoSchedule). Changing this forces a new resource to be created.

OrchestratorVersion string

Version of Kubernetes used for the Agents. If not specified, the latest recommended version will be used at provisioning time (but won’t auto-upgrade)

OsDiskSizeGb int

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

OsType string

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.

Priority string

The Priority for Virtual Machines within the Virtual Machine Scale Set that powers this Node Pool. Possible values are Regular and Spot. Defaults to Regular. Changing this forces a new resource to be created.

SpotMaxPrice float64

The maximum price you’re willing to pay in USD per Virtual Machine. Valid values are -1 (the current on-demand price for a Virtual Machine) or a positive value with up to five decimal places. Changing this forces a new resource to be created.

Tags map[string]string

A mapping of tags to assign to the resource.

VnetSubnetId string

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

kubernetesClusterId string

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

vmSize string

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

availabilityZones string[]

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

enableAutoScaling boolean

Whether to enable auto-scaler. Defaults to false.

enableNodePublicIp boolean

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

evictionPolicy string

The Eviction Policy which should be used for Virtual Machines within the Virtual Machine Scale Set powering this Node Pool. Possible values are Deallocate and Delete. Changing this forces a new resource to be created.

maxCount number

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.

maxPods number

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

minCount number

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.

mode string

Should this Node Pool be used for System or User resources? Possible values are System and User. Defaults to User.

name string

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

nodeCount number

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.

nodeLabels {[key: string]: string}

A map of Kubernetes labels which should be applied to nodes in this Node Pool. Changing this forces a new resource to be created.

nodeTaints string[]

A list of Kubernetes taints which should be applied to nodes in the agent pool (e.g key=value:NoSchedule). Changing this forces a new resource to be created.

orchestratorVersion string

Version of Kubernetes used for the Agents. If not specified, the latest recommended version will be used at provisioning time (but won’t auto-upgrade)

osDiskSizeGb number

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

osType string

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.

priority string

The Priority for Virtual Machines within the Virtual Machine Scale Set that powers this Node Pool. Possible values are Regular and Spot. Defaults to Regular. Changing this forces a new resource to be created.

spotMaxPrice number

The maximum price you’re willing to pay in USD per Virtual Machine. Valid values are -1 (the current on-demand price for a Virtual Machine) or a positive value with up to five decimal places. Changing this forces a new resource to be created.

tags {[key: string]: string}

A mapping of tags to assign to the resource.

vnetSubnetId string

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

kubernetes_cluster_id str

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

vm_size str

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

availability_zones List[str]

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

enable_auto_scaling bool

Whether to enable auto-scaler. Defaults to false.

enable_node_public_ip bool

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

eviction_policy str

The Eviction Policy which should be used for Virtual Machines within the Virtual Machine Scale Set powering this Node Pool. Possible values are Deallocate and Delete. Changing this forces a new resource to be created.

max_count float

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.

max_pods float

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

min_count float

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.

mode str

Should this Node Pool be used for System or User resources? Possible values are System and User. Defaults to User.

name str

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

node_count float

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.

node_labels Dict[str, str]

A map of Kubernetes labels which should be applied to nodes in this Node Pool. Changing this forces a new resource to be created.

node_taints List[str]

A list of Kubernetes taints which should be applied to nodes in the agent pool (e.g key=value:NoSchedule). Changing this forces a new resource to be created.

orchestrator_version str

Version of Kubernetes used for the Agents. If not specified, the latest recommended version will be used at provisioning time (but won’t auto-upgrade)

os_disk_size_gb float

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

os_type str

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.

priority str

The Priority for Virtual Machines within the Virtual Machine Scale Set that powers this Node Pool. Possible values are Regular and Spot. Defaults to Regular. Changing this forces a new resource to be created.

spot_max_price float

The maximum price you’re willing to pay in USD per Virtual Machine. Valid values are -1 (the current on-demand price for a Virtual Machine) or a positive value with up to five decimal places. Changing this forces a new resource to be created.

tags Dict[str, str]

A mapping of tags to assign to the resource.

vnet_subnet_id str

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

Outputs

All input properties are implicitly available as output properties. Additionally, the KubernetesClusterNodePool resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.

Look up an Existing KubernetesClusterNodePool Resource

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

static get(resource_name, id, opts=None, availability_zones=None, enable_auto_scaling=None, enable_node_public_ip=None, eviction_policy=None, kubernetes_cluster_id=None, max_count=None, max_pods=None, min_count=None, mode=None, name=None, node_count=None, node_labels=None, node_taints=None, orchestrator_version=None, os_disk_size_gb=None, os_type=None, priority=None, spot_max_price=None, tags=None, vm_size=None, vnet_subnet_id=None, __props__=None);
func GetKubernetesClusterNodePool(ctx *Context, name string, id IDInput, state *KubernetesClusterNodePoolState, opts ...ResourceOption) (*KubernetesClusterNodePool, error)
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.

The following state arguments are supported:

AvailabilityZones List<string>

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

EnableAutoScaling bool

Whether to enable auto-scaler. Defaults to false.

EnableNodePublicIp bool

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

EvictionPolicy string

The Eviction Policy which should be used for Virtual Machines within the Virtual Machine Scale Set powering this Node Pool. Possible values are Deallocate and Delete. Changing this forces a new resource to be created.

KubernetesClusterId string

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

MaxCount int

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.

MaxPods int

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

MinCount int

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.

Mode string

Should this Node Pool be used for System or User resources? Possible values are System and User. Defaults to User.

Name string

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

NodeCount int

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.

NodeLabels Dictionary<string, string>

A map of Kubernetes labels which should be applied to nodes in this Node Pool. Changing this forces a new resource to be created.

NodeTaints List<string>

A list of Kubernetes taints which should be applied to nodes in the agent pool (e.g key=value:NoSchedule). Changing this forces a new resource to be created.

OrchestratorVersion string

Version of Kubernetes used for the Agents. If not specified, the latest recommended version will be used at provisioning time (but won’t auto-upgrade)

OsDiskSizeGb int

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

OsType string

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.

Priority string

The Priority for Virtual Machines within the Virtual Machine Scale Set that powers this Node Pool. Possible values are Regular and Spot. Defaults to Regular. Changing this forces a new resource to be created.

SpotMaxPrice double

The maximum price you’re willing to pay in USD per Virtual Machine. Valid values are -1 (the current on-demand price for a Virtual Machine) or a positive value with up to five decimal places. Changing this forces a new resource to be created.

Tags Dictionary<string, string>

A mapping of tags to assign to the resource.

VmSize string

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

VnetSubnetId string

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

AvailabilityZones []string

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

EnableAutoScaling bool

Whether to enable auto-scaler. Defaults to false.

EnableNodePublicIp bool

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

EvictionPolicy string

The Eviction Policy which should be used for Virtual Machines within the Virtual Machine Scale Set powering this Node Pool. Possible values are Deallocate and Delete. Changing this forces a new resource to be created.

KubernetesClusterId string

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

MaxCount int

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.

MaxPods int

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

MinCount int

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.

Mode string

Should this Node Pool be used for System or User resources? Possible values are System and User. Defaults to User.

Name string

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

NodeCount int

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.

NodeLabels map[string]string

A map of Kubernetes labels which should be applied to nodes in this Node Pool. Changing this forces a new resource to be created.

NodeTaints []string

A list of Kubernetes taints which should be applied to nodes in the agent pool (e.g key=value:NoSchedule). Changing this forces a new resource to be created.

OrchestratorVersion string

Version of Kubernetes used for the Agents. If not specified, the latest recommended version will be used at provisioning time (but won’t auto-upgrade)

OsDiskSizeGb int

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

OsType string

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.

Priority string

The Priority for Virtual Machines within the Virtual Machine Scale Set that powers this Node Pool. Possible values are Regular and Spot. Defaults to Regular. Changing this forces a new resource to be created.

SpotMaxPrice float64

The maximum price you’re willing to pay in USD per Virtual Machine. Valid values are -1 (the current on-demand price for a Virtual Machine) or a positive value with up to five decimal places. Changing this forces a new resource to be created.

Tags map[string]string

A mapping of tags to assign to the resource.

VmSize string

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

VnetSubnetId string

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

availabilityZones string[]

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

enableAutoScaling boolean

Whether to enable auto-scaler. Defaults to false.

enableNodePublicIp boolean

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

evictionPolicy string

The Eviction Policy which should be used for Virtual Machines within the Virtual Machine Scale Set powering this Node Pool. Possible values are Deallocate and Delete. Changing this forces a new resource to be created.

kubernetesClusterId string

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

maxCount number

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.

maxPods number

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

minCount number

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.

mode string

Should this Node Pool be used for System or User resources? Possible values are System and User. Defaults to User.

name string

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

nodeCount number

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.

nodeLabels {[key: string]: string}

A map of Kubernetes labels which should be applied to nodes in this Node Pool. Changing this forces a new resource to be created.

nodeTaints string[]

A list of Kubernetes taints which should be applied to nodes in the agent pool (e.g key=value:NoSchedule). Changing this forces a new resource to be created.

orchestratorVersion string

Version of Kubernetes used for the Agents. If not specified, the latest recommended version will be used at provisioning time (but won’t auto-upgrade)

osDiskSizeGb number

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

osType string

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.

priority string

The Priority for Virtual Machines within the Virtual Machine Scale Set that powers this Node Pool. Possible values are Regular and Spot. Defaults to Regular. Changing this forces a new resource to be created.

spotMaxPrice number

The maximum price you’re willing to pay in USD per Virtual Machine. Valid values are -1 (the current on-demand price for a Virtual Machine) or a positive value with up to five decimal places. Changing this forces a new resource to be created.

tags {[key: string]: string}

A mapping of tags to assign to the resource.

vmSize string

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

vnetSubnetId string

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

availability_zones List[str]

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

enable_auto_scaling bool

Whether to enable auto-scaler. Defaults to false.

enable_node_public_ip bool

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

eviction_policy str

The Eviction Policy which should be used for Virtual Machines within the Virtual Machine Scale Set powering this Node Pool. Possible values are Deallocate and Delete. Changing this forces a new resource to be created.

kubernetes_cluster_id str

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

max_count float

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.

max_pods float

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

min_count float

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.

mode str

Should this Node Pool be used for System or User resources? Possible values are System and User. Defaults to User.

name str

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

node_count float

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.

node_labels Dict[str, str]

A map of Kubernetes labels which should be applied to nodes in this Node Pool. Changing this forces a new resource to be created.

node_taints List[str]

A list of Kubernetes taints which should be applied to nodes in the agent pool (e.g key=value:NoSchedule). Changing this forces a new resource to be created.

orchestrator_version str

Version of Kubernetes used for the Agents. If not specified, the latest recommended version will be used at provisioning time (but won’t auto-upgrade)

os_disk_size_gb float

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

os_type str

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.

priority str

The Priority for Virtual Machines within the Virtual Machine Scale Set that powers this Node Pool. Possible values are Regular and Spot. Defaults to Regular. Changing this forces a new resource to be created.

spot_max_price float

The maximum price you’re willing to pay in USD per Virtual Machine. Valid values are -1 (the current on-demand price for a Virtual Machine) or a positive value with up to five decimal places. Changing this forces a new resource to be created.

tags Dict[str, str]

A mapping of tags to assign to the resource.

vm_size str

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

vnet_subnet_id str

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

Package Details

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