ArmContainerServiceModelFactory.ContainerServiceManagedClusterData Method
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.
public static Azure.ResourceManager.ContainerService.ContainerServiceManagedClusterData ContainerServiceManagedClusterData(Azure.Core.ResourceIdentifier id = default, string name = default, Azure.Core.ResourceType resourceType = default, Azure.ResourceManager.Models.SystemData systemData = default, System.Collections.Generic.IDictionary<string,string> tags = default, Azure.Core.AzureLocation location = default, string provisioningState = default, int? maxAgentPools = default, string kubernetesVersion = default, string currentKubernetesVersion = default, string dnsPrefix = default, string fqdnSubdomain = default, string fqdn = default, string privateFqdn = default, string azurePortalFqdn = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.ContainerService.Models.ManagedClusterAgentPoolProfile> agentPoolProfiles = default, Azure.ResourceManager.ContainerService.Models.ContainerServiceLinuxProfile linuxProfile = default, Azure.ResourceManager.ContainerService.Models.ManagedClusterWindowsProfile windowsProfile = default, Azure.ResourceManager.ContainerService.Models.ManagedClusterServicePrincipalProfile servicePrincipalProfile = default, System.Collections.Generic.IDictionary<string,Azure.ResourceManager.ContainerService.Models.ManagedClusterAddonProfile> addonProfiles = default, Azure.ResourceManager.ContainerService.Models.ManagedClusterPodIdentityProfile podIdentityProfile = default, Azure.ResourceManager.ContainerService.Models.ManagedClusterOidcIssuerProfile oidcIssuerProfile = default, string nodeResourceGroup = default, bool? isRbacEnabled = default, Azure.ResourceManager.ContainerService.Models.KubernetesSupportPlan? supportPlan = default, bool? isNamespaceResourcesEnabled = default, Azure.ResourceManager.ContainerService.Models.ContainerServiceNetworkProfile networkProfile = default, Azure.ResourceManager.ContainerService.Models.ManagedClusterAadProfile aadProfile = default, Azure.ResourceManager.ContainerService.Models.ManagedClusterAutoUpgradeProfile autoUpgradeProfile = default, Azure.ResourceManager.ContainerService.Models.ManagedClusterAutoScalerProfile autoScalerProfile = default, Azure.ResourceManager.ContainerService.Models.ManagedClusterApiServerAccessProfile apiServerAccessProfile = default, Azure.Core.ResourceIdentifier diskEncryptionSetId = default, System.Collections.Generic.IDictionary<string,Azure.ResourceManager.ContainerService.Models.ContainerServiceUserAssignedIdentity> identityProfile = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.ContainerService.Models.ContainerServicePrivateLinkResourceData> privateLinkResources = default, bool? isLocalAccountsDisabled = default, Azure.ResourceManager.ContainerService.Models.ManagedClusterHttpProxyConfig httpProxyConfig = default, Azure.ResourceManager.ContainerService.Models.ManagedClusterSecurityProfile securityProfile = default, Azure.ResourceManager.ContainerService.Models.ManagedClusterStorageProfile storageProfile = default, Azure.ResourceManager.ContainerService.Models.ManagedClusterIngressProfile ingressProfile = default, Azure.ResourceManager.ContainerService.Models.ContainerServicePublicNetworkAccess? publicNetworkAccess = default, Azure.ResourceManager.ContainerService.Models.ManagedClusterWorkloadAutoScalerProfile workloadAutoScalerProfile = default, Azure.ResourceManager.ContainerService.Models.ManagedClusterAzureMonitorProfile azureMonitorProfile = default, Azure.ResourceManager.ContainerService.Models.ServiceMeshProfile serviceMeshProfile = default, Azure.Core.ResourceIdentifier resourceId = default, Azure.ResourceManager.ContainerService.Models.ManagedClusterNodeProvisioningProfile nodeProvisioningProfile = default, Azure.ResourceManager.ContainerService.Models.ManagedClusterBootstrapProfile bootstrapProfile = default, Azure.ResourceManager.ContainerService.Models.ManagedClusterHealthMonitorProfile healthMonitorProfile = default, Azure.ResourceManager.ContainerService.Models.ContainerServiceStateCode? powerStateCode = default, Azure.Core.ResourceIdentifier creationDataSourceResourceId = default, Azure.ResourceManager.ContainerService.Models.ManagedClusterNodeResourceGroupRestrictionLevel? nodeResourceGroupRestrictionLevel = default, Azure.ResourceManager.ContainerService.Models.UpgradeOverrideSettings upgradeOverrideSettings = default, bool? isCostAnalysisEnabled = default, bool? isAIToolchainOperatorEnabled = default, Azure.ResourceManager.ContainerService.Models.SchedulerConfigMode? upstreamSchedulerConfigMode = default, bool? isHostedSystemAddonsEnabled = default, Azure.ResponseError statusProvisioningError = default, Azure.ETag? etag = default, Azure.ResourceManager.ContainerService.Models.ManagedClusterSku sku = default, Azure.ResourceManager.Resources.Models.ExtendedLocation extendedLocation = default, Azure.ResourceManager.ContainerService.Models.ManagedClusterIdentity clusterIdentity = default, string kind = default);
static member ContainerServiceManagedClusterData : Azure.Core.ResourceIdentifier * string * Azure.Core.ResourceType * Azure.ResourceManager.Models.SystemData * System.Collections.Generic.IDictionary<string, string> * Azure.Core.AzureLocation * string * Nullable<int> * string * string * string * string * string * string * string * seq<Azure.ResourceManager.ContainerService.Models.ManagedClusterAgentPoolProfile> * Azure.ResourceManager.ContainerService.Models.ContainerServiceLinuxProfile * Azure.ResourceManager.ContainerService.Models.ManagedClusterWindowsProfile * Azure.ResourceManager.ContainerService.Models.ManagedClusterServicePrincipalProfile * System.Collections.Generic.IDictionary<string, Azure.ResourceManager.ContainerService.Models.ManagedClusterAddonProfile> * Azure.ResourceManager.ContainerService.Models.ManagedClusterPodIdentityProfile * Azure.ResourceManager.ContainerService.Models.ManagedClusterOidcIssuerProfile * string * Nullable<bool> * Nullable<Azure.ResourceManager.ContainerService.Models.KubernetesSupportPlan> * Nullable<bool> * Azure.ResourceManager.ContainerService.Models.ContainerServiceNetworkProfile * Azure.ResourceManager.ContainerService.Models.ManagedClusterAadProfile * Azure.ResourceManager.ContainerService.Models.ManagedClusterAutoUpgradeProfile * Azure.ResourceManager.ContainerService.Models.ManagedClusterAutoScalerProfile * Azure.ResourceManager.ContainerService.Models.ManagedClusterApiServerAccessProfile * Azure.Core.ResourceIdentifier * System.Collections.Generic.IDictionary<string, Azure.ResourceManager.ContainerService.Models.ContainerServiceUserAssignedIdentity> * seq<Azure.ResourceManager.ContainerService.Models.ContainerServicePrivateLinkResourceData> * Nullable<bool> * Azure.ResourceManager.ContainerService.Models.ManagedClusterHttpProxyConfig * Azure.ResourceManager.ContainerService.Models.ManagedClusterSecurityProfile * Azure.ResourceManager.ContainerService.Models.ManagedClusterStorageProfile * Azure.ResourceManager.ContainerService.Models.ManagedClusterIngressProfile * Nullable<Azure.ResourceManager.ContainerService.Models.ContainerServicePublicNetworkAccess> * Azure.ResourceManager.ContainerService.Models.ManagedClusterWorkloadAutoScalerProfile * Azure.ResourceManager.ContainerService.Models.ManagedClusterAzureMonitorProfile * Azure.ResourceManager.ContainerService.Models.ServiceMeshProfile * Azure.Core.ResourceIdentifier * Azure.ResourceManager.ContainerService.Models.ManagedClusterNodeProvisioningProfile * Azure.ResourceManager.ContainerService.Models.ManagedClusterBootstrapProfile * Azure.ResourceManager.ContainerService.Models.ManagedClusterHealthMonitorProfile * Nullable<Azure.ResourceManager.ContainerService.Models.ContainerServiceStateCode> * Azure.Core.ResourceIdentifier * Nullable<Azure.ResourceManager.ContainerService.Models.ManagedClusterNodeResourceGroupRestrictionLevel> * Azure.ResourceManager.ContainerService.Models.UpgradeOverrideSettings * Nullable<bool> * Nullable<bool> * Nullable<Azure.ResourceManager.ContainerService.Models.SchedulerConfigMode> * Nullable<bool> * Azure.ResponseError * Nullable<Azure.ETag> * Azure.ResourceManager.ContainerService.Models.ManagedClusterSku * Azure.ResourceManager.Resources.Models.ExtendedLocation * Azure.ResourceManager.ContainerService.Models.ManagedClusterIdentity * string -> Azure.ResourceManager.ContainerService.ContainerServiceManagedClusterData
Public Shared Function ContainerServiceManagedClusterData (Optional id As ResourceIdentifier = Nothing, Optional name As String = Nothing, Optional resourceType As ResourceType = Nothing, Optional systemData As SystemData = Nothing, Optional tags As IDictionary(Of String, String) = Nothing, Optional location As AzureLocation = Nothing, Optional provisioningState As String = Nothing, Optional maxAgentPools As Nullable(Of Integer) = Nothing, Optional kubernetesVersion As String = Nothing, Optional currentKubernetesVersion As String = Nothing, Optional dnsPrefix As String = Nothing, Optional fqdnSubdomain As String = Nothing, Optional fqdn As String = Nothing, Optional privateFqdn As String = Nothing, Optional azurePortalFqdn As String = Nothing, Optional agentPoolProfiles As IEnumerable(Of ManagedClusterAgentPoolProfile) = Nothing, Optional linuxProfile As ContainerServiceLinuxProfile = Nothing, Optional windowsProfile As ManagedClusterWindowsProfile = Nothing, Optional servicePrincipalProfile As ManagedClusterServicePrincipalProfile = Nothing, Optional addonProfiles As IDictionary(Of String, ManagedClusterAddonProfile) = Nothing, Optional podIdentityProfile As ManagedClusterPodIdentityProfile = Nothing, Optional oidcIssuerProfile As ManagedClusterOidcIssuerProfile = Nothing, Optional nodeResourceGroup As String = Nothing, Optional isRbacEnabled As Nullable(Of Boolean) = Nothing, Optional supportPlan As Nullable(Of KubernetesSupportPlan) = Nothing, Optional isNamespaceResourcesEnabled As Nullable(Of Boolean) = Nothing, Optional networkProfile As ContainerServiceNetworkProfile = Nothing, Optional aadProfile As ManagedClusterAadProfile = Nothing, Optional autoUpgradeProfile As ManagedClusterAutoUpgradeProfile = Nothing, Optional autoScalerProfile As ManagedClusterAutoScalerProfile = Nothing, Optional apiServerAccessProfile As ManagedClusterApiServerAccessProfile = Nothing, Optional diskEncryptionSetId As ResourceIdentifier = Nothing, Optional identityProfile As IDictionary(Of String, ContainerServiceUserAssignedIdentity) = Nothing, Optional privateLinkResources As IEnumerable(Of ContainerServicePrivateLinkResourceData) = Nothing, Optional isLocalAccountsDisabled As Nullable(Of Boolean) = Nothing, Optional httpProxyConfig As ManagedClusterHttpProxyConfig = Nothing, Optional securityProfile As ManagedClusterSecurityProfile = Nothing, Optional storageProfile As ManagedClusterStorageProfile = Nothing, Optional ingressProfile As ManagedClusterIngressProfile = Nothing, Optional publicNetworkAccess As Nullable(Of ContainerServicePublicNetworkAccess) = Nothing, Optional workloadAutoScalerProfile As ManagedClusterWorkloadAutoScalerProfile = Nothing, Optional azureMonitorProfile As ManagedClusterAzureMonitorProfile = Nothing, Optional serviceMeshProfile As ServiceMeshProfile = Nothing, Optional resourceId As ResourceIdentifier = Nothing, Optional nodeProvisioningProfile As ManagedClusterNodeProvisioningProfile = Nothing, Optional bootstrapProfile As ManagedClusterBootstrapProfile = Nothing, Optional healthMonitorProfile As ManagedClusterHealthMonitorProfile = Nothing, Optional powerStateCode As Nullable(Of ContainerServiceStateCode) = Nothing, Optional creationDataSourceResourceId As ResourceIdentifier = Nothing, Optional nodeResourceGroupRestrictionLevel As Nullable(Of ManagedClusterNodeResourceGroupRestrictionLevel) = Nothing, Optional upgradeOverrideSettings As UpgradeOverrideSettings = Nothing, Optional isCostAnalysisEnabled As Nullable(Of Boolean) = Nothing, Optional isAIToolchainOperatorEnabled As Nullable(Of Boolean) = Nothing, Optional upstreamSchedulerConfigMode As Nullable(Of SchedulerConfigMode) = Nothing, Optional isHostedSystemAddonsEnabled As Nullable(Of Boolean) = Nothing, Optional statusProvisioningError As ResponseError = Nothing, Optional etag As Nullable(Of ETag) = Nothing, Optional sku As ManagedClusterSku = Nothing, Optional extendedLocation As ExtendedLocation = Nothing, Optional clusterIdentity As ManagedClusterIdentity = Nothing, Optional kind As String = Nothing) As ContainerServiceManagedClusterData
Parameters
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
- name
- String
The name of the resource.
- resourceType
- ResourceType
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
- systemData
- SystemData
Azure Resource Manager metadata containing createdBy and modifiedBy information.
- tags
- IDictionary<String,String>
Resource tags.
- location
- AzureLocation
The geo-location where the resource lives.
- provisioningState
- String
The current provisioning state.
- kubernetesVersion
- String
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.
- currentKubernetesVersion
- String
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.
- dnsPrefix
- String
The DNS prefix of the Managed Cluster. This cannot be updated once the Managed Cluster has been created.
- fqdnSubdomain
- String
The FQDN subdomain of the private cluster with custom private dns zone. This cannot be updated once the Managed Cluster has been created.
- fqdn
- String
The FQDN of the master pool.
- privateFqdn
- String
The FQDN of private cluster.
- azurePortalFqdn
- String
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.
- agentPoolProfiles
- IEnumerable<ManagedClusterAgentPoolProfile>
The agent pool properties.
- linuxProfile
- ContainerServiceLinuxProfile
The profile for Linux VMs in the Managed Cluster.
- windowsProfile
- ManagedClusterWindowsProfile
The profile for Windows VMs in the Managed Cluster.
- servicePrincipalProfile
- ManagedClusterServicePrincipalProfile
Information about a service principal identity for the cluster to use for manipulating Azure APIs.
- addonProfiles
- IDictionary<String,ManagedClusterAddonProfile>
The profile of managed cluster add-on.
- podIdentityProfile
- ManagedClusterPodIdentityProfile
The pod identity profile of the Managed Cluster. See use AAD pod identity for more details on AAD pod identity integration.
- oidcIssuerProfile
- ManagedClusterOidcIssuerProfile
The OIDC issuer profile of the Managed Cluster.
- nodeResourceGroup
- String
The name of the resource group containing agent pool nodes.
- supportPlan
- Nullable<KubernetesSupportPlan>
The support plan for the Managed Cluster. If unspecified, the default is 'KubernetesOfficial'.
Enable namespace as Azure resource. The default value is false. It can be enabled/disabled on creation and updating of the managed cluster. See https://aka.ms/NamespaceARMResource for more details on Namespace as a ARM Resource.
- networkProfile
- ContainerServiceNetworkProfile
The network configuration profile.
- aadProfile
- ManagedClusterAadProfile
The Azure Active Directory configuration.
- autoUpgradeProfile
- ManagedClusterAutoUpgradeProfile
The auto upgrade configuration.
- autoScalerProfile
- ManagedClusterAutoScalerProfile
Parameters to be applied to the cluster-autoscaler when enabled.
- apiServerAccessProfile
- ManagedClusterApiServerAccessProfile
The access profile for managed cluster API server.
- diskEncryptionSetId
- ResourceIdentifier
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}'.
- identityProfile
- IDictionary<String,ContainerServiceUserAssignedIdentity>
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}".
- privateLinkResources
- IEnumerable<ContainerServicePrivateLinkResourceData>
Private link resources associated with the cluster.
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.
- httpProxyConfig
- ManagedClusterHttpProxyConfig
Configurations for provisioning the cluster with HTTP proxy servers.
- securityProfile
- ManagedClusterSecurityProfile
Security profile for the managed cluster.
- storageProfile
- ManagedClusterStorageProfile
Storage profile for the managed cluster.
- ingressProfile
- ManagedClusterIngressProfile
Ingress profile for the managed cluster.
- publicNetworkAccess
- Nullable<ContainerServicePublicNetworkAccess>
PublicNetworkAccess of the managedCluster. Allow or deny public network access for AKS.
- workloadAutoScalerProfile
- ManagedClusterWorkloadAutoScalerProfile
Workload Auto-scaler profile for the managed cluster.
- azureMonitorProfile
- ManagedClusterAzureMonitorProfile
Azure Monitor addon profiles for monitoring the managed cluster.
- serviceMeshProfile
- ServiceMeshProfile
Service mesh profile for a managed cluster.
- resourceId
- ResourceIdentifier
The resourceUID uniquely identifies ManagedClusters that reuse ARM ResourceIds (i.e: create, delete, create sequence).
- nodeProvisioningProfile
- ManagedClusterNodeProvisioningProfile
Node provisioning settings that apply to the whole cluster.
- bootstrapProfile
- ManagedClusterBootstrapProfile
Profile of the cluster bootstrap configuration.
- healthMonitorProfile
- ManagedClusterHealthMonitorProfile
Health monitor profile for the managed cluster.
- powerStateCode
- Nullable<ContainerServiceStateCode>
Tells whether the cluster is Running or Stopped.
- creationDataSourceResourceId
- ResourceIdentifier
This is the ARM ID of the source object to be used to create the target object.
- nodeResourceGroupRestrictionLevel
- Nullable<ManagedClusterNodeResourceGroupRestrictionLevel>
The restriction level applied to the cluster's node resource group. If not specified, the default is 'Unrestricted'.
- upgradeOverrideSettings
- UpgradeOverrideSettings
Settings for overrides.
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.
Whether to enable AI toolchain operator to the cluster. Indicates if AI toolchain operator enabled or not.
- upstreamSchedulerConfigMode
- Nullable<SchedulerConfigMode>
The config customization mode for this scheduler instance.
Whether to enable hosted system addons for the cluster.
- statusProvisioningError
- ResponseError
The error details information of the managed cluster. Preserves the detailed info of failure. If there was no error, this field is omitted.
If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
The managed cluster SKU.
- extendedLocation
- ExtendedLocation
The extended location of the Virtual Machine.
- clusterIdentity
- ManagedClusterIdentity
The identity of the managed cluster, if configured.
- kind
- String
This is primarily used to expose different UI experiences in the portal for different kinds.
Returns
A new ContainerServiceManagedClusterData instance for mocking.