Update-AzAksArcNodepool

Module:

Az.AksArc

Update the agent pool in the provisioned cluster

Syntax

Update-AzAksArcNodepool
      -ClusterName <String>
      -ResourceGroupName <String>
      -Name <String>
      [-SubscriptionId <String>]
      [-Count <Int32>]
      [-NodeLabel <Hashtable>]
      [-NodeTaint <String[]>]
      [-VMSize <String>]
      [-Tag <Hashtable>]
      [-AsJob]
      [-NoWait]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzAksArcNodepool
      -ClusterName <String>
      -ResourceGroupName <String>
      -Name <String>
      [-SubscriptionId <String>]
      -InputObject <IAksArcIdentity>
      [-Count <Int32>]
      [-NodeLabel <Hashtable>]
      [-NodeTaint <String[]>]
      [-VMSize <String>]
      [-Tag <Hashtable>]
      [-AsJob]
      [-NoWait]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

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

Description

Update the agent pool in the provisioned cluster

Examples

Example 1: Scale up nodes in provisioned cluster nodepool.

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

Scales up the number of nodes in the provisioned cluster nodepool.

Example 2: Update tags in nodepool

Update-AzAksArcNodepool -ClusterName azps_test_cluster -ResourceGroupName azps_test_group -Name azps_test_nodepool_example -Tag @{'key1'= 1; 'key2'= 2}

Adds the specified tags to the nodepool resource.

Example 3: Enable autoscaling in nodepool

Update-AzAksArcNodepool -ClusterName azps_test_cluster -ResourceGroupName azps_test_group -Name azps_test_nodepool_example -EnableAutoScaling -MinCount 1 -MaxCount 5

Enables autoscaling in the nodepool with specified MinCount and MaxCount.

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

-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

-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

-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