ContainerServiceManagedCluster Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
ContainerServiceManagedCluster.
public class ContainerServiceManagedCluster : Azure.Provisioning.Primitives.ProvisionableResource
type ContainerServiceManagedCluster = class
inherit ProvisionableResource
Public Class ContainerServiceManagedCluster
Inherits ProvisionableResource
- Inheritance
-
ContainerServiceManagedCluster
Constructors
ContainerServiceManagedCluster(String, String) |
Creates a new ContainerServiceManagedCluster. |
Properties
AadProfile |
The Azure Active Directory configuration. |
AddonProfiles |
The profile of managed cluster add-on. |
AgentPoolProfiles |
The agent pool properties. |
ApiServerAccessProfile |
The access profile for managed cluster API server. |
AutoScalerProfile |
Parameters to be applied to the cluster-autoscaler when enabled. |
AutoUpgradeProfile |
The auto upgrade configuration. |
AzureMonitorMetrics |
Metrics profile for the Azure Monitor managed service for Prometheus addon. Collect out-of-the-box Kubernetes infrastructure metrics to send to an Azure Monitor Workspace and configure additional scraping for custom targets. See aka.ms/AzureManagedPrometheus for an overview. |
AzurePortalFqdn |
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. |
BicepIdentifier |
Gets or sets the the Bicep identifier name of the resource. This can be used to refer to the resource in expressions, but is not the Azure name of the resource. This value can contain letters, numbers, and underscores. (Inherited from NamedProvisionableConstruct) |
ClusterIdentity |
The identity of the managed cluster, if configured. |
CurrentKubernetesVersion |
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. |
DependsOn |
Declares explicit dependencies on other resources. (Inherited from ProvisionableResource) |
DisableLocalAccounts |
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 |
This is of the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}'. |
DnsPrefix |
This cannot be updated once the Managed Cluster has been created. |
EnablePodSecurityPolicy |
(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 |
Whether to enable Kubernetes Role-Based Access Control. |
ExtendedLocation |
The extended location of the Virtual Machine. |
Fqdn |
The FQDN of the master pool. |
FqdnSubdomain |
This cannot be updated once the Managed Cluster has been created. |
HttpProxyConfig |
Configurations for provisioning the cluster with HTTP proxy servers. |
Id |
Gets the Id. |
IdentityProfile |
Identities associated with the cluster. |
IsExistingResource |
Gets whether this is referencing an existing resource or we're defining a new resource. (Inherited from ProvisionableResource) |
KubernetesVersion |
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 |
The profile for Linux VMs in the Managed Cluster. |
Location |
Gets or sets the Location. |
MaxAgentPools |
The max number of agent pools for the managed cluster. |
Name |
The name of the managed cluster resource. |
NetworkProfile |
The network configuration profile. |
NodeResourceGroup |
The name of the resource group containing agent pool nodes. |
OidcIssuerProfile |
The OIDC issuer profile of the Managed Cluster. |
PodIdentityProfile |
See use AAD pod identity for more details on AAD pod identity integration. |
PowerStateCode |
Tells whether the cluster is Running or Stopped. |
PrivateFqdn |
The FQDN of private cluster. |
PrivateLinkResources |
Private link resources associated with the cluster. |
ProvisioningState |
The current provisioning state. |
PublicNetworkAccess |
Allow or deny public network access for AKS. |
ResourceId |
The resourceUID uniquely identifies ManagedClusters that reuse ARM ResourceIds (i.e: create, delete, create sequence). |
ResourceType |
Gets the type of the resource. (Inherited from ProvisionableResource) |
ResourceVersion |
Gets or sets the version of the resource. (Inherited from ProvisionableResource) |
SecurityProfile |
Security profile for the managed cluster. |
ServiceMeshProfile |
Service mesh profile for a managed cluster. |
ServicePrincipalProfile |
Information about a service principal identity for the cluster to use for manipulating Azure APIs. |
Sku |
The managed cluster SKU. |
StorageProfile |
Storage profile for the managed cluster. |
SupportPlan |
The support plan for the Managed Cluster. If unspecified, the default is 'KubernetesOfficial'. |
SystemData |
Gets the SystemData. |
Tags |
Gets or sets the Tags. |
UpgradeOverrideSettings |
Settings for overrides. |
WindowsProfile |
The profile for Windows VMs in the Managed Cluster. |
WorkloadAutoScalerProfile |
Workload Auto-scaler profile for the managed cluster. |
Methods
AssignOrReplace<T>(T, T) | (Inherited from ProvisionableConstruct) |
Build(ProvisioningBuildOptions) |
Compose the resource into a provisioning plan that can be saved as Bicep or deployed directly. (Inherited from ProvisionableResource) |
Compile() |
Compile the resource into a set of Bicep statements. (Inherited from ProvisionableResource) |
CreateRoleAssignment(ContainerServiceBuiltInRole, BicepValue<RoleManagementPrincipalType>, BicepValue<Guid>, String) |
Creates a role assignment for a principal that grants access to this ContainerServiceManagedCluster. |
CreateRoleAssignment(ContainerServiceBuiltInRole, UserAssignedIdentity) |
Creates a role assignment for a user-assigned identity that grants access to this ContainerServiceManagedCluster. |
DefineDictionaryProperty<T>(String, String[], Boolean, Boolean) | (Inherited from ProvisionableConstruct) |
DefineListProperty<T>(String, String[], Boolean, Boolean) | (Inherited from ProvisionableConstruct) |
DefineModelProperty<T>(String, String[], Boolean, Boolean, Boolean, String) | (Inherited from ProvisionableConstruct) |
DefineProperty<T>(String, String[], Boolean, Boolean, Boolean, BicepValue<T>, String) | (Inherited from ProvisionableConstruct) |
DefineProvisionableProperties() |
Define all the provisionable properties of ContainerServiceManagedCluster. |
DefineResource<T>(String, String[], Boolean, Boolean, T) | (Inherited from ProvisionableResource) |
FromExisting(String, String) |
Creates a reference to an existing ContainerServiceManagedCluster. |
GetProvisionableResources() |
Get any resources represented by this object. This will typically only be the object itself for everything but Infrastructure. (Inherited from Provisionable) |
GetResources() |
Get any resources represented by this object. This will typically only be the object itself for everything but Infrastructure. (Inherited from Provisionable) |
Initialize() |
Initialize this construct. (Inherited from ProvisionableConstruct) |
OverrideWithExpression(BicepExpression) | (Inherited from ProvisionableConstruct) |
Resolve(ProvisioningBuildOptions) |
Resolve any resources or properties that were not explicitly specified. (Inherited from ProvisionableConstruct) |
Resolve(ProvisioningContext) |
Resolve any resources or properties that were not explicitly specified. (Inherited from Provisionable) |
Validate(ProvisioningBuildOptions) |
Validate the presence of any required members. (Inherited from ProvisionableResource) |
Validate(ProvisioningContext) |
Validate the presence of any required members. (Inherited from Provisionable) |