New-AzAksArcNodepool

Module:

Az.AksArc

Create the agent pool in the provisioned cluster

Syntax

New-AzAksArcNodepool
   -ClusterName <String>
   -ResourceGroupName <String>
   -Name <String>
   [-SubscriptionId <String>]
   [-Count <Int32>]
   [-EnableAutoScaling]
   [-MinCount <Int32>]
   [-MaxCount <Int32>]
   [-MaxPod <Int32>]
   [-NodeLabel <Hashtable>]
   [-NodeTaint <String[]>]
   [-OSSku <String>]
   [-OSType <String>]
   [-Tag <Hashtable>]
   [-VMSize <String>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-AzAksArcNodepool
   -ClusterName <String>
   -ResourceGroupName <String>
   -Name <String>
   [-SubscriptionId <String>]
   -InputObject <IAksArcIdentity>
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-AzAksArcNodepool
   -ClusterName <String>
   -ResourceGroupName <String>
   -Name <String>
   [-SubscriptionId <String>]
   [-EnableAutoScaling]
   -MinCount <Int32>
   -MaxCount <Int32>
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-AzAksArcNodepool
   -ClusterName <String>
   -ResourceGroupName <String>
   -Name <String>
   [-SubscriptionId <String>]
   -JsonFilePath <String>
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-AzAksArcNodepool
   -ClusterName <String>
   -ResourceGroupName <String>
   -Name <String>
   [-SubscriptionId <String>]
   -JsonString <String>
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Create the agent pool in the provisioned cluster

Examples

Example 1: Create a nodepool

New-AzAksArcNodepool -ClusterName azps_test_cluster -ResourceGroupName azps_test_group -Name azps_test_nodepool_example

Adds a nodepool in the provisioned cluster with default configuration.

Example 2: Create a nodepool with 3 nodes

New-AzAksArcNodepool -ClusterName azps_test_cluster -ResourceGroupName azps_test_group -Name azps_test_nodepool_example -Count 3

Adds a nodepool in the provisioned cluster with 3 worker nodes.

Parameters

-AsJob

Run the command as a job

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ClusterName

The name of the Kubernetes cluster on which get is called.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Count

Number of nodes in the agent pool. The default value is 1.

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-EnableAutoScaling

Whether to enable auto-scaler. Default value is false

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

Identity Parameter

Type:	IAksArcIdentity
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-JsonFilePath

Path of Json file supplied to the Create operation

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-JsonString

Json string supplied to the Create operation

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-MaxCount

The maximum number of nodes for auto-scaling

Type:	Int32
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-MaxPod

The maximum number of pods that can run on a node.

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-MinCount

The minimum number of nodes for auto-scaling

Type:	Int32
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Name

Parameter for the name of the agent pool in the provisioned cluster.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-NodeLabel

The node labels to be persisted across all nodes in agent pool.

Type:	Hashtable
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-NodeTaint

Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule.

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-NoWait

Run the command asynchronously

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-OSSku

Specifies the OS SKU used by the agent pool. The default is CBLMariner if OSType is Linux. The default is Windows2019 when OSType is Windows.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-OSType

The particular KubernetesVersion Image OS Type (Linux, Windows)

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceGroupName

The name of the resource group. The name is case insensitive.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-SubscriptionId

The ID of the target subscription.

Type:	String
Position:	Named
Default value:	(Get-AzContext).Subscription.Id
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Tag

Resource tags

Type:	Hashtable
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-VMSize

The VM sku size of the agent pool node VMs.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

IAksArcIdentity

Outputs

IAgentPool