Microsoft Azure · Schema
ManagedClusterProperties
Properties of a managed cluster.
API ManagementCloudCloud ComputingEnterpriseInfrastructure as a ServicePlatform as a ServiceT1
Properties
| Name | Type | Description |
|---|---|---|
| provisioningState | string | The current provisioning state. |
| powerState | object | |
| kubernetesVersion | string | The version of Kubernetes specified by the user. |
| currentKubernetesVersion | string | The current version of Kubernetes running on the cluster. |
| dnsPrefix | string | This cannot be updated once the managed cluster has been created. |
| fqdn | string | The FQDN of the master pool. |
| fqdnSubdomain | string | The FQDN subdomain. |
| agentPoolProfiles | array | The agent pool properties. |
| linuxProfile | object | The profile for Linux VMs. |
| windowsProfile | object | The profile for Windows VMs. |
| servicePrincipalProfile | object | Information about the service principal identity for the cluster. |
| addonProfiles | object | The profile of managed cluster add-on. |
| nodeResourceGroup | string | The name of the resource group containing agent pool nodes. |
| enableRBAC | boolean | Whether to enable Kubernetes RBAC. |
| enablePodSecurityPolicy | boolean | Whether to enable Kubernetes pod security policy (deprecated). |
| networkProfile | object | |
| aadProfile | object | |
| autoScalerProfile | object | Parameters to be applied to the cluster autoscaler. |
| apiServerAccessProfile | object | Access profile for managed cluster API server. |
| diskEncryptionSetID | string | The resource ID of the disk encryption set. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/ManagedClusterProperties",
"title": "ManagedClusterProperties",
"type": "object",
"description": "Properties of a managed cluster.",
"properties": {
"provisioningState": {
"type": "string",
"readOnly": true,
"description": "The current provisioning state.",
"example": "example_value"
},
"powerState": {
"type": "object",
"readOnly": true,
"properties": {
"code": {
"type": "string",
"enum": [
"Running",
"Stopped"
]
}
},
"example": "example_value"
},
"kubernetesVersion": {
"type": "string",
"description": "The version of Kubernetes specified by the user.",
"example": "example_value"
},
"currentKubernetesVersion": {
"type": "string",
"readOnly": true,
"description": "The current version of Kubernetes running on the cluster.",
"example": "example_value"
},
"dnsPrefix": {
"type": "string",
"description": "This cannot be updated once the managed cluster has been created.",
"example": "example_value"
},
"fqdn": {
"type": "string",
"readOnly": true,
"description": "The FQDN of the master pool.",
"example": "example_value"
},
"fqdnSubdomain": {
"type": "string",
"description": "The FQDN subdomain.",
"example": "example_value"
},
"agentPoolProfiles": {
"type": "array",
"description": "The agent pool properties.",
"items": {
"$ref": "#/components/schemas/ManagedClusterAgentPoolProfile"
},
"example": []
},
"linuxProfile": {
"type": "object",
"description": "The profile for Linux VMs.",
"properties": {
"adminUsername": {
"type": "string",
"description": "The administrator username to use for Linux VMs.",
"pattern": "^[A-Za-z][-A-Za-z0-9_]*$"
},
"ssh": {
"type": "object",
"properties": {
"publicKeys": {
"type": "array",
"items": {
"type": "object",
"properties": {
"keyData": {
"type": "string",
"description": "Certificate public key (SSH RSA public key)."
}
}
}
}
},
"required": [
"publicKeys"
]
}
},
"required": [
"adminUsername",
"ssh"
],
"example": "example_value"
},
"windowsProfile": {
"type": "object",
"description": "The profile for Windows VMs.",
"properties": {
"adminUsername": {
"type": "string",
"description": "The administrator username for Windows VMs."
},
"adminPassword": {
"type": "string",
"format": "password",
"description": "The administrator password for Windows VMs."
},
"licenseType": {
"type": "string",
"enum": [
"None",
"Windows_Server"
]
}
},
"required": [
"adminUsername"
],
"example": "example_value"
},
"servicePrincipalProfile": {
"type": "object",
"description": "Information about the service principal identity for the cluster.",
"properties": {
"clientId": {
"type": "string",
"description": "The ID for the service principal."
},
"secret": {
"type": "string",
"format": "password",
"description": "The secret password associated with the service principal."
}
},
"required": [
"clientId"
],
"example": "example_value"
},
"addonProfiles": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/ManagedClusterAddonProfile"
},
"description": "The profile of managed cluster add-on.",
"example": "example_value"
},
"nodeResourceGroup": {
"type": "string",
"description": "The name of the resource group containing agent pool nodes.",
"example": "example_value"
},
"enableRBAC": {
"type": "boolean",
"description": "Whether to enable Kubernetes RBAC.",
"example": true
},
"enablePodSecurityPolicy": {
"type": "boolean",
"description": "Whether to enable Kubernetes pod security policy (deprecated).",
"example": true
},
"networkProfile": {
"$ref": "#/components/schemas/ContainerServiceNetworkProfile"
},
"aadProfile": {
"$ref": "#/components/schemas/ManagedClusterAADProfile"
},
"autoScalerProfile": {
"type": "object",
"description": "Parameters to be applied to the cluster autoscaler.",
"properties": {
"balance-similar-node-groups": {
"type": "string"
},
"expander": {
"type": "string",
"enum": [
"least-waste",
"most-pods",
"priority",
"random"
]
},
"max-empty-bulk-delete": {
"type": "string"
},
"max-graceful-termination-sec": {
"type": "string"
},
"max-node-provision-time": {
"type": "string"
},
"max-total-unready-percentage": {
"type": "string"
},
"new-pod-scale-up-delay": {
"type": "string"
},
"ok-total-unready-count": {
"type": "string"
},
"scan-interval": {
"type": "string"
},
"scale-down-delay-after-add": {
"type": "string"
},
"scale-down-delay-after-delete": {
"type": "string"
},
"scale-down-delay-after-failure": {
"type": "string"
},
"scale-down-unneeded-time": {
"type": "string"
},
"scale-down-unready-time": {
"type": "string"
},
"scale-down-utilization-threshold": {
"type": "string"
},
"skip-nodes-with-local-storage": {
"type": "string"
},
"skip-nodes-with-system-pods": {
"type": "string"
}
},
"example": "example_value"
},
"apiServerAccessProfile": {
"type": "object",
"description": "Access profile for managed cluster API server.",
"properties": {
"authorizedIPRanges": {
"type": "array",
"items": {
"type": "string"
},
"description": "IP ranges authorized to access the Kubernetes API server."
},
"enablePrivateCluster": {
"type": "boolean",
"description": "Whether to create the cluster as a private cluster."
},
"privateDNSZone": {
"type": "string",
"description": "The private DNS zone mode for the cluster."
},
"enablePrivateClusterPublicFQDN": {
"type": "boolean",
"description": "Whether to create additional public FQDN for the private cluster."
}
},
"example": "example_value"
},
"diskEncryptionSetID": {
"type": "string",
"description": "The resource ID of the disk encryption set.",
"example": "500123"
}
}
}