Set-AzAksCluster

Is this page helpful?

Any additional feedback?

Feedback will be sent to Microsoft: By pressing the submit button, your feedback will be used to improve Microsoft products and services. Privacy policy.

Module:

Az.Aks

Update or create a managed Kubernetes cluster.

Syntax

Set-AzAksCluster
   [-NodePoolMode <String>]
   [-AcrNameToDetach <String>]
   [-NodeImageOnly]
   [-ControlPlaneOnly]
   [-ResourceGroupName] <String>
   [-Name] <String>
   [[-ServicePrincipalIdAndSecret] <PSCredential>]
   [-Location <String>]
   [-LinuxProfileAdminUserName <String>]
   [-DnsNamePrefix <String>]
   [-KubernetesVersion <String>]
   [-NodeName <String>]
   [-NodeMinCount <Int32>]
   [-NodeMaxCount <Int32>]
   [-EnableNodeAutoScaling]
   [-NodeCount <Int32>]
   [-NodeOsDiskSize <Int32>]
   [-NodeVmSize <String>]
   [-SshKeyValue <String>]
   [-AcrNameToAttach <String>]
   [-AsJob]
   [-Tag <Hashtable>]
   [-LoadBalancerAllocatedOutboundPort <Int32>]
   [-LoadBalancerManagedOutboundIpCount <Int32>]
   [-LoadBalancerOutboundIp <String[]>]
   [-LoadBalancerOutboundIpPrefix <String[]>]
   [-LoadBalancerIdleTimeoutInMinute <Int32>]
   [-ApiServerAccessAuthorizedIpRange <String[]>]
   [-EnableApiServerAccessPrivateCluster]
   [-ApiServerAccessPrivateDnsZone <String>]
   [-EnableApiServerAccessPrivateClusterPublicFQDN]
   [-FqdnSubdomain <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [-SubscriptionId <String>]
   [<CommonParameters>]

Set-AzAksCluster
   -InputObject <PSKubernetesCluster>
   [-NodePoolMode <String>]
   [-AcrNameToDetach <String>]
   [-NodeImageOnly]
   [-ControlPlaneOnly]
   [-Location <String>]
   [-LinuxProfileAdminUserName <String>]
   [-DnsNamePrefix <String>]
   [-KubernetesVersion <String>]
   [-NodeName <String>]
   [-NodeMinCount <Int32>]
   [-NodeMaxCount <Int32>]
   [-EnableNodeAutoScaling]
   [-NodeCount <Int32>]
   [-NodeOsDiskSize <Int32>]
   [-NodeVmSize <String>]
   [-SshKeyValue <String>]
   [-AcrNameToAttach <String>]
   [-AsJob]
   [-Tag <Hashtable>]
   [-LoadBalancerAllocatedOutboundPort <Int32>]
   [-LoadBalancerManagedOutboundIpCount <Int32>]
   [-LoadBalancerOutboundIp <String[]>]
   [-LoadBalancerOutboundIpPrefix <String[]>]
   [-LoadBalancerIdleTimeoutInMinute <Int32>]
   [-ApiServerAccessAuthorizedIpRange <String[]>]
   [-EnableApiServerAccessPrivateCluster]
   [-ApiServerAccessPrivateDnsZone <String>]
   [-EnableApiServerAccessPrivateClusterPublicFQDN]
   [-FqdnSubdomain <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [-SubscriptionId <String>]
   [<CommonParameters>]

Set-AzAksCluster
   [-NodePoolMode <String>]
   [-AcrNameToDetach <String>]
   [-NodeImageOnly]
   [-ControlPlaneOnly]
   [-Id] <String>
   [-Location <String>]
   [-LinuxProfileAdminUserName <String>]
   [-DnsNamePrefix <String>]
   [-KubernetesVersion <String>]
   [-NodeName <String>]
   [-NodeMinCount <Int32>]
   [-NodeMaxCount <Int32>]
   [-EnableNodeAutoScaling]
   [-NodeCount <Int32>]
   [-NodeOsDiskSize <Int32>]
   [-NodeVmSize <String>]
   [-SshKeyValue <String>]
   [-AcrNameToAttach <String>]
   [-AsJob]
   [-Tag <Hashtable>]
   [-LoadBalancerAllocatedOutboundPort <Int32>]
   [-LoadBalancerManagedOutboundIpCount <Int32>]
   [-LoadBalancerOutboundIp <String[]>]
   [-LoadBalancerOutboundIpPrefix <String[]>]
   [-LoadBalancerIdleTimeoutInMinute <Int32>]
   [-ApiServerAccessAuthorizedIpRange <String[]>]
   [-EnableApiServerAccessPrivateCluster]
   [-ApiServerAccessPrivateDnsZone <String>]
   [-EnableApiServerAccessPrivateClusterPublicFQDN]
   [-FqdnSubdomain <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [-SubscriptionId <String>]
   [<CommonParameters>]

Description

Update or create a managed Kubernetes cluster.

Examples

Example 1

Get-AzAksCluster -ResourceGroupName group -Name myCluster | Set-AzAksCluster -NodeCount 5

Set the number of nodes in the Kubernetes cluster to 5.

Parameters

-AcrNameToAttach

Grant the 'acrpull' role of the specified ACR to AKS Service Principal, e.g. myacr

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

-AcrNameToDetach

Disable the 'acrpull' role assignment to the ACR specified by name or resource ID, e.g. myacr

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

-ApiServerAccessAuthorizedIpRange

The IP ranges authorized to access the Kubernetes API server.

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

-ApiServerAccessPrivateDnsZone

The private DNS zone mode for the cluster.

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

-AsJob

Run cmdlet in the background

Type:	SwitchParameter
Position:	Named
Default value:	None
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
Accept pipeline input:	False
Accept wildcard characters:	False

-ControlPlaneOnly

Will only upgrade control plane to target version.

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

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-DnsNamePrefix

The DNS name prefix for the cluster.

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

-EnableApiServerAccessPrivateCluster

Whether to create the cluster as a private cluster or not.

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

-EnableApiServerAccessPrivateClusterPublicFQDN

Whether to create additional public FQDN for private cluster or not.

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

-EnableNodeAutoScaling

Whether to enable auto-scaler

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

-FqdnSubdomain

The FQDN subdomain of the private cluster with custom private dns zone.

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

-Id

Id of a managed Kubernetes cluster

Type:	String
Aliases:	ResourceId
Position:	0
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-InputObject

A PSKubernetesCluster object, normally passed through the pipeline.

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

-KubernetesVersion

The version of Kubernetes to use for creating the cluster.

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

-LinuxProfileAdminUserName

User name for the Linux Virtual Machines.

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

-LoadBalancerAllocatedOutboundPort

The desired number of allocated SNAT ports per VM.

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

-LoadBalancerIdleTimeoutInMinute

Desired outbound flow idle timeout in minutes.

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

-LoadBalancerManagedOutboundIpCount

Desired managed outbound IPs count for the cluster load balancer.

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

-LoadBalancerOutboundIp

Desired outbound IP resources for the cluster load balancer.

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

-LoadBalancerOutboundIpPrefix

Desired outbound IP Prefix resources for the cluster load balancer.

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

-Location

Azure location for the cluster. Defaults to the location of the resource group.

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

-Name

Kubernetes managed cluster Name.

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

-NodeCount

The default number of nodes for the node pools.

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

-NodeImageOnly

Will only upgrade node pool version to align control plane.

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

-NodeMaxCount

Maximum number of nodes for auto-scaling

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

-NodeMinCount

Minimum number of nodes for auto-scaling.

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

-NodeName

Unique name of the agent pool profile in the context of the subscription and resource group.

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

-NodeOsDiskSize

Specifies the size, in GB, of the operating system disk.

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

-NodePoolMode

NodePoolMode represents mode of an node pool.

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

-NodeVmSize

The size of the Virtual Machine.

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

-ResourceGroupName

Resource Group Name.

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

-ServicePrincipalIdAndSecret

The client id and client secret associated with the AAD application / service principal.

Type:	PSCredential
Position:	2
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-SshKeyValue

SSH key file value or key file path. Defaults to {HOME}/.ssh/id_rsa.pub.

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

-SubscriptionId

The ID of the subscription. By default, cmdlets are executed in the subscription that is set in the current context. If the user specifies another subscription, the current cmdlet is executed in the subscription specified by the user. Overriding subscriptions only take effect during the lifecycle of the current cmdlet. It does not change the subscription in the context, and does not affect subsequent cmdlets.

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

-Tag

Tags to be applied to the resource

Type:	Hashtable
Position:	Named
Default value:	None
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
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

PSKubernetesCluster

String

Outputs

PSKubernetesCluster