Class ManagedClusterProperties
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionGet the aadProfile property: AADProfile specifies attributes for Azure Active Directory integration.Get the addonProfiles property: The profile of managed cluster add-on.Get the agentPoolProfiles property: The agent pool properties.Get the apiServerAccessProfile property: The access profile for managed cluster API server.Get the autoScalerProfile property: Parameters to be applied to the cluster-autoscaler when enabled.Get the autoUpgradeProfile property: The auto upgrade configuration.Get the azurePortalFqdn property: The special FQDN used by the Azure Portal to access the Managed Cluster.Get the currentKubernetesVersion property: The version of Kubernetes the Managed Cluster is running.Get the disableLocalAccounts property: If local accounts should be disabled on the Managed Cluster.Get the diskEncryptionSetId property: The Resource ID of the disk encryption set to use for enabling encryption at rest.Get the dnsPrefix property: The DNS prefix of the Managed Cluster.Get the enablePodSecurityPolicy property: (DEPRECATING) Whether to enable Kubernetes pod security policy (preview).Get the enableRbac property: Whether to enable Kubernetes Role-Based Access Control.fqdn()Get the fqdn property: The FQDN of the master pool.Get the fqdnSubdomain property: The FQDN subdomain of the private cluster with custom private dns zone.Get the httpProxyConfig property: Configurations for provisioning the cluster with HTTP proxy servers.Get the identityProfile property: Identities associated with the cluster.Get the kubernetesVersion property: The version of Kubernetes specified by the user.Get the linuxProfile property: The profile for Linux VMs in the Managed Cluster.Get the maxAgentPools property: The max number of agent pools for the managed cluster.Get the networkProfile property: The network configuration profile.Get the nodeResourceGroup property: The name of the resource group containing agent pool nodes.Get the podIdentityProfile property: The pod identity profile of the Managed Cluster.Get the powerState property: The Power State of the cluster.Get the privateFqdn property: The FQDN of private cluster.Get the privateLinkResources property: Private link resources associated with the cluster.Get the provisioningState property: The current provisioning state.Get the publicNetworkAccess property: PublicNetworkAccess of the managedClusterGet the securityProfile property: Security profile for the managed cluster.Get the servicePrincipalProfile property: Information about a service principal identity for the cluster to use for manipulating Azure APIs.Get the storageProfile property: Storage profile for the managed cluster.voidvalidate()Validates the instance.Get the windowsProfile property: The profile for Windows VMs in the Managed Cluster.withAadProfile(ManagedClusterAadProfile aadProfile) Set the aadProfile property: AADProfile specifies attributes for Azure Active Directory integration.withAddonProfiles(Map<String, ManagedClusterAddonProfile> addonProfiles) Set the addonProfiles property: The profile of managed cluster add-on.withAgentPoolProfiles(List<ManagedClusterAgentPoolProfile> agentPoolProfiles) Set the agentPoolProfiles property: The agent pool properties.withApiServerAccessProfile(ManagedClusterApiServerAccessProfile apiServerAccessProfile) Set the apiServerAccessProfile property: The access profile for managed cluster API server.withAutoScalerProfile(ManagedClusterPropertiesAutoScalerProfile autoScalerProfile) Set the autoScalerProfile property: Parameters to be applied to the cluster-autoscaler when enabled.withAutoUpgradeProfile(ManagedClusterAutoUpgradeProfile autoUpgradeProfile) Set the autoUpgradeProfile property: The auto upgrade configuration.withDisableLocalAccounts(Boolean disableLocalAccounts) Set the disableLocalAccounts property: If local accounts should be disabled on the Managed Cluster.withDiskEncryptionSetId(String diskEncryptionSetId) Set the diskEncryptionSetId property: The Resource ID of the disk encryption set to use for enabling encryption at rest.withDnsPrefix(String dnsPrefix) Set the dnsPrefix property: The DNS prefix of the Managed Cluster.withEnablePodSecurityPolicy(Boolean enablePodSecurityPolicy) Set the enablePodSecurityPolicy property: (DEPRECATING) Whether to enable Kubernetes pod security policy (preview).withEnableRbac(Boolean enableRbac) Set the enableRbac property: Whether to enable Kubernetes Role-Based Access Control.withFqdnSubdomain(String fqdnSubdomain) Set the fqdnSubdomain property: The FQDN subdomain of the private cluster with custom private dns zone.withHttpProxyConfig(ManagedClusterHttpProxyConfig httpProxyConfig) Set the httpProxyConfig property: Configurations for provisioning the cluster with HTTP proxy servers.withIdentityProfile(Map<String, UserAssignedIdentity> identityProfile) Set the identityProfile property: Identities associated with the cluster.withKubernetesVersion(String kubernetesVersion) Set the kubernetesVersion property: The version of Kubernetes specified by the user.withLinuxProfile(ContainerServiceLinuxProfile linuxProfile) Set the linuxProfile property: The profile for Linux VMs in the Managed Cluster.withNetworkProfile(ContainerServiceNetworkProfile networkProfile) Set the networkProfile property: The network configuration profile.withNodeResourceGroup(String nodeResourceGroup) Set the nodeResourceGroup property: The name of the resource group containing agent pool nodes.withPodIdentityProfile(ManagedClusterPodIdentityProfile podIdentityProfile) Set the podIdentityProfile property: The pod identity profile of the Managed Cluster.withPrivateLinkResources(List<PrivateLinkResourceInner> privateLinkResources) Set the privateLinkResources property: Private link resources associated with the cluster.withPublicNetworkAccess(PublicNetworkAccess publicNetworkAccess) Set the publicNetworkAccess property: PublicNetworkAccess of the managedClusterwithSecurityProfile(ManagedClusterSecurityProfile securityProfile) Set the securityProfile property: Security profile for the managed cluster.withServicePrincipalProfile(ManagedClusterServicePrincipalProfile servicePrincipalProfile) Set the servicePrincipalProfile property: Information about a service principal identity for the cluster to use for manipulating Azure APIs.withStorageProfile(ManagedClusterStorageProfile storageProfile) Set the storageProfile property: Storage profile for the managed cluster.withWindowsProfile(ManagedClusterWindowsProfile windowsProfile) Set the windowsProfile property: The profile for Windows VMs in the Managed Cluster.
-
Constructor Details
-
ManagedClusterProperties
public ManagedClusterProperties()
-
-
Method Details
-
provisioningState
Get the provisioningState property: The current provisioning state.- Returns:
- the provisioningState value.
-
powerState
Get the powerState property: The Power State of the cluster.- Returns:
- the powerState value.
-
maxAgentPools
Get the maxAgentPools property: The max number of agent pools for the managed cluster.- Returns:
- the maxAgentPools value.
-
kubernetesVersion
Get the kubernetesVersion property: The version of Kubernetes specified by the user.Both patch version <major.minor.patch> (e.g. 1.20.13) and <major.minor> (e.g. 1.20) are supported. When <major.minor> is specified, the latest supported GA patch version is chosen automatically. Updating the cluster with the same <major.minor> once it has been created (e.g. 1.14.x -> 1.14) will not trigger an upgrade, even if a newer patch version is available. When you upgrade a supported AKS cluster, Kubernetes minor versions cannot be skipped. All upgrades must be performed sequentially by major version number. For example, upgrades between 1.14.x -> 1.15.x or 1.15.x -> 1.16.x are allowed, however 1.14.x -> 1.16.x is not allowed. See [upgrading an AKS cluster](https://docs.microsoft.com/azure/aks/upgrade-cluster) for more details.
- Returns:
- the kubernetesVersion value.
-
withKubernetesVersion
Set the kubernetesVersion property: The version of Kubernetes specified by the user.Both patch version <major.minor.patch> (e.g. 1.20.13) and <major.minor> (e.g. 1.20) are supported. When <major.minor> is specified, the latest supported GA patch version is chosen automatically. Updating the cluster with the same <major.minor> once it has been created (e.g. 1.14.x -> 1.14) will not trigger an upgrade, even if a newer patch version is available. When you upgrade a supported AKS cluster, Kubernetes minor versions cannot be skipped. All upgrades must be performed sequentially by major version number. For example, upgrades between 1.14.x -> 1.15.x or 1.15.x -> 1.16.x are allowed, however 1.14.x -> 1.16.x is not allowed. See [upgrading an AKS cluster](https://docs.microsoft.com/azure/aks/upgrade-cluster) for more details.
- Parameters:
kubernetesVersion- the kubernetesVersion value to set.- Returns:
- the ManagedClusterProperties object itself.
-
currentKubernetesVersion
Get the currentKubernetesVersion property: The version of Kubernetes the Managed Cluster is running.If kubernetesVersion was a fully specified version <major.minor.patch>, this field will be exactly equal to it. If kubernetesVersion was <major.minor>, this field will contain the full <major.minor.patch> version being used.
- Returns:
- the currentKubernetesVersion value.
-
dnsPrefix
Get the dnsPrefix property: The DNS prefix of the Managed Cluster.This cannot be updated once the Managed Cluster has been created.
- Returns:
- the dnsPrefix value.
-
withDnsPrefix
Set the dnsPrefix property: The DNS prefix of the Managed Cluster.This cannot be updated once the Managed Cluster has been created.
- Parameters:
dnsPrefix- the dnsPrefix value to set.- Returns:
- the ManagedClusterProperties object itself.
-
fqdnSubdomain
Get the fqdnSubdomain property: The FQDN subdomain of the private cluster with custom private dns zone.This cannot be updated once the Managed Cluster has been created.
- Returns:
- the fqdnSubdomain value.
-
withFqdnSubdomain
Set the fqdnSubdomain property: The FQDN subdomain of the private cluster with custom private dns zone.This cannot be updated once the Managed Cluster has been created.
- Parameters:
fqdnSubdomain- the fqdnSubdomain value to set.- Returns:
- the ManagedClusterProperties object itself.
-
fqdn
Get the fqdn property: The FQDN of the master pool.- Returns:
- the fqdn value.
-
privateFqdn
Get the privateFqdn property: The FQDN of private cluster.- Returns:
- the privateFqdn value.
-
azurePortalFqdn
Get the azurePortalFqdn property: The special FQDN used by the Azure Portal to access the Managed Cluster. This FQDN is for use only by the Azure Portal and should not be used by other clients.The Azure Portal requires certain Cross-Origin Resource Sharing (CORS) headers to be sent in some responses, which Kubernetes APIServer doesn't handle by default. This special FQDN supports CORS, allowing the Azure Portal to function properly.
- Returns:
- the azurePortalFqdn value.
-
agentPoolProfiles
Get the agentPoolProfiles property: The agent pool properties.- Returns:
- the agentPoolProfiles value.
-
withAgentPoolProfiles
public ManagedClusterProperties withAgentPoolProfiles(List<ManagedClusterAgentPoolProfile> agentPoolProfiles) Set the agentPoolProfiles property: The agent pool properties.- Parameters:
agentPoolProfiles- the agentPoolProfiles value to set.- Returns:
- the ManagedClusterProperties object itself.
-
linuxProfile
Get the linuxProfile property: The profile for Linux VMs in the Managed Cluster.- Returns:
- the linuxProfile value.
-
withLinuxProfile
Set the linuxProfile property: The profile for Linux VMs in the Managed Cluster.- Parameters:
linuxProfile- the linuxProfile value to set.- Returns:
- the ManagedClusterProperties object itself.
-
windowsProfile
Get the windowsProfile property: The profile for Windows VMs in the Managed Cluster.- Returns:
- the windowsProfile value.
-
withWindowsProfile
Set the windowsProfile property: The profile for Windows VMs in the Managed Cluster.- Parameters:
windowsProfile- the windowsProfile value to set.- Returns:
- the ManagedClusterProperties object itself.
-
servicePrincipalProfile
Get the servicePrincipalProfile property: Information about a service principal identity for the cluster to use for manipulating Azure APIs.- Returns:
- the servicePrincipalProfile value.
-
withServicePrincipalProfile
public ManagedClusterProperties withServicePrincipalProfile(ManagedClusterServicePrincipalProfile servicePrincipalProfile) Set the servicePrincipalProfile property: Information about a service principal identity for the cluster to use for manipulating Azure APIs.- Parameters:
servicePrincipalProfile- the servicePrincipalProfile value to set.- Returns:
- the ManagedClusterProperties object itself.
-
addonProfiles
Get the addonProfiles property: The profile of managed cluster add-on.- Returns:
- the addonProfiles value.
-
withAddonProfiles
public ManagedClusterProperties withAddonProfiles(Map<String, ManagedClusterAddonProfile> addonProfiles) Set the addonProfiles property: The profile of managed cluster add-on.- Parameters:
addonProfiles- the addonProfiles value to set.- Returns:
- the ManagedClusterProperties object itself.
-
podIdentityProfile
Get the podIdentityProfile property: The pod identity profile of the Managed Cluster.See [use AAD pod identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity) for more details on AAD pod identity integration.
- Returns:
- the podIdentityProfile value.
-
withPodIdentityProfile
public ManagedClusterProperties withPodIdentityProfile(ManagedClusterPodIdentityProfile podIdentityProfile) Set the podIdentityProfile property: The pod identity profile of the Managed Cluster.See [use AAD pod identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity) for more details on AAD pod identity integration.
- Parameters:
podIdentityProfile- the podIdentityProfile value to set.- Returns:
- the ManagedClusterProperties object itself.
-
nodeResourceGroup
Get the nodeResourceGroup property: The name of the resource group containing agent pool nodes.- Returns:
- the nodeResourceGroup value.
-
withNodeResourceGroup
Set the nodeResourceGroup property: The name of the resource group containing agent pool nodes.- Parameters:
nodeResourceGroup- the nodeResourceGroup value to set.- Returns:
- the ManagedClusterProperties object itself.
-
enableRbac
Get the enableRbac property: Whether to enable Kubernetes Role-Based Access Control.- Returns:
- the enableRbac value.
-
withEnableRbac
Set the enableRbac property: Whether to enable Kubernetes Role-Based Access Control.- Parameters:
enableRbac- the enableRbac value to set.- Returns:
- the ManagedClusterProperties object itself.
-
enablePodSecurityPolicy
Get the enablePodSecurityPolicy property: (DEPRECATING) Whether to enable Kubernetes pod security policy (preview). This feature is set for removal on October 15th, 2020. Learn more at aka.ms/aks/azpodpolicy.- Returns:
- the enablePodSecurityPolicy value.
-
withEnablePodSecurityPolicy
Set the enablePodSecurityPolicy property: (DEPRECATING) Whether to enable Kubernetes pod security policy (preview). This feature is set for removal on October 15th, 2020. Learn more at aka.ms/aks/azpodpolicy.- Parameters:
enablePodSecurityPolicy- the enablePodSecurityPolicy value to set.- Returns:
- the ManagedClusterProperties object itself.
-
networkProfile
Get the networkProfile property: The network configuration profile.- Returns:
- the networkProfile value.
-
withNetworkProfile
Set the networkProfile property: The network configuration profile.- Parameters:
networkProfile- the networkProfile value to set.- Returns:
- the ManagedClusterProperties object itself.
-
aadProfile
Get the aadProfile property: AADProfile specifies attributes for Azure Active Directory integration.The Azure Active Directory configuration.
- Returns:
- the aadProfile value.
-
withAadProfile
Set the aadProfile property: AADProfile specifies attributes for Azure Active Directory integration.The Azure Active Directory configuration.
- Parameters:
aadProfile- the aadProfile value to set.- Returns:
- the ManagedClusterProperties object itself.
-
autoUpgradeProfile
Get the autoUpgradeProfile property: The auto upgrade configuration.- Returns:
- the autoUpgradeProfile value.
-
withAutoUpgradeProfile
public ManagedClusterProperties withAutoUpgradeProfile(ManagedClusterAutoUpgradeProfile autoUpgradeProfile) Set the autoUpgradeProfile property: The auto upgrade configuration.- Parameters:
autoUpgradeProfile- the autoUpgradeProfile value to set.- Returns:
- the ManagedClusterProperties object itself.
-
autoScalerProfile
Get the autoScalerProfile property: Parameters to be applied to the cluster-autoscaler when enabled.- Returns:
- the autoScalerProfile value.
-
withAutoScalerProfile
public ManagedClusterProperties withAutoScalerProfile(ManagedClusterPropertiesAutoScalerProfile autoScalerProfile) Set the autoScalerProfile property: Parameters to be applied to the cluster-autoscaler when enabled.- Parameters:
autoScalerProfile- the autoScalerProfile value to set.- Returns:
- the ManagedClusterProperties object itself.
-
apiServerAccessProfile
Get the apiServerAccessProfile property: The access profile for managed cluster API server.- Returns:
- the apiServerAccessProfile value.
-
withApiServerAccessProfile
public ManagedClusterProperties withApiServerAccessProfile(ManagedClusterApiServerAccessProfile apiServerAccessProfile) Set the apiServerAccessProfile property: The access profile for managed cluster API server.- Parameters:
apiServerAccessProfile- the apiServerAccessProfile value to set.- Returns:
- the ManagedClusterProperties object itself.
-
diskEncryptionSetId
Get the diskEncryptionSetId property: The Resource ID of the disk encryption set to use for enabling encryption at rest.This is of the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}'.
- Returns:
- the diskEncryptionSetId value.
-
withDiskEncryptionSetId
Set the diskEncryptionSetId property: The Resource ID of the disk encryption set to use for enabling encryption at rest.This is of the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}'.
- Parameters:
diskEncryptionSetId- the diskEncryptionSetId value to set.- Returns:
- the ManagedClusterProperties object itself.
-
identityProfile
Get the identityProfile property: Identities associated with the cluster.- Returns:
- the identityProfile value.
-
withIdentityProfile
public ManagedClusterProperties withIdentityProfile(Map<String, UserAssignedIdentity> identityProfile) Set the identityProfile property: Identities associated with the cluster.- Parameters:
identityProfile- the identityProfile value to set.- Returns:
- the ManagedClusterProperties object itself.
-
privateLinkResources
Get the privateLinkResources property: Private link resources associated with the cluster.- Returns:
- the privateLinkResources value.
-
withPrivateLinkResources
public ManagedClusterProperties withPrivateLinkResources(List<PrivateLinkResourceInner> privateLinkResources) Set the privateLinkResources property: Private link resources associated with the cluster.- Parameters:
privateLinkResources- the privateLinkResources value to set.- Returns:
- the ManagedClusterProperties object itself.
-
disableLocalAccounts
Get the disableLocalAccounts property: If local accounts should be disabled on the Managed Cluster.If set to true, getting static credentials will be disabled for this cluster. This must only be used on Managed Clusters that are AAD enabled. For more details see [disable local accounts](https://docs.microsoft.com/azure/aks/managed-aad#disable-local-accounts-preview).
- Returns:
- the disableLocalAccounts value.
-
withDisableLocalAccounts
Set the disableLocalAccounts property: If local accounts should be disabled on the Managed Cluster.If set to true, getting static credentials will be disabled for this cluster. This must only be used on Managed Clusters that are AAD enabled. For more details see [disable local accounts](https://docs.microsoft.com/azure/aks/managed-aad#disable-local-accounts-preview).
- Parameters:
disableLocalAccounts- the disableLocalAccounts value to set.- Returns:
- the ManagedClusterProperties object itself.
-
httpProxyConfig
Get the httpProxyConfig property: Configurations for provisioning the cluster with HTTP proxy servers.- Returns:
- the httpProxyConfig value.
-
withHttpProxyConfig
Set the httpProxyConfig property: Configurations for provisioning the cluster with HTTP proxy servers.- Parameters:
httpProxyConfig- the httpProxyConfig value to set.- Returns:
- the ManagedClusterProperties object itself.
-
securityProfile
Get the securityProfile property: Security profile for the managed cluster.- Returns:
- the securityProfile value.
-
withSecurityProfile
Set the securityProfile property: Security profile for the managed cluster.- Parameters:
securityProfile- the securityProfile value to set.- Returns:
- the ManagedClusterProperties object itself.
-
storageProfile
Get the storageProfile property: Storage profile for the managed cluster.- Returns:
- the storageProfile value.
-
withStorageProfile
Set the storageProfile property: Storage profile for the managed cluster.- Parameters:
storageProfile- the storageProfile value to set.- Returns:
- the ManagedClusterProperties object itself.
-
publicNetworkAccess
Get the publicNetworkAccess property: PublicNetworkAccess of the managedClusterAllow or deny public network access for AKS.
- Returns:
- the publicNetworkAccess value.
-
withPublicNetworkAccess
Set the publicNetworkAccess property: PublicNetworkAccess of the managedClusterAllow or deny public network access for AKS.
- Parameters:
publicNetworkAccess- the publicNetworkAccess value to set.- Returns:
- the ManagedClusterProperties object itself.
-
validate
public void validate()Validates the instance.- Throws:
IllegalArgumentException- thrown if the instance is not valid.
-