diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/models.tsp b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/models.tsp index c74764d3bf0b..368893f93ab5 100644 --- a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/models.tsp +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/models.tsp @@ -73,7 +73,8 @@ union ManagedClusterSKUTier { */ union ExtendedLocationTypes { string, - #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + + /** Azure Edge Zone extended location type. */ EdgeZone: "EdgeZone", } @@ -426,15 +427,20 @@ union SeccompDefault { */ union GPUInstanceProfile { string, - #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + + /** MIG 1g GPU instance profile. */ MIG1g: "MIG1g", - #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + + /** MIG 2g GPU instance profile. */ MIG2g: "MIG2g", - #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + + /** MIG 3g GPU instance profile. */ MIG3g: "MIG3g", - #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + + /** MIG 4g GPU instance profile. */ MIG4g: "MIG4g", - #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + + /** MIG 7g GPU instance profile. */ MIG7g: "MIG7g", } @@ -669,17 +675,23 @@ union LicenseType { */ union ManagedClusterPodIdentityProvisioningState { string, - #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + + /** Pod identity is assigned. */ Assigned: "Assigned", - #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + + /** Pod identity assignment was canceled. */ Canceled: "Canceled", - #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + + /** Pod identity is being deleted. */ Deleting: "Deleting", - #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + + /** Pod identity assignment failed. */ Failed: "Failed", - #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + + /** Pod identity assignment succeeded. */ Succeeded: "Succeeded", - #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + + /** Pod identity is being updated. */ Updating: "Updating", } @@ -890,13 +902,11 @@ union IPFamily { /** * IPv4 family */ - #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" IPv4: "IPv4", /** * IPv6 family */ - #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" IPv6: "IPv6", } @@ -1104,9 +1114,11 @@ union Expander { */ union KeyVaultNetworkAccessTypes { string, - #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + + /** Key vault allows public access from all networks. */ Public: "Public", - #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + + /** Key vault disables public access and enables private link. */ Private: "Private", } @@ -1339,17 +1351,21 @@ union SchedulerConfigMode { */ union CreatedByType { string, - #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + + /** Created by a user. */ User: "User", - #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + + /** Created by an application. */ Application: "Application", - #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + + /** Created by a managed identity. */ ManagedIdentity: "ManagedIdentity", - #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + + /** Created by a key. */ Key: "Key", } -#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +/** The format of the kubeconfig credential. */ union Format { string, @@ -1369,19 +1385,26 @@ union Format { */ union WeekDay { string, - #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + + /** Represents Sunday. */ Sunday: "Sunday", - #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + + /** Represents Monday. */ Monday: "Monday", - #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + + /** Represents Tuesday. */ Tuesday: "Tuesday", - #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + + /** Represents Wednesday. */ Wednesday: "Wednesday", - #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + + /** Represents Thursday. */ Thursday: "Thursday", - #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + + /** Represents Friday. */ Friday: "Friday", - #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + + /** Represents Saturday. */ Saturday: "Saturday", } @@ -1422,17 +1445,23 @@ union Type { */ union NamespaceProvisioningState { string, - #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + + /** The namespace is being updated. */ Updating: "Updating", - #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + + /** The namespace is being deleted. */ Deleting: "Deleting", - #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + + /** The namespace is being created. */ Creating: "Creating", - #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + + /** The namespace provisioning succeeded. */ Succeeded: "Succeeded", - #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + + /** The namespace provisioning failed. */ Failed: "Failed", - #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + + /** The namespace provisioning was canceled. */ Canceled: "Canceled", } @@ -1537,15 +1566,20 @@ union VmState { */ union PrivateEndpointConnectionProvisioningState { string, - #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + + /** Private endpoint connection provisioning was canceled. */ Canceled: "Canceled", - #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + + /** Private endpoint connection is being created. */ Creating: "Creating", - #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + + /** Private endpoint connection is being deleted. */ Deleting: "Deleting", - #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + + /** Private endpoint connection provisioning failed. */ Failed: "Failed", - #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + + /** Private endpoint connection provisioning succeeded. */ Succeeded: "Succeeded", } @@ -1554,13 +1588,17 @@ union PrivateEndpointConnectionProvisioningState { */ union ConnectionStatus { string, - #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + + /** Connection is pending approval. */ Pending: "Pending", - #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + + /** Connection is approved. */ Approved: "Approved", - #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + + /** Connection is rejected. */ Rejected: "Rejected", - #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + + /** Connection is disconnected. */ Disconnected: "Disconnected", } @@ -1587,15 +1625,20 @@ union SnapshotType { */ union TrustedAccessRoleBindingProvisioningState { string, - #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + + /** Trusted access role binding provisioning was canceled. */ Canceled: "Canceled", - #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + + /** Trusted access role binding is being deleted. */ Deleting: "Deleting", - #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + + /** Trusted access role binding provisioning failed. */ Failed: "Failed", - #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + + /** Trusted access role binding provisioning succeeded. */ Succeeded: "Succeeded", - #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + + /** Trusted access role binding is being updated. */ Updating: "Updating", } @@ -1895,7 +1938,7 @@ model KubernetesVersion { * Capabilities on this Kubernetes version. */ model KubernetesVersionCapabilities { - #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + /** Kubernetes support plans available for this version. */ supportPlan?: KubernetesSupportPlan[]; } @@ -2006,7 +2049,7 @@ model ManagedClusterIdentity { userAssignedIdentities?: Record; } -#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +/** User assigned identity properties. */ model ManagedServiceIdentityUserAssignedIdentitiesValue { /** * The principal id of user assigned identity. @@ -3153,7 +3196,7 @@ model AgentPoolGatewayProfile { publicIPPrefixSize?: int32 = 31; } -#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +/** Artifact streaming profile for the agent pool. */ @added(Versions.v2025_10_02_preview) model AgentPoolArtifactStreamingProfile { /** @@ -3556,12 +3599,12 @@ model ManagedClusterPodIdentity { @visibility(Lifecycle.Read) provisioningState?: ManagedClusterPodIdentityProvisioningState; - #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + /** The provisioning information for the pod identity. */ @visibility(Lifecycle.Read) provisioningInfo?: ManagedClusterPodIdentityProvisioningInfo; } -#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +/** Pod identity provisioning information. */ model ManagedClusterPodIdentityProvisioningInfo { /** * Pod identity assignment error (if any). @@ -4495,7 +4538,7 @@ model ManagedClusterSecurityProfileDefenderSecurityGating { allowSecretAccess?: boolean; } -#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +/** Identity information used by Defender security gating to access container registries. */ @added(Versions.v2025_10_02_preview) model ManagedClusterSecurityProfileDefenderSecurityGatingIdentitiesItem { /** @@ -4696,7 +4739,7 @@ model ManagedClusterIngressProfile { applicationLoadBalancer?: ManagedClusterIngressProfileApplicationLoadBalancer; } -#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +/** Configuration for the ingress managed gateway. See https://aka.ms/k8s-gateway-api for more details. */ @added(Versions.v2025_10_02_preview) model ManagedClusterIngressProfileGatewayConfiguration { /** @@ -4745,7 +4788,7 @@ model ManagedClusterIngressProfileWebAppRouting { defaultDomain?: ManagedClusterIngressDefaultDomainProfile; } -#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +/** Nginx ingress controller configuration for the managed cluster ingress profile. */ model ManagedClusterIngressProfileNginx { /** * Ingress type for the default NginxIngressController custom resource @@ -4753,7 +4796,7 @@ model ManagedClusterIngressProfileNginx { defaultIngressControllerType?: NginxIngressControllerType; } -#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +/** Default domain profile for the managed cluster ingress profile. */ @added(Versions.v2025_10_02_preview) model ManagedClusterIngressDefaultDomainProfile { /** @@ -5142,7 +5185,7 @@ model ManagedClusterCostAnalysis { enabled?: boolean; } -#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +/** Node provisioning profile for the managed cluster. */ model ManagedClusterNodeProvisioningProfile { /** * The node provisioning mode. If not specified, the default is Manual. @@ -5290,7 +5333,7 @@ model ManagedClusterPoolUpgradeProfile { componentsByReleases?: ComponentsByRelease[]; } -#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +/** Available upgrades for an AgentPool. */ model ManagedClusterPoolUpgradeProfileUpgradesItem { /** * The Kubernetes version (major.minor.patch). @@ -5326,7 +5369,7 @@ model ComponentsByRelease { components?: Component[]; } -#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +/** Component information for a Kubernetes version. */ @added(Versions.v2025_10_02_preview) model Component { /** @@ -5774,7 +5817,7 @@ model AgentPoolUpgradeProfileProperties { latestNodeImageVersion?: string; } -#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +/** Available upgrades for an AgentPool. */ model AgentPoolUpgradeProfilePropertiesUpgradesItem { /** * The Kubernetes version (major.minor.patch). @@ -6049,7 +6092,7 @@ model AgentPoolAvailableVersionsProperties { agentPoolVersions?: AgentPoolAvailableVersionsPropertiesAgentPoolVersionsItem[]; } -#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +/** Available version information for an agent pool. */ model AgentPoolAvailableVersionsPropertiesAgentPoolVersionsItem { /** * Whether this version is the default agent pool version. @@ -6422,7 +6465,7 @@ model NetworkProfileForSnapshot { #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" @added(Versions.v2025_10_02_preview) model GuardrailsAvailableVersionsProperties { - #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + /** Whether this is the default version. */ @visibility(Lifecycle.Read) isDefaultVersion?: boolean; @@ -6446,7 +6489,7 @@ model GuardrailsAvailableVersionsList #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" @added(Versions.v2025_10_02_preview) model SafeguardsAvailableVersionsProperties { - #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + /** Whether this is the default version. */ @visibility(Lifecycle.Read) isDefaultVersion?: boolean; @@ -6474,7 +6517,7 @@ model MeshRevisionProfileList is Azure.Core.Page; */ #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" model MeshRevisionProfileProperties { - #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + /** Available mesh revisions. */ @identifiers(#[]) meshRevisions?: MeshRevision[]; } @@ -6797,7 +6840,7 @@ model MachineIpAddress { ip?: string; } -#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +/** Properties for a load balancer resource. */ @added(Versions.v2025_10_02_preview) model LoadBalancerProperties { /** diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-10-02-preview/managedClusters.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-10-02-preview/managedClusters.json index f23116484a74..d106e5ab17ed 100644 --- a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-10-02-preview/managedClusters.json +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-10-02-preview/managedClusters.json @@ -6530,6 +6530,7 @@ }, "AgentPoolArtifactStreamingProfile": { "type": "object", + "description": "Artifact streaming profile for the agent pool.", "properties": { "enabled": { "type": "boolean", @@ -6582,6 +6583,7 @@ }, "AgentPoolAvailableVersionsPropertiesAgentPoolVersionsItem": { "type": "object", + "description": "Available version information for an agent pool.", "properties": { "default": { "type": "boolean", @@ -6956,6 +6958,7 @@ }, "AgentPoolUpgradeProfilePropertiesUpgradesItem": { "type": "object", + "description": "Available upgrades for an AgentPool.", "properties": { "kubernetesVersion": { "type": "string", @@ -7063,11 +7066,13 @@ "values": [ { "name": "Public", - "value": "Public" + "value": "Public", + "description": "Key vault allows public access from all networks." }, { "name": "Private", - "value": "Private" + "value": "Private", + "description": "Key vault disables public access and enables private link." } ] } @@ -7182,6 +7187,7 @@ }, "Component": { "type": "object", + "description": "Component information for a Kubernetes version.", "properties": { "name": { "type": "string", @@ -7230,19 +7236,23 @@ "values": [ { "name": "Pending", - "value": "Pending" + "value": "Pending", + "description": "Connection is pending approval." }, { "name": "Approved", - "value": "Approved" + "value": "Approved", + "description": "Connection is approved." }, { "name": "Rejected", - "value": "Rejected" + "value": "Rejected", + "description": "Connection is rejected." }, { "name": "Disconnected", - "value": "Disconnected" + "value": "Disconnected", + "description": "Connection is disconnected." } ] } @@ -7729,7 +7739,8 @@ "values": [ { "name": "EdgeZone", - "value": "EdgeZone" + "value": "EdgeZone", + "description": "Azure Edge Zone extended location type." } ] } @@ -7774,23 +7785,28 @@ "values": [ { "name": "MIG1g", - "value": "MIG1g" + "value": "MIG1g", + "description": "MIG 1g GPU instance profile." }, { "name": "MIG2g", - "value": "MIG2g" + "value": "MIG2g", + "description": "MIG 2g GPU instance profile." }, { "name": "MIG3g", - "value": "MIG3g" + "value": "MIG3g", + "description": "MIG 3g GPU instance profile." }, { "name": "MIG4g", - "value": "MIG4g" + "value": "MIG4g", + "description": "MIG 4g GPU instance profile." }, { "name": "MIG7g", - "value": "MIG7g" + "value": "MIG7g", + "description": "MIG 7g GPU instance profile." } ] } @@ -7854,6 +7870,7 @@ "properties": { "isDefaultVersion": { "type": "boolean", + "description": "Whether this is the default version.", "readOnly": true }, "support": { @@ -8704,6 +8721,7 @@ "properties": { "supportPlan": { "type": "array", + "description": "Kubernetes support plans available for this version.", "items": { "$ref": "#/definitions/KubernetesSupportPlan" } @@ -8852,6 +8870,7 @@ }, "LoadBalancerProperties": { "type": "object", + "description": "Properties for a load balancer resource.", "properties": { "primaryAgentPoolName": { "type": "string", @@ -10560,6 +10579,7 @@ }, "ManagedClusterIngressDefaultDomainProfile": { "type": "object", + "description": "Default domain profile for the managed cluster ingress profile.", "properties": { "enabled": { "type": "boolean", @@ -10607,6 +10627,7 @@ }, "ManagedClusterIngressProfileGatewayConfiguration": { "type": "object", + "description": "Configuration for the ingress managed gateway. See https://aka.ms/k8s-gateway-api for more details.", "properties": { "installation": { "$ref": "#/definitions/ManagedGatewayType", @@ -10616,6 +10637,7 @@ }, "ManagedClusterIngressProfileNginx": { "type": "object", + "description": "Nginx ingress controller configuration for the managed cluster ingress profile.", "properties": { "defaultIngressControllerType": { "$ref": "#/definitions/NginxIngressControllerType", @@ -10883,6 +10905,7 @@ }, "ManagedClusterNodeProvisioningProfile": { "type": "object", + "description": "Node provisioning profile for the managed cluster.", "properties": { "mode": { "$ref": "#/definitions/NodeProvisioningMode", @@ -10967,6 +10990,7 @@ }, "provisioningInfo": { "$ref": "#/definitions/ManagedClusterPodIdentityProvisioningInfo", + "description": "The provisioning information for the pod identity.", "readOnly": true } }, @@ -11070,6 +11094,7 @@ }, "ManagedClusterPodIdentityProvisioningInfo": { "type": "object", + "description": "Pod identity provisioning information.", "properties": { "error": { "$ref": "#/definitions/ManagedClusterPodIdentityProvisioningError", @@ -11094,27 +11119,33 @@ "values": [ { "name": "Assigned", - "value": "Assigned" + "value": "Assigned", + "description": "Pod identity is assigned." }, { "name": "Canceled", - "value": "Canceled" + "value": "Canceled", + "description": "Pod identity assignment was canceled." }, { "name": "Deleting", - "value": "Deleting" + "value": "Deleting", + "description": "Pod identity is being deleted." }, { "name": "Failed", - "value": "Failed" + "value": "Failed", + "description": "Pod identity assignment failed." }, { "name": "Succeeded", - "value": "Succeeded" + "value": "Succeeded", + "description": "Pod identity assignment succeeded." }, { "name": "Updating", - "value": "Updating" + "value": "Updating", + "description": "Pod identity is being updated." } ] } @@ -11180,6 +11211,7 @@ }, "ManagedClusterPoolUpgradeProfileUpgradesItem": { "type": "object", + "description": "Available upgrades for an AgentPool.", "properties": { "kubernetesVersion": { "type": "string", @@ -11717,6 +11749,7 @@ }, "ManagedClusterSecurityProfileDefenderSecurityGatingIdentitiesItem": { "type": "object", + "description": "Identity information used by Defender security gating to access container registries.", "properties": { "azureContainerRegistry": { "type": "string", @@ -12182,6 +12215,7 @@ }, "ManagedServiceIdentityUserAssignedIdentitiesValue": { "type": "object", + "description": "User assigned identity properties.", "properties": { "principalId": { "type": "string", @@ -12401,6 +12435,7 @@ "properties": { "meshRevisions": { "type": "array", + "description": "Available mesh revisions.", "items": { "$ref": "#/definitions/MeshRevision" }, @@ -12550,27 +12585,33 @@ "values": [ { "name": "Updating", - "value": "Updating" + "value": "Updating", + "description": "The namespace is being updated." }, { "name": "Deleting", - "value": "Deleting" + "value": "Deleting", + "description": "The namespace is being deleted." }, { "name": "Creating", - "value": "Creating" + "value": "Creating", + "description": "The namespace is being created." }, { "name": "Succeeded", - "value": "Succeeded" + "value": "Succeeded", + "description": "The namespace provisioning succeeded." }, { "name": "Failed", - "value": "Failed" + "value": "Failed", + "description": "The namespace provisioning failed." }, { "name": "Canceled", - "value": "Canceled" + "value": "Canceled", + "description": "The namespace provisioning was canceled." } ] } @@ -13389,23 +13430,28 @@ "values": [ { "name": "Canceled", - "value": "Canceled" + "value": "Canceled", + "description": "Private endpoint connection provisioning was canceled." }, { "name": "Creating", - "value": "Creating" + "value": "Creating", + "description": "Private endpoint connection is being created." }, { "name": "Deleting", - "value": "Deleting" + "value": "Deleting", + "description": "Private endpoint connection is being deleted." }, { "name": "Failed", - "value": "Failed" + "value": "Failed", + "description": "Private endpoint connection provisioning failed." }, { "name": "Succeeded", - "value": "Succeeded" + "value": "Succeeded", + "description": "Private endpoint connection provisioning succeeded." } ] } @@ -13761,6 +13807,7 @@ "properties": { "isDefaultVersion": { "type": "boolean", + "description": "Whether this is the default version.", "readOnly": true }, "support": { @@ -14428,23 +14475,28 @@ "values": [ { "name": "Canceled", - "value": "Canceled" + "value": "Canceled", + "description": "Trusted access role binding provisioning was canceled." }, { "name": "Deleting", - "value": "Deleting" + "value": "Deleting", + "description": "Trusted access role binding is being deleted." }, { "name": "Failed", - "value": "Failed" + "value": "Failed", + "description": "Trusted access role binding provisioning failed." }, { "name": "Succeeded", - "value": "Succeeded" + "value": "Succeeded", + "description": "Trusted access role binding provisioning succeeded." }, { "name": "Updating", - "value": "Updating" + "value": "Updating", + "description": "Trusted access role binding is being updated." } ] } @@ -14756,31 +14808,38 @@ "values": [ { "name": "Sunday", - "value": "Sunday" + "value": "Sunday", + "description": "Represents Sunday." }, { "name": "Monday", - "value": "Monday" + "value": "Monday", + "description": "Represents Monday." }, { "name": "Tuesday", - "value": "Tuesday" + "value": "Tuesday", + "description": "Represents Tuesday." }, { "name": "Wednesday", - "value": "Wednesday" + "value": "Wednesday", + "description": "Represents Wednesday." }, { "name": "Thursday", - "value": "Thursday" + "value": "Thursday", + "description": "Represents Thursday." }, { "name": "Friday", - "value": "Friday" + "value": "Friday", + "description": "Represents Friday." }, { "name": "Saturday", - "value": "Saturday" + "value": "Saturday", + "description": "Represents Saturday." } ] } diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2025-10-01/managedClusters.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2025-10-01/managedClusters.json index 681915cb4540..9890c51c5aee 100644 --- a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2025-10-01/managedClusters.json +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2025-10-01/managedClusters.json @@ -4422,6 +4422,7 @@ }, "AgentPoolAvailableVersionsPropertiesAgentPoolVersionsItem": { "type": "object", + "description": "Available version information for an agent pool.", "properties": { "default": { "type": "boolean", @@ -4711,6 +4712,7 @@ }, "AgentPoolUpgradeProfilePropertiesUpgradesItem": { "type": "object", + "description": "Available upgrades for an AgentPool.", "properties": { "kubernetesVersion": { "type": "string", @@ -4790,11 +4792,13 @@ "values": [ { "name": "Public", - "value": "Public" + "value": "Public", + "description": "Key vault allows public access from all networks." }, { "name": "Private", - "value": "Private" + "value": "Private", + "description": "Key vault disables public access and enables private link." } ] } @@ -4922,19 +4926,23 @@ "values": [ { "name": "Pending", - "value": "Pending" + "value": "Pending", + "description": "Connection is pending approval." }, { "name": "Approved", - "value": "Approved" + "value": "Approved", + "description": "Connection is approved." }, { "name": "Rejected", - "value": "Rejected" + "value": "Rejected", + "description": "Connection is rejected." }, { "name": "Disconnected", - "value": "Disconnected" + "value": "Disconnected", + "description": "Connection is disconnected." } ] } @@ -5322,7 +5330,8 @@ "values": [ { "name": "EdgeZone", - "value": "EdgeZone" + "value": "EdgeZone", + "description": "Azure Edge Zone extended location type." } ] } @@ -5367,23 +5376,28 @@ "values": [ { "name": "MIG1g", - "value": "MIG1g" + "value": "MIG1g", + "description": "MIG 1g GPU instance profile." }, { "name": "MIG2g", - "value": "MIG2g" + "value": "MIG2g", + "description": "MIG 2g GPU instance profile." }, { "name": "MIG3g", - "value": "MIG3g" + "value": "MIG3g", + "description": "MIG 3g GPU instance profile." }, { "name": "MIG4g", - "value": "MIG4g" + "value": "MIG4g", + "description": "MIG 4g GPU instance profile." }, { "name": "MIG7g", - "value": "MIG7g" + "value": "MIG7g", + "description": "MIG 7g GPU instance profile." } ] } @@ -5756,6 +5770,7 @@ "properties": { "supportPlan": { "type": "array", + "description": "Kubernetes support plans available for this version.", "items": { "$ref": "#/definitions/KubernetesSupportPlan" } @@ -7038,6 +7053,7 @@ }, "ManagedClusterIngressProfileNginx": { "type": "object", + "description": "Nginx ingress controller configuration for the managed cluster ingress profile.", "properties": { "defaultIngressControllerType": { "$ref": "#/definitions/NginxIngressControllerType", @@ -7276,6 +7292,7 @@ }, "ManagedClusterNodeProvisioningProfile": { "type": "object", + "description": "Node provisioning profile for the managed cluster.", "properties": { "mode": { "$ref": "#/definitions/NodeProvisioningMode", @@ -7360,6 +7377,7 @@ }, "provisioningInfo": { "$ref": "#/definitions/ManagedClusterPodIdentityProvisioningInfo", + "description": "The provisioning information for the pod identity.", "readOnly": true } }, @@ -7463,6 +7481,7 @@ }, "ManagedClusterPodIdentityProvisioningInfo": { "type": "object", + "description": "Pod identity provisioning information.", "properties": { "error": { "$ref": "#/definitions/ManagedClusterPodIdentityProvisioningError", @@ -7487,27 +7506,33 @@ "values": [ { "name": "Assigned", - "value": "Assigned" + "value": "Assigned", + "description": "Pod identity is assigned." }, { "name": "Canceled", - "value": "Canceled" + "value": "Canceled", + "description": "Pod identity assignment was canceled." }, { "name": "Deleting", - "value": "Deleting" + "value": "Deleting", + "description": "Pod identity is being deleted." }, { "name": "Failed", - "value": "Failed" + "value": "Failed", + "description": "Pod identity assignment failed." }, { "name": "Succeeded", - "value": "Succeeded" + "value": "Succeeded", + "description": "Pod identity assignment succeeded." }, { "name": "Updating", - "value": "Updating" + "value": "Updating", + "description": "Pod identity is being updated." } ] } @@ -7565,6 +7590,7 @@ }, "ManagedClusterPoolUpgradeProfileUpgradesItem": { "type": "object", + "description": "Available upgrades for an AgentPool.", "properties": { "kubernetesVersion": { "type": "string", @@ -8323,6 +8349,7 @@ }, "ManagedServiceIdentityUserAssignedIdentitiesValue": { "type": "object", + "description": "User assigned identity properties.", "properties": { "principalId": { "type": "string", @@ -8418,6 +8445,7 @@ "properties": { "meshRevisions": { "type": "array", + "description": "Available mesh revisions.", "items": { "$ref": "#/definitions/MeshRevision" }, @@ -8537,27 +8565,33 @@ "values": [ { "name": "Updating", - "value": "Updating" + "value": "Updating", + "description": "The namespace is being updated." }, { "name": "Deleting", - "value": "Deleting" + "value": "Deleting", + "description": "The namespace is being deleted." }, { "name": "Creating", - "value": "Creating" + "value": "Creating", + "description": "The namespace is being created." }, { "name": "Succeeded", - "value": "Succeeded" + "value": "Succeeded", + "description": "The namespace provisioning succeeded." }, { "name": "Failed", - "value": "Failed" + "value": "Failed", + "description": "The namespace provisioning failed." }, { "name": "Canceled", - "value": "Canceled" + "value": "Canceled", + "description": "The namespace provisioning was canceled." } ] } @@ -9184,23 +9218,28 @@ "values": [ { "name": "Canceled", - "value": "Canceled" + "value": "Canceled", + "description": "Private endpoint connection provisioning was canceled." }, { "name": "Creating", - "value": "Creating" + "value": "Creating", + "description": "Private endpoint connection is being created." }, { "name": "Deleting", - "value": "Deleting" + "value": "Deleting", + "description": "Private endpoint connection is being deleted." }, { "name": "Failed", - "value": "Failed" + "value": "Failed", + "description": "Private endpoint connection provisioning failed." }, { "name": "Succeeded", - "value": "Succeeded" + "value": "Succeeded", + "description": "Private endpoint connection provisioning succeeded." } ] } @@ -9990,23 +10029,28 @@ "values": [ { "name": "Canceled", - "value": "Canceled" + "value": "Canceled", + "description": "Trusted access role binding provisioning was canceled." }, { "name": "Deleting", - "value": "Deleting" + "value": "Deleting", + "description": "Trusted access role binding is being deleted." }, { "name": "Failed", - "value": "Failed" + "value": "Failed", + "description": "Trusted access role binding provisioning failed." }, { "name": "Succeeded", - "value": "Succeeded" + "value": "Succeeded", + "description": "Trusted access role binding provisioning succeeded." }, { "name": "Updating", - "value": "Updating" + "value": "Updating", + "description": "Trusted access role binding is being updated." } ] } @@ -10270,31 +10314,38 @@ "values": [ { "name": "Sunday", - "value": "Sunday" + "value": "Sunday", + "description": "Represents Sunday." }, { "name": "Monday", - "value": "Monday" + "value": "Monday", + "description": "Represents Monday." }, { "name": "Tuesday", - "value": "Tuesday" + "value": "Tuesday", + "description": "Represents Tuesday." }, { "name": "Wednesday", - "value": "Wednesday" + "value": "Wednesday", + "description": "Represents Wednesday." }, { "name": "Thursday", - "value": "Thursday" + "value": "Thursday", + "description": "Represents Thursday." }, { "name": "Friday", - "value": "Friday" + "value": "Friday", + "description": "Represents Friday." }, { "name": "Saturday", - "value": "Saturday" + "value": "Saturday", + "description": "Represents Saturday." } ] }