New-AzAksArcCluster

Reference

Module:: Az.AksArc

Create the provisioned cluster instance

Syntax

New-AzAksArcCluster
   -ClusterName <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String>]
   [-MinCount <Int32>]
   [-MaxCount <Int32>]
   [-MaxPod <Int32>]
   -CustomLocationName <String>
   -VnetId <String>
   -ControlPlaneIP <String>
   [-Location <String>]
   [-AdminGroupObjectID <String[]>]
   [-SshAuthIp <String>]
   [-ControlPlaneCount <Int32>]
   [-ControlPlaneVMSize <String>]
   [-KubernetesVersion <String>]
   [-EnableAzureHybridBenefit]
   [-EnableAzureRbac]
   [-LoadBalancerCount <Int32>]
   [-PodCidr <String>]
   [-NfCsiDriverEnabled]
   [-SmbCsiDriverEnabled]
   [-SshKeyValue <String>]
   [-EnableAutoScaling]
   [-NodeLabel <Hashtable>]
   [-NodeTaint <String[]>]
   [-AutoScalerProfileBalanceSimilarNodeGroup <String>]
   [-AutoScalerProfileExpander <String>]
   [-AutoScalerProfileMaxEmptyBulkDelete <String>]
   [-AutoScalerProfileMaxGracefulTerminationSec <String>]
   [-AutoScalerProfileMaxNodeProvisionTime <String>]
   [-AutoScalerProfileMaxTotalUnreadyPercentage <String>]
   [-AutoScalerProfileNewPodScaleUpDelay <String>]
   [-AutoScalerProfileOkTotalUnreadyCount <String>]
   [-AutoScalerProfileScaleDownDelayAfterAdd <String>]
   [-AutoScalerProfileScaleDownDelayAfterDelete <String>]
   [-AutoScalerProfileScaleDownDelayAfterFailure <String>]
   [-AutoScalerProfileScaleDownUnneededTime <String>]
   [-AutoScalerProfileScaleDownUnreadyTime <String>]
   [-AutoScalerProfileScaleDownUtilizationThreshold <String>]
   [-AutoScalerProfileScanInterval <String>]
   [-AutoScalerProfileSkipNodesWithLocalStorage <String>]
   [-AutoScalerProfileSkipNodesWithSystemPod <String>]
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-AzAksArcCluster
   -ClusterName <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String>]
   -MinCount <Int32>
   -MaxCount <Int32>
   -MaxPod <Int32>
   -CustomLocationName <String>
   -VnetId <String>
   -ControlPlaneIP <String>
   [-Location <String>]
   [-AdminGroupObjectID <String[]>]
   [-EnableAzureHybridBenefit]
   [-EnableAzureRbac]
   [-EnableAutoScaling]
   [-NodeLabel <Hashtable>]
   [-NodeTaint <String[]>]
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-AzAksArcCluster
   -ClusterName <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String>]
   -CustomLocationName <String>
   -VnetId <String>
   -ControlPlaneIP <String>
   [-Location <String>]
   [-AdminGroupObjectID <String[]>]
   [-EnableAzureHybridBenefit]
   [-EnableAzureRbac]
   [-NodeLabel <Hashtable>]
   [-NodeTaint <String[]>]
   -JsonFilePath <String>
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-AzAksArcCluster
   -ClusterName <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String>]
   -CustomLocationName <String>
   -VnetId <String>
   -ControlPlaneIP <String>
   [-Location <String>]
   [-AdminGroupObjectID <String[]>]
   [-EnableAzureHybridBenefit]
   [-EnableAzureRbac]
   [-NodeLabel <Hashtable>]
   [-NodeTaint <String[]>]
   -JsonString <String>
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Create the provisioned cluster instance

Examples

Example 1: Scale up control plane count

New-AzAksArcCluster -ClusterName azps_test_cluster -ResourceGroupName azps_test_group -ControlPlaneCount 3

Increase control plane count to 3 nodes.

Example 2: Enable autoscaling

New-AzAksArcCluster -ClusterName azps_test_cluster -ResourceGroupName azps_test_group -EnableAutoScaling -MinCount 1 -MaxCount 5

Enable autoscaling in provisioned cluster.

Example 3: Enable NfCsiDriver

New-AzAksArcCluster -ClusterName azps_test_cluster -ResourceGroupName azps_test_group -NfCsiDriverEnabled

Enable NfCsi driver in provisioned cluster.

Example 4: Enable SmbCsiDriver

New-AzAksArcCluster -ClusterName azps_test_cluster -ResourceGroupName azps_test_group -SmbCsiDriverEnabled

Enable SmbCsi driver in provisioned cluster.

Example 5: Enable azure hybrid benefit

New-AzAksArcCluster -ClusterName azps_test_cluster -ResourceGroupName azps_test_group -EnableAzureHybridBenefit

Enable Azure Hybrid User Benefits feature for a provisioned cluster.

Example 6: Disable azure hybrid benefit

New-AzAksArcCluster -ClusterName azps_test_cluster -ResourceGroupName azps_test_group -EnableAzureHybridBenefit:$false

Disable Azure Hybrid User Benefits feature for a provisioned cluster.

Example 7: Disable autoscaling

New-AzAksArcCluster -ClusterName azps_test_cluster -ResourceGroupName azps_test_group -EnableAutoScaling:$false

Disable autoscaling in provisioned cluster.

Example 8: Disable NfCsiDriver

New-AzAksArcCluster -ClusterName azps_test_cluster -ResourceGroupName azps_test_group -NfCsiDriverEnabled:$false

Disable NfCsi driver in provisioned cluster.

Example 9: Disable SmbCsiDriver

New-AzAksArcCluster -ClusterName azps_test_cluster -ResourceGroupName azps_test_group -SmbCsiDriverEnabled:$false

Disable SmbCsi driver in provisioned cluster.

Example 10: New aad admin GUIDS

New-AzAksArcCluster -ClusterName azps_test_cluster -ResourceGroupName azps_test_group -AdminGroupObjectID @("2e00cb64-66d8-4c9c-92d8-6462caf99e33", "1b28ff4f-f7c5-4aaa-aa79-ba8b775ab443")

New aad admin GUIDS.

Parameters

-AdminGroupObjectID

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

-AsJob

Run the command as a job

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

-AutoScalerProfileBalanceSimilarNodeGroup

Valid values are 'true' and 'false'

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

-AutoScalerProfileExpander

If not specified, the default is 'random'. See expanders for more information.

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

-AutoScalerProfileMaxEmptyBulkDelete

The default is 10.

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

-AutoScalerProfileMaxGracefulTerminationSec

The default is 600.

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

-AutoScalerProfileMaxNodeProvisionTime

The default is '15m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported.

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

-AutoScalerProfileMaxTotalUnreadyPercentage

The default is 45. The maximum is 100 and the minimum is 0.

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

-AutoScalerProfileNewPodScaleUpDelay

For scenarios like burst/batch scale where you don't want CA to act before the kubernetes scheduler could schedule all the pods, you can tell CA to ignore unscheduled pods before they're a certain age. The default is '0s'. Values must be an integer followed by a unit ('s' for seconds, 'm' for minutes, 'h' for hours, etc).

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

-AutoScalerProfileOkTotalUnreadyCount

This must be an integer. The default is 3.

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

-AutoScalerProfileScaleDownDelayAfterAdd

The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported.

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

-AutoScalerProfileScaleDownDelayAfterDelete

The default is the scan-interval. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported.

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

-AutoScalerProfileScaleDownDelayAfterFailure

The default is '3m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported.

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

-AutoScalerProfileScaleDownUnneededTime

The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported.

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

-AutoScalerProfileScaleDownUnreadyTime

The default is '20m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported.

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

-AutoScalerProfileScaleDownUtilizationThreshold

The default is '0.5'.

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

-AutoScalerProfileScanInterval

The default is '10'. Values must be an integer number of seconds.

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

-AutoScalerProfileSkipNodesWithLocalStorage

The default is true.

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

-AutoScalerProfileSkipNodesWithSystemPod

The default is true.

Type:	String
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

-ControlPlaneCount

Number of control plane nodes. The default value is 1, and the count should be an odd number

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

-ControlPlaneIP

IP address of the Kubernetes API server

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

-ControlPlaneVMSize

VM sku size of the control plane nodes

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

-CustomLocationName

ARM Id of the extended location.

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

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Type:	PSObject
Aliases:	AzureRMContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-EnableAutoScaling

Indicates whether to enable NFS CSI Driver. The default value is true.

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

-EnableAzureHybridBenefit

Indicates whether Azure Hybrid Benefit is opted in. Default value is false

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

-EnableAzureRbac

Indicates whether azure rbac is enabled. Default value is false

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

-KubernetesVersion

The version of Kubernetes in use by the provisioned cluster.

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

-LoadBalancerCount

Number of HA Proxy load balancer VMs. The default value is 0.

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

-Location

Location

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

-MaxCount

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

-MaxPod

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

-MinCount

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

-NfCsiDriverEnabled

Indicates whether to enable NFS CSI Driver. The default value is true.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
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

-PodCidr

A CIDR notation IP Address range from which to assign pod IPs.

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

-SmbCsiDriverEnabled

Indicates whether to enable SMB CSI Driver. The default value is true.

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

-SshAuthIp

IP Address or CIDR for SSH access to VMs in the provisioned cluster

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

-SshKeyValue

The list of SSH public keys used to authenticate with VMs. A maximum of 1 key may be specified.

Type:	String
Position:	Named
Default value:	None
Required:	False
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

-VnetId

List of ARM resource Ids (maximum 1) for the infrastructure network object e.g. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/logicalNetworks/{logicalNetworkName}

Type:	String
Position:	Named
Default value:	None
Required:	True
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

Outputs

IProvisionedCluster

Share via

New-AzAksArcCluster

Syntax

Description

Examples

Example 1: Scale up control plane count

Example 2: Enable autoscaling

Example 3: Enable NfCsiDriver

Example 4: Enable SmbCsiDriver

Example 5: Enable azure hybrid benefit

Example 6: Disable azure hybrid benefit

Example 7: Disable autoscaling

Example 8: Disable NfCsiDriver

Example 9: Disable SmbCsiDriver

Example 10: New aad admin GUIDS

Parameters

-AdminGroupObjectID

-AsJob

-AutoScalerProfileBalanceSimilarNodeGroup

-AutoScalerProfileExpander

-AutoScalerProfileMaxEmptyBulkDelete

-AutoScalerProfileMaxGracefulTerminationSec

-AutoScalerProfileMaxNodeProvisionTime

-AutoScalerProfileMaxTotalUnreadyPercentage

-AutoScalerProfileNewPodScaleUpDelay

-AutoScalerProfileOkTotalUnreadyCount

-AutoScalerProfileScaleDownDelayAfterAdd

-AutoScalerProfileScaleDownDelayAfterDelete

-AutoScalerProfileScaleDownDelayAfterFailure

-AutoScalerProfileScaleDownUnneededTime

-AutoScalerProfileScaleDownUnreadyTime

-AutoScalerProfileScaleDownUtilizationThreshold

-AutoScalerProfileScanInterval

-AutoScalerProfileSkipNodesWithLocalStorage

-AutoScalerProfileSkipNodesWithSystemPod

-ClusterName

-Confirm

-ControlPlaneCount

-ControlPlaneIP

-ControlPlaneVMSize

-CustomLocationName

-DefaultProfile

-EnableAutoScaling

-EnableAzureHybridBenefit

-EnableAzureRbac

-JsonFilePath

-JsonString

-KubernetesVersion

-LoadBalancerCount

-Location

-MaxCount

-MaxPod

-MinCount

-NfCsiDriverEnabled

-NodeLabel

-NodeTaint

-NoWait

-PodCidr

-ResourceGroupName

-SmbCsiDriverEnabled

-SshAuthIp

-SshKeyValue

-SubscriptionId

-VnetId

-WhatIf

Outputs

Additional resources