ManagedCluster Class

Definition

Managed cluster.

[Microsoft.Rest.Serialization.JsonTransformation]
public class ManagedCluster : Microsoft.Azure.Management.ContainerService.Models.TrackedResource
[<Microsoft.Rest.Serialization.JsonTransformation>]
type ManagedCluster = class
    inherit TrackedResource
Public Class ManagedCluster
Inherits TrackedResource
Inheritance
Attributes

Constructors

Name Description
ManagedCluster()

Initializes a new instance of the ManagedCluster class.

ManagedCluster(String, String, String, String, SystemData, IDictionary<String, String>, ManagedClusterSKU, ExtendedLocation, ManagedClusterIdentity, PowerState, String, Nullable<Int32>, String, String, String, String, String, String, String, IList<ManagedClusterAgentPoolProfile>, ContainerServiceLinuxProfile, ManagedClusterWindowsProfile, ManagedClusterServicePrincipalProfile, IDictionary<String,ManagedClusterAddonProfile>, ManagedClusterPodIdentityProfile, ManagedClusterOidcIssuerProfile, String, Nullable<Boolean>, String, Nullable<Boolean>, ContainerServiceNetworkProfile, ManagedClusterAADProfile, ManagedClusterAutoUpgradeProfile, ManagedClusterPropertiesAutoScalerProfile, ManagedClusterAPIServerAccessProfile, String, IDictionary<String, UserAssignedIdentity>, IList<PrivateLinkResource>, Nullable<Boolean>, ManagedClusterHttpProxyConfig, ManagedClusterSecurityProfile, ManagedClusterStorageProfile, String, ManagedClusterWorkloadAutoScalerProfile, ManagedClusterAzureMonitorProfile)

Initializes a new instance of the ManagedCluster class.

ManagedCluster(String, String, String, String, SystemData, IDictionary<String, String>, String, ManagedClusterSKU, ExtendedLocation, ManagedClusterIdentity, String, PowerState, String, Nullable<Int32>, String, String, String, String, String, String, String, IList<ManagedClusterAgentPoolProfile>, ContainerServiceLinuxProfile, ManagedClusterWindowsProfile, ManagedClusterServicePrincipalProfile, IDictionary<String,ManagedClusterAddonProfile>, ManagedClusterPodIdentityProfile, ManagedClusterOidcIssuerProfile, String, ManagedClusterNodeResourceGroupProfile, Nullable<Boolean>, String, ContainerServiceNetworkProfile, ManagedClusterAADProfile, ManagedClusterAutoUpgradeProfile, ClusterUpgradeSettings, ManagedClusterPropertiesAutoScalerProfile, ManagedClusterAPIServerAccessProfile, String, IDictionary<String, UserAssignedIdentity>, IList<PrivateLinkResource>, Nullable<Boolean>, ManagedClusterHttpProxyConfig, ManagedClusterSecurityProfile, ManagedClusterStorageProfile, ManagedClusterIngressProfile, String, ManagedClusterWorkloadAutoScalerProfile, ManagedClusterAzureMonitorProfile, ServiceMeshProfile, String, ManagedClusterMetricsProfile, ManagedClusterNodeProvisioningProfile, ManagedClusterBootstrapProfile, ManagedClusterAIToolchainOperatorProfile, ManagedClusterStatus)

Initializes a new instance of the ManagedCluster class.

Properties

Name Description
AadProfile

Gets or sets the Azure Active Directory configuration.

AddonProfiles

Gets or sets the profile of managed cluster add-on.

AgentPoolProfiles

Gets or sets the agent pool properties.

AiToolchainOperatorProfile

Gets or sets aI toolchain operator settings that apply to the whole cluster.

ApiServerAccessProfile

Gets or sets the access profile for managed cluster API server.

AutoScalerProfile

Gets or sets parameters to be applied to the cluster-autoscaler when enabled

AutoUpgradeProfile

Gets or sets the auto upgrade configuration.

AzureMonitorProfile

Gets or sets azure Monitor addon profiles for monitoring the managed cluster.

AzurePortalFqdn

Gets 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.

BootstrapProfile

Gets or sets profile of the cluster bootstrap configuration.

CurrentKubernetesVersion

Gets 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.

DisableLocalAccounts

Gets or sets 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.

DiskEncryptionSetId

Gets or sets 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}'

DnsPrefix

Gets or sets the DNS prefix of the Managed Cluster. This cannot be updated once the Managed Cluster has been created.

EnablePodSecurityPolicy

Gets or sets (DEPRECATED) Whether to enable Kubernetes pod security policy (preview). PodSecurityPolicy was deprecated in Kubernetes v1.21, and removed from Kubernetes in v1.25. Learn more at https://aka.ms/k8s/psp and https://aka.ms/aks/psp.

EnableRbac

Gets or sets whether to enable Kubernetes Role-Based Access Control.

ETag

Gets unique read-only string used to implement optimistic concurrency. The eTag value will change when the resource is updated. Specify an if-match or if-none-match header with the eTag value for a subsequent request to enable optimistic concurrency per the normal etag convention.

ExtendedLocation

Gets or sets the extended location of the Virtual Machine.

Fqdn

Gets the FQDN of the master pool.

FqdnSubdomain

Gets or sets the FQDN subdomain of the private cluster with custom private dns zone. This cannot be updated once the Managed Cluster has been created.

HttpProxyConfig

Gets or sets configurations for provisioning the cluster with HTTP proxy servers.

Id

Gets fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

(Inherited from Resource)
Identity

Gets or sets the identity of the managed cluster, if configured.

IdentityProfile

Gets or sets the user identity associated with the managed cluster. This identity will be used by the kubelet. Only one user assigned identity is allowed. The only accepted key is "kubeletidentity", with value of "resourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

IngressProfile

Gets or sets ingress profile for the managed cluster.

Kind

Gets or sets this is primarily used to expose different UI experiences in the portal for different kinds

KubernetesVersion

Gets or sets 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 for more details.

LinuxProfile

Gets or sets the profile for Linux VMs in the Managed Cluster.

Location

Gets or sets the geo-location where the resource lives

(Inherited from TrackedResource)
MaxAgentPools

Gets the max number of agent pools for the managed cluster.

MetricsProfile

Gets or sets optional cluster metrics configuration.

Name

Gets the name of the resource

(Inherited from Resource)
NetworkProfile

Gets or sets the network configuration profile.

NodeProvisioningProfile

Gets or sets node provisioning settings that apply to the whole cluster.

NodeResourceGroup

Gets or sets the name of the resource group containing agent pool nodes.

NodeResourceGroupProfile

Gets or sets profile of the node resource group configuration.

OidcIssuerProfile

Gets or sets the OIDC issuer profile of the Managed Cluster.

PodIdentityProfile

Gets or sets the pod identity profile of the Managed Cluster. See use AAD pod identity for more details on AAD pod identity integration.

PowerState

Gets the Power State of the cluster.

PrivateFqdn

Gets the FQDN of private cluster.

PrivateLinkResources

Gets or sets private link resources associated with the cluster.

ProvisioningState

Gets the current provisioning state.

PublicNetworkAccess

Gets or sets publicNetworkAccess of the managedCluster. Allow or deny public network access for AKS Possible values include: 'Enabled', 'Disabled'

ResourceUid

Gets the resourceUID uniquely identifies ManagedClusters that reuse ARM ResourceIds (i.e: create, delete, create sequence)

SecurityProfile

Gets or sets security profile for the managed cluster.

ServiceMeshProfile

Gets or sets service mesh profile for a managed cluster.

ServicePrincipalProfile

Gets or sets information about a service principal identity for the cluster to use for manipulating Azure APIs.

Sku

Gets or sets the managed cluster SKU.

Status

Gets or sets contains read-only information about the Managed Cluster.

StorageProfile

Gets or sets storage profile for the managed cluster.

SupportPlan

Gets or sets the support plan for the Managed Cluster. If unspecified, the default is 'KubernetesOfficial'. Possible values include: 'KubernetesOfficial', 'AKSLongTermSupport'

SystemData

Gets azure Resource Manager metadata containing createdBy and modifiedBy information.

(Inherited from Resource)
Tags

Gets or sets resource tags.

(Inherited from TrackedResource)
Type

Gets the type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

(Inherited from Resource)
UpgradeSettings

Gets or sets settings for upgrading a cluster.

WindowsProfile

Gets or sets the profile for Windows VMs in the Managed Cluster.

WorkloadAutoScalerProfile

Gets or sets workload Auto-scaler profile for the managed cluster.

Methods

Name Description
Validate()

Validate the object.

Applies to