Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
Set-AzAksCluster
- Module:
- Az.Aks Module
Update or create a managed Kubernetes cluster.
Syntax
defaultParameterSet (Default)
Set-AzAksCluster
[-ResourceGroupName] <String>
[-Name] <String>
[[-ServicePrincipalIdAndSecret] <PSCredential>]
[-NodePoolMode <String>]
[-AcrNameToDetach <String>]
[-NodeImageOnly]
[-ControlPlaneOnly]
[-AutoScalerProfile <ManagedClusterPropertiesAutoScalerProfile>]
[-EnableUptimeSLA]
[-EnableOidcIssuer]
[-Location <String>]
[-EnableManagedIdentity]
[-AssignIdentity <String>]
[-AadProfile <ManagedClusterAADProfile>]
[-NodeCount <Int32>]
[-EnableNodeAutoScaling]
[-NodeMaxCount <Int32>]
[-NodeMinCount <Int32>]
[-NodeName <String>]
[-NodePoolLabel <Hashtable>]
[-NodeTaint <String[]>]
[-NodeOsDiskSize <Int32>]
[-NodePoolTag <Hashtable>]
[-NodeVmSize <String>]
[-NodeWorkloadRuntime <String>]
[-EnableAIToolchainOperator]
[-ApiServerAccessAuthorizedIpRange <String[]>]
[-DisableApiServerRunCommand]
[-EnableApiServerAccessPrivateCluster]
[-EnableApiServerAccessPrivateClusterPublicFQDN]
[-EnableApiServerVnetIntegration]
[-ApiServerAccessPrivateDnsZone <String>]
[-ApiServerSubnetId <String>]
[-NodeOSAutoUpgradeChannel <String>]
[-NodeAutoUpgradeChannel <String>]
[-EnableMonitorMetric]
[-BootstrapArtifactSource <String>]
[-BootstrapContainerRegistryId <String>]
[-DisableLocalAccount]
[-DiskEncryptionSetID <String>]
[-DnsNamePrefix <String>]
[-FqdnSubdomain <String>]
[-HttpProxy <String>]
[-HttpsProxy <String>]
[-HttpProxyConfigNoProxyEndpoint <String[]>]
[-HttpProxyConfigTrustedCa <String>]
[-AssignKubeletIdentity <String>]
[-KubernetesVersion <String>]
[-LinuxProfileAdminUserName <String>]
[-SshKeyValue <String>]
[-EnableCostAnalysis]
[-EnableAdvancedNetworking]
[-EnableAdvancedNetworkingObservability]
[-EnableAdvancedNetworkingSecurity]
[-AdvancedNetworkingSecurityPolicy <String>]
[-IPFamily <String[]>]
[-LoadBalancerAllocatedOutboundPort <Int32>]
[-LoadBalancerBackendPoolType <String>]
[-LoadBalancerIdleTimeoutInMinute <Int32>]
[-LoadBalancerManagedOutboundIpCount <Int32>]
[-LoadBalancerManagedOutboundIpCountIPv6 <Int32>]
[-LoadBalancerOutboundIpPrefix <String[]>]
[-LoadBalancerOutboundIp <String[]>]
[-NATGatewayIdleTimeoutInMinute <Int32>]
[-NATGatewayManagedOutboundIpCount <Int32>]
[-NetworkDataplane <String>]
[-NetworkPluginMode <String>]
[-EnableStaticEgressGateway]
[-NodeProvisioningMode <String>]
[-NodeProvisioningDefaultPool <String>]
[-NodeResourceGroupRestrictionLevel <String>]
[-EnablePodIdentity]
[-EnablePodIdentityWithKubenet]
[-EnablePublicNetworkAccess]
[-EnableAzureKeyVaultKms]
[-AzureKeyVaultKmsKeyId <String>]
[-AzureKeyVaultKmsNetworkAccess <String>]
[-AzureKeyVaultKmsResourceId <String>]
[-CustomCaTrustCertificate <String[]>]
[-DefenderLogAnalyticsWorkspaceResourceId <String>]
[-EnableDefenderSecurityMonitoring]
[-EnableImageCleaner]
[-ImageCleanerIntervalHour <Int32>]
[-EnableWorkloadIdentity]
[-SupportPlan <String>]
[-WindowsProfileAdminUserPassword <SecureString>]
[-EnableAHUB]
[-EnableKEDA]
[-EnableVerticalPodAutoscaler]
[-Tag <Hashtable>]
[-EnableBlobCSIDriver]
[-EnableDiskCSIDriver]
[-EnableFileCSIDriver]
[-EnableSnapshotCSIDriver]
[-AksCustomHeader <Hashtable>]
[-IfMatch <String>]
[-IfNoneMatch <String>]
[-AcrNameToAttach <String>]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[-SubscriptionId <String>]
[<CommonParameters>]
InputObjectParameterSet
Set-AzAksCluster
-InputObject <PSKubernetesCluster>
[-NodePoolMode <String>]
[-AcrNameToDetach <String>]
[-NodeImageOnly]
[-ControlPlaneOnly]
[-AutoScalerProfile <ManagedClusterPropertiesAutoScalerProfile>]
[-EnableUptimeSLA]
[-EnableOidcIssuer]
[-Location <String>]
[-EnableManagedIdentity]
[-AssignIdentity <String>]
[-AadProfile <ManagedClusterAADProfile>]
[-NodeCount <Int32>]
[-EnableNodeAutoScaling]
[-NodeMaxCount <Int32>]
[-NodeMinCount <Int32>]
[-NodeName <String>]
[-NodePoolLabel <Hashtable>]
[-NodeTaint <String[]>]
[-NodeOsDiskSize <Int32>]
[-NodePoolTag <Hashtable>]
[-NodeVmSize <String>]
[-NodeWorkloadRuntime <String>]
[-EnableAIToolchainOperator]
[-ApiServerAccessAuthorizedIpRange <String[]>]
[-DisableApiServerRunCommand]
[-EnableApiServerAccessPrivateCluster]
[-EnableApiServerAccessPrivateClusterPublicFQDN]
[-EnableApiServerVnetIntegration]
[-ApiServerAccessPrivateDnsZone <String>]
[-ApiServerSubnetId <String>]
[-NodeOSAutoUpgradeChannel <String>]
[-NodeAutoUpgradeChannel <String>]
[-EnableMonitorMetric]
[-BootstrapArtifactSource <String>]
[-BootstrapContainerRegistryId <String>]
[-DisableLocalAccount]
[-DiskEncryptionSetID <String>]
[-DnsNamePrefix <String>]
[-FqdnSubdomain <String>]
[-HttpProxy <String>]
[-HttpsProxy <String>]
[-HttpProxyConfigNoProxyEndpoint <String[]>]
[-HttpProxyConfigTrustedCa <String>]
[-AssignKubeletIdentity <String>]
[-KubernetesVersion <String>]
[-LinuxProfileAdminUserName <String>]
[-SshKeyValue <String>]
[-EnableCostAnalysis]
[-EnableAdvancedNetworking]
[-EnableAdvancedNetworkingObservability]
[-EnableAdvancedNetworkingSecurity]
[-AdvancedNetworkingSecurityPolicy <String>]
[-IPFamily <String[]>]
[-LoadBalancerAllocatedOutboundPort <Int32>]
[-LoadBalancerBackendPoolType <String>]
[-LoadBalancerIdleTimeoutInMinute <Int32>]
[-LoadBalancerManagedOutboundIpCount <Int32>]
[-LoadBalancerManagedOutboundIpCountIPv6 <Int32>]
[-LoadBalancerOutboundIpPrefix <String[]>]
[-LoadBalancerOutboundIp <String[]>]
[-NATGatewayIdleTimeoutInMinute <Int32>]
[-NATGatewayManagedOutboundIpCount <Int32>]
[-NetworkDataplane <String>]
[-NetworkPluginMode <String>]
[-EnableStaticEgressGateway]
[-NodeProvisioningMode <String>]
[-NodeProvisioningDefaultPool <String>]
[-NodeResourceGroupRestrictionLevel <String>]
[-EnablePodIdentity]
[-EnablePodIdentityWithKubenet]
[-EnablePublicNetworkAccess]
[-EnableAzureKeyVaultKms]
[-AzureKeyVaultKmsKeyId <String>]
[-AzureKeyVaultKmsNetworkAccess <String>]
[-AzureKeyVaultKmsResourceId <String>]
[-CustomCaTrustCertificate <String[]>]
[-DefenderLogAnalyticsWorkspaceResourceId <String>]
[-EnableDefenderSecurityMonitoring]
[-EnableImageCleaner]
[-ImageCleanerIntervalHour <Int32>]
[-EnableWorkloadIdentity]
[-SupportPlan <String>]
[-WindowsProfileAdminUserPassword <SecureString>]
[-EnableAHUB]
[-EnableKEDA]
[-EnableVerticalPodAutoscaler]
[-Tag <Hashtable>]
[-EnableBlobCSIDriver]
[-EnableDiskCSIDriver]
[-EnableFileCSIDriver]
[-EnableSnapshotCSIDriver]
[-AksCustomHeader <Hashtable>]
[-IfMatch <String>]
[-IfNoneMatch <String>]
[-AcrNameToAttach <String>]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[-SubscriptionId <String>]
[<CommonParameters>]
IdParameterSet
Set-AzAksCluster
[-Id] <String>
[-NodePoolMode <String>]
[-AcrNameToDetach <String>]
[-NodeImageOnly]
[-ControlPlaneOnly]
[-AutoScalerProfile <ManagedClusterPropertiesAutoScalerProfile>]
[-EnableUptimeSLA]
[-EnableOidcIssuer]
[-Location <String>]
[-EnableManagedIdentity]
[-AssignIdentity <String>]
[-AadProfile <ManagedClusterAADProfile>]
[-NodeCount <Int32>]
[-EnableNodeAutoScaling]
[-NodeMaxCount <Int32>]
[-NodeMinCount <Int32>]
[-NodeName <String>]
[-NodePoolLabel <Hashtable>]
[-NodeTaint <String[]>]
[-NodeOsDiskSize <Int32>]
[-NodePoolTag <Hashtable>]
[-NodeVmSize <String>]
[-NodeWorkloadRuntime <String>]
[-EnableAIToolchainOperator]
[-ApiServerAccessAuthorizedIpRange <String[]>]
[-DisableApiServerRunCommand]
[-EnableApiServerAccessPrivateCluster]
[-EnableApiServerAccessPrivateClusterPublicFQDN]
[-EnableApiServerVnetIntegration]
[-ApiServerAccessPrivateDnsZone <String>]
[-ApiServerSubnetId <String>]
[-NodeOSAutoUpgradeChannel <String>]
[-NodeAutoUpgradeChannel <String>]
[-EnableMonitorMetric]
[-BootstrapArtifactSource <String>]
[-BootstrapContainerRegistryId <String>]
[-DisableLocalAccount]
[-DiskEncryptionSetID <String>]
[-DnsNamePrefix <String>]
[-FqdnSubdomain <String>]
[-HttpProxy <String>]
[-HttpsProxy <String>]
[-HttpProxyConfigNoProxyEndpoint <String[]>]
[-HttpProxyConfigTrustedCa <String>]
[-AssignKubeletIdentity <String>]
[-KubernetesVersion <String>]
[-LinuxProfileAdminUserName <String>]
[-SshKeyValue <String>]
[-EnableCostAnalysis]
[-EnableAdvancedNetworking]
[-EnableAdvancedNetworkingObservability]
[-EnableAdvancedNetworkingSecurity]
[-AdvancedNetworkingSecurityPolicy <String>]
[-IPFamily <String[]>]
[-LoadBalancerAllocatedOutboundPort <Int32>]
[-LoadBalancerBackendPoolType <String>]
[-LoadBalancerIdleTimeoutInMinute <Int32>]
[-LoadBalancerManagedOutboundIpCount <Int32>]
[-LoadBalancerManagedOutboundIpCountIPv6 <Int32>]
[-LoadBalancerOutboundIpPrefix <String[]>]
[-LoadBalancerOutboundIp <String[]>]
[-NATGatewayIdleTimeoutInMinute <Int32>]
[-NATGatewayManagedOutboundIpCount <Int32>]
[-NetworkDataplane <String>]
[-NetworkPluginMode <String>]
[-EnableStaticEgressGateway]
[-NodeProvisioningMode <String>]
[-NodeProvisioningDefaultPool <String>]
[-NodeResourceGroupRestrictionLevel <String>]
[-EnablePodIdentity]
[-EnablePodIdentityWithKubenet]
[-EnablePublicNetworkAccess]
[-EnableAzureKeyVaultKms]
[-AzureKeyVaultKmsKeyId <String>]
[-AzureKeyVaultKmsNetworkAccess <String>]
[-AzureKeyVaultKmsResourceId <String>]
[-CustomCaTrustCertificate <String[]>]
[-DefenderLogAnalyticsWorkspaceResourceId <String>]
[-EnableDefenderSecurityMonitoring]
[-EnableImageCleaner]
[-ImageCleanerIntervalHour <Int32>]
[-EnableWorkloadIdentity]
[-SupportPlan <String>]
[-WindowsProfileAdminUserPassword <SecureString>]
[-EnableAHUB]
[-EnableKEDA]
[-EnableVerticalPodAutoscaler]
[-Tag <Hashtable>]
[-EnableBlobCSIDriver]
[-EnableDiskCSIDriver]
[-EnableFileCSIDriver]
[-EnableSnapshotCSIDriver]
[-AksCustomHeader <Hashtable>]
[-IfMatch <String>]
[-IfNoneMatch <String>]
[-AcrNameToAttach <String>]
[-AsJob]
[-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.
Example 2: Update an AKS cluster with AutoScalerProfile.
When you update an AKS cluster, you can configure granular details of the cluster autoscaler by changing the default values in the cluster-wide autoscaler profile.
$AutoScalerProfile=@{
ScanInterval="40s"
Expander="priority"
}
$AutoScalerProfile=[Microsoft.Azure.Management.ContainerService.Models.ManagedClusterPropertiesAutoScalerProfile]$AutoScalerProfile
Get-AzAksCluster -ResourceGroupName group -Name myCluster | Set-AzAksCluster -AutoScalerProfile $AutoScalerProfile
Example 3: Update an AKS cluster with AadProfile.
When you update an AKS cluster, you can configure the AAD profile.
$AKSAdminGroup=New-AzADGroup -DisplayName myAKSAdminGroup -MailNickname myAKSAdminGroup
$AadProfile=@{
managed=$true
enableAzureRBAC=$false
adminGroupObjectIDs=[System.Collections.Generic.List[string]]@($AKSAdminGroup.Id)
}
$AadProfile=[Microsoft.Azure.Management.ContainerService.Models.ManagedClusterAADProfile]$AadProfile
Set-AzAksCluster -ResourceGroupName myResourceGroup -Name myAKSCluster -AadProfile $AadProfile
Parameters
-AadProfile
The Azure Active Directory configuration.
Parameter properties
| Type: | ManagedClusterAADProfile |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-AcrNameToAttach
Grant the 'acrpull' role of the specified ACR to AKS Service Principal, e.g. myacr
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-AcrNameToDetach
Disable the 'acrpull' role assignment to the ACR specified by name or resource ID, e.g. myacr
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-AdvancedNetworkingSecurityPolicy
The advanced network policies. This allows users to configure Layer 7 network policies (FQDN, HTTP, Kafka). Policies themselves must be configured via the Cilium Network Policy resources, see https://docs.cilium.io/en/latest/security/policy/index.html. This can be enabled only on cilium-based clusters. If not specified, the default value is FQDN if EnableAdvancedNetworkingSecurity is set to true.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-AksCustomHeader
Aks custom headers used for building Kubernetes network.
Parameter properties
| Type: | Hashtable |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ApiServerAccessAuthorizedIpRange
The IP ranges authorized to access the Kubernetes API server.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ApiServerAccessPrivateDnsZone
The private DNS zone mode for the cluster.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ApiServerSubnetId
The subnet to be used when apiserver vnet integration is enabled. It is required when creating a new cluster with BYO Vnet, or when updating an existing cluster to enable apiserver vnet integration.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-AsJob
Run cmdlet in the background
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-AssignIdentity
ResourceId of user assign managed identity for cluster.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-AssignKubeletIdentity
ResourceId of user assign managed identity used by the kubelet.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-AutoScalerProfile
The parameters to be applied to the cluster-autoscaler.
Parameter properties
| Type: | ManagedClusterPropertiesAutoScalerProfile |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-AzureKeyVaultKmsKeyId
The identifier of Azure Key Vault key. See key identifier format for more details. When EnableAzureKeyVaultKms is set, this field is required and must be a valid key identifier.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-AzureKeyVaultKmsNetworkAccess
The network access of the key vault. Network access of key vault. The possible values are Public and Private. Public means the key vault allows public access from all networks. Private means the key vault disables public access and enables private link.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-AzureKeyVaultKmsResourceId
The resource ID of key vault. When AzureKeyVaultKmsNetworkAccess is Private, this field is required and must be a valid resource ID. When AzureKeyVaultKmsNetworkAccess is Public, leave the field empty.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-BootstrapArtifactSource
The artifact source. The source where the artifacts are downloaded from.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-BootstrapContainerRegistryId
The resource Id of Azure Container Registry. The registry must have private network access, premium SKU and zone redundancy.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
-ControlPlaneOnly
Will only upgrade control plane to target version.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-CustomCaTrustCertificate
The list of up to 10 base64 encoded CAs that will be added to the trust store on all nodes in the cluster. For more information see Custom CA Trust Certificates.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Parameter properties
| Type: | IAzureContextContainer |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
Parameter sets
-DefenderLogAnalyticsWorkspaceResourceId
The resource ID of the Log Analytics workspace to be associated with Microsoft Defender. When Microsoft Defender is enabled, this field is required and must be a valid workspace resource ID. When Microsoft Defender is disabled, leave the field empty.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-DisableApiServerRunCommand
Whether to disable run command for the cluster or not.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-DisableLocalAccount
Local accounts should be disabled on the Managed Cluster.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-DiskEncryptionSetID
The resource ID of the disk encryption set to use for enabling encryption.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-DnsNamePrefix
The DNS name prefix for the cluster.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-EnableAdvancedNetworking
Enable Advanced Networking functionalities of observability and security on AKS clusters. When this is set to true, all observability and security features will be set to enabled unless explicitly disabled. If not specified, the default is false.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-EnableAdvancedNetworkingObservability
Enable Advanced Networking observability functionalities on clusters.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-EnableAdvancedNetworkingSecurity
Whether to allow user to configure network policy based on DNS (FQDN) names. It can be enabled only on cilium based clusters. If not specified, the default is false.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-EnableAHUB
Whether to enable Azure Hybrid User Benefits (AHUB) for Windows VMs.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-EnableAIToolchainOperator
Whether to enable AI toolchain operator to the cluster. Indicates if AI toolchain operator enabled or not.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-EnableApiServerAccessPrivateCluster
Whether to create the cluster as a private cluster or not.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-EnableApiServerAccessPrivateClusterPublicFQDN
Whether to create additional public FQDN for private cluster or not.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-EnableApiServerVnetIntegration
Whether to enable apiserver vnet integration for the cluster or not. See aka.ms/AksVnetIntegration for more details.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-EnableAzureKeyVaultKms
Whether to enable Azure Key Vault key management service.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-EnableBlobCSIDriver
Whether to to enable AzureBlob CSI Driver.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-EnableCostAnalysis
Whether to enable cost analysis. The Managed Cluster sku.tier must be set to 'Standard' or 'Premium' to enable this feature. Enabling this will add Kubernetes Namespace and Deployment details to the Cost Analysis views in the Azure portal. If not specified, the default is false. For more information see aka.ms/aks/docs/cost-analysis.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-EnableDefenderSecurityMonitoring
Whether to enable Defender threat detection
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-EnableDiskCSIDriver
Whether to enable AzureDisk CSI Driver.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-EnableFileCSIDriver
Whether to enable AzureFile CSI Driver.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-EnableImageCleaner
Whether to enable Image Cleaner on AKS cluster.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-EnableKEDA
Whether to enable KEDA.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-EnableManagedIdentity
Using a managed identity to manage cluster resource group.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-EnableMonitorMetric
Whether to enable or disable the Azure Managed Prometheus addon for Prometheus monitoring. See aka.ms/AzureManagedPrometheus-aks-enable for details on enabling and disabling.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-EnableNodeAutoScaling
Whether to enable auto-scaler
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-EnableOidcIssuer
Whether to enable OIDC issuer feature.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-EnablePodIdentity
Whether the pod identity addon is enabled.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-EnablePodIdentityWithKubenet
Whether pod identity is allowed to run on clusters with Kubenet networking. Running in Kubenet is disabled by default due to the security related nature of AAD Pod Identity and the risks of IP spoofing. See using Kubenet network plugin with AAD Pod Identity for more information.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-EnablePublicNetworkAccess
If enable publicNetworkAccess of the managedCluster
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-EnableSnapshotCSIDriver
Whether to enable Snapshot Controller.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-EnableStaticEgressGateway
Whether to enable Static Egress Gateway addon.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-EnableUptimeSLA
Whether to use use Uptime SLA.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-EnableVerticalPodAutoscaler
Whether to enable Vertical Pod Autoscaler.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-EnableWorkloadIdentity
Whether to enable workload identity.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-FqdnSubdomain
The FQDN subdomain of the private cluster with custom private dns zone.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-HttpProxy
The HTTP proxy server endpoint to use.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-HttpProxyConfigNoProxyEndpoint
The endpoints that should not go through proxy.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-HttpProxyConfigTrustedCa
Alternative CA cert to use for connecting to proxy servers.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-HttpsProxy
The HTTPS proxy server endpoint to use
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Id
Id of a managed Kubernetes cluster
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | ResourceId |
Parameter sets
-IfMatch
The request should only proceed if an entity matches this string.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-IfNoneMatch
The request should only proceed if no entity matches this string.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ImageCleanerIntervalHour
The image Cleaner scanning interval in hours.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-InputObject
A PSKubernetesCluster object, normally passed through the pipeline.
Parameter properties
| Type: | PSKubernetesCluster |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-IPFamily
the IP families used to specify IP versions available to the cluster. IP families are used to determine single-stack or dual-stack clusters. For single-stack, the expected value is IPv4. For dual-stack, the expected values are IPv4 and IPv6.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-KubernetesVersion
The version of Kubernetes to use for creating the cluster.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-LinuxProfileAdminUserName
User name for the Linux Virtual Machines.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AdminUserName |
Parameter sets
-LoadBalancerAllocatedOutboundPort
The desired number of allocated SNAT ports per VM.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-LoadBalancerBackendPoolType
The type of the managed inbound Load Balancer BackendPool.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-LoadBalancerIdleTimeoutInMinute
Desired outbound flow idle timeout in minutes.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-LoadBalancerManagedOutboundIpCount
Desired managed outbound IPs count for the cluster load balancer.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-LoadBalancerManagedOutboundIpCountIPv6
Desired number of IPv6 outbound IPs created/managed by Azure for the cluster load balancer.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-LoadBalancerOutboundIp
Desired outbound IP resources for the cluster load balancer.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-LoadBalancerOutboundIpPrefix
Desired outbound IP Prefix resources for the cluster load balancer.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Location
Azure location for the cluster. Defaults to the location of the resource group.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Name
Kubernetes managed cluster Name.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-NATGatewayIdleTimeoutInMinute
Desired outbound flow idle timeout in minutes for NAT Gateway.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-NATGatewayManagedOutboundIpCount
The desired number of outbound IPs created/managed by Azure.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-NetworkDataplane
The network dataplane used in the Kubernetes cluster.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-NetworkPluginMode
The mode the network plugin should use.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-NodeAutoUpgradeChannel
The upgrade channel for auto upgrade. For more information see https://learn.microsoft.com/azure/aks/upgrade-cluster#set-auto-upgrade-channel.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AutoUpgradeChannel |
Parameter sets
-NodeCount
The default number of nodes for the node pools.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-NodeImageOnly
Will only upgrade the node image of agent pools.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-NodeMaxCount
Maximum number of nodes for auto-scaling
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-NodeMinCount
Minimum number of nodes for auto-scaling.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-NodeName
Unique name of the agent pool profile in the context of the subscription and resource group.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-NodeOSAutoUpgradeChannel
The node OS Upgrade Channel. Manner in which the OS on your nodes is updated.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-NodeOsDiskSize
Specifies the size, in GB, of the operating system disk.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-NodePoolLabel
Node pool labels used for building Kubernetes network.
Parameter properties
| Type: | Hashtable |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-NodePoolMode
NodePoolMode represents mode of an node pool.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-NodePoolTag
The tags to be persisted on the agent pool virtual machine scale set.
Parameter properties
| Type: | Hashtable |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-NodeProvisioningDefaultPool
The set of default Karpenter NodePools (CRDs) configured for node provisioning. This field has no effect unless mode is 'Auto'. Warning: Changing this from Auto to None on an existing cluster will cause the default Karpenter NodePools to be deleted, which will drain and delete the nodes associated with those pools. It is strongly recommended to not do this unless there are idle nodes ready to take the pods evicted by that action. If not specified, the default is Auto. For more information see aka.ms/aks/nap#node-pools.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-NodeProvisioningMode
The node provisioning mode.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-NodeResourceGroupRestrictionLevel
The restriction level applied to the cluster node resource group.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-NodeTaint
The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-NodeVmSize
The size of the Virtual Machine.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-NodeWorkloadRuntime
The type of workload a node can run.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ResourceGroupName
Resource Group Name.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ServicePrincipalIdAndSecret
The client id and client secret associated with the AAD application / service principal.
Parameter properties
| Type: | PSCredential |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-SshKeyValue
SSH key file value or key file path. Defaults to {HOME}/.ssh/id_rsa.pub.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | SshKeyPath |
Parameter sets
-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.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-SupportPlan
The support plan for the Managed Cluster.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Tag
Tags to be applied to the resource
Parameter properties
| Type: | Hashtable |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
-WindowsProfileAdminUserPassword
The administrator password to use for Windows VMs. Password requirement:At least one lower case, one upper case, one special character !@#$%^&*(), the minimum length is 12.
Parameter properties
| Type: | SecureString |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
PSKubernetesCluster
String
Outputs
PSKubernetesCluster
Azure PowerShell
Feedback
Was this page helpful?