openapi: 3.1.0 info: title: Azure Kubernetes Service REST API description: >- REST API for managing Azure Kubernetes Service (AKS) resources including managed clusters, agent pools, maintenance configurations, snapshots, private endpoint connections, and trusted access role bindings. AKS simplifies deploying a managed Kubernetes cluster in Azure by offloading operational overhead such as health monitoring and maintenance. version: '2025-10-01' contact: name: Microsoft Azure Support url: https://azure.microsoft.com/en-us/support/options/ license: name: Microsoft API License url: https://azure.microsoft.com/en-us/support/legal/ x-apisguru-categories: - cloud - containers - kubernetes x-logo: url: https://azure.microsoft.com/images/aks-icon.png servers: - url: https://management.azure.com description: Azure Resource Manager security: - azure_auth: - user_impersonation tags: - name: Agent Pools description: Operations for managing agent pools (node pools) within AKS clusters externalDocs: url: https://learn.microsoft.com/en-us/rest/api/aks/agent-pools - name: Managed Clusters description: Operations for managing AKS managed clusters externalDocs: url: https://learn.microsoft.com/en-us/rest/api/aks/managed-clusters paths: /subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/managedClusters: get: operationId: ManagedClusters_List summary: Azure Kubernetes Service List Managed Clusters description: >- Gets a list of managed clusters in the specified subscription. tags: - Managed Clusters parameters: - $ref: '#/components/parameters/SubscriptionIdParameter' - $ref: '#/components/parameters/ApiVersionParameter' responses: '200': description: OK. The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/ManagedClusterListResult' examples: ManagedclustersList200Example: summary: Default ManagedClusters_List 200 response x-microcks-default: true value: value: - id: abc123 name: Example Title type: example_value location: example_value tags: example_value kind: example_value nextLink: example_value default: description: Error response describing why the operation failed. content: application/json: schema: $ref: '#/components/schemas/CloudError' examples: ManagedclustersListdefaultExample: summary: Default ManagedClusters_List default response x-microcks-default: true value: error: code: example_value message: example_value target: example_value details: - code: example_value message: example_value target: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters: get: operationId: ManagedClusters_ListByResourceGroup summary: Azure Kubernetes Service List Managed Clusters by Resource Group description: >- Lists managed clusters in the specified subscription and resource group. tags: - Managed Clusters parameters: - $ref: '#/components/parameters/SubscriptionIdParameter' - $ref: '#/components/parameters/ResourceGroupNameParameter' - $ref: '#/components/parameters/ApiVersionParameter' responses: '200': description: OK. The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/ManagedClusterListResult' examples: ManagedclustersListbyresourcegroup200Example: summary: Default ManagedClusters_ListByResourceGroup 200 response x-microcks-default: true value: value: - id: abc123 name: Example Title type: example_value location: example_value tags: example_value kind: example_value nextLink: example_value default: description: Error response describing why the operation failed. content: application/json: schema: $ref: '#/components/schemas/CloudError' examples: ManagedclustersListbyresourcegroupdefaultExample: summary: Default ManagedClusters_ListByResourceGroup default response x-microcks-default: true value: error: code: example_value message: example_value target: example_value details: - code: example_value message: example_value target: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName} : get: operationId: ManagedClusters_Get summary: Azure Kubernetes Service Get a Managed Cluster description: Gets the details of the managed cluster with a specified resource group and name. tags: - Managed Clusters parameters: - $ref: '#/components/parameters/SubscriptionIdParameter' - $ref: '#/components/parameters/ResourceGroupNameParameter' - $ref: '#/components/parameters/ResourceNameParameter' - $ref: '#/components/parameters/ApiVersionParameter' responses: '200': description: OK. The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/ManagedCluster' examples: ManagedclustersGet200Example: summary: Default ManagedClusters_Get 200 response x-microcks-default: true value: id: abc123 name: Example Title type: example_value location: example_value tags: example_value sku: name: Base tier: Free kind: example_value identity: principalId: '500123' tenantId: '500123' type: SystemAssigned userAssignedIdentities: example_value extendedLocation: name: Example Title type: EdgeZone systemData: createdBy: example_value createdByType: User createdAt: '2026-01-15T10:30:00Z' lastModifiedBy: example_value lastModifiedByType: User lastModifiedAt: '2026-01-15T10:30:00Z' properties: provisioningState: example_value maxAgentPools: 10 kubernetesVersion: example_value currentKubernetesVersion: example_value dnsPrefix: example_value fqdnSubdomain: example_value fqdn: example_value privateFQDN: example_value azurePortalFQDN: example_value enableRBAC: true supportPlan: KubernetesOfficial disableLocalAccounts: true nodeResourceGroup: example_value agentPoolProfiles: - {} identityProfile: example_value addonProfiles: example_value diskEncryptionSetID: '500123' default: description: Error response describing why the operation failed. content: application/json: schema: $ref: '#/components/schemas/CloudError' examples: ManagedclustersGetdefaultExample: summary: Default ManagedClusters_Get default response x-microcks-default: true value: error: code: example_value message: example_value target: example_value details: - code: example_value message: example_value target: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK put: operationId: ManagedClusters_CreateOrUpdate summary: Azure Kubernetes Service Create or Update a Managed Cluster description: Creates or updates a managed cluster. tags: - Managed Clusters parameters: - $ref: '#/components/parameters/SubscriptionIdParameter' - $ref: '#/components/parameters/ResourceGroupNameParameter' - $ref: '#/components/parameters/ResourceNameParameter' - $ref: '#/components/parameters/ApiVersionParameter' - name: if-match in: header description: >- The request should only proceed if an entity matches this string. schema: type: string example: example_value - name: if-none-match in: header description: >- The request should only proceed if no entity matches this string. schema: type: string example: example_value requestBody: required: true description: The managed cluster to create or update. content: application/json: schema: $ref: '#/components/schemas/ManagedCluster' examples: ManagedclustersCreateorupdateRequestExample: summary: Default ManagedClusters_CreateOrUpdate request x-microcks-default: true value: id: abc123 name: Example Title type: example_value location: example_value tags: example_value sku: name: Base tier: Free kind: example_value identity: principalId: '500123' tenantId: '500123' type: SystemAssigned userAssignedIdentities: example_value extendedLocation: name: Example Title type: EdgeZone systemData: createdBy: example_value createdByType: User createdAt: '2026-01-15T10:30:00Z' lastModifiedBy: example_value lastModifiedByType: User lastModifiedAt: '2026-01-15T10:30:00Z' properties: provisioningState: example_value maxAgentPools: 10 kubernetesVersion: example_value currentKubernetesVersion: example_value dnsPrefix: example_value fqdnSubdomain: example_value fqdn: example_value privateFQDN: example_value azurePortalFQDN: example_value enableRBAC: true supportPlan: KubernetesOfficial disableLocalAccounts: true nodeResourceGroup: example_value agentPoolProfiles: - {} identityProfile: example_value addonProfiles: example_value diskEncryptionSetID: '500123' responses: '200': description: OK. The update operation has succeeded. content: application/json: schema: $ref: '#/components/schemas/ManagedCluster' examples: ManagedclustersCreateorupdate200Example: summary: Default ManagedClusters_CreateOrUpdate 200 response x-microcks-default: true value: id: abc123 name: Example Title type: example_value location: example_value tags: example_value sku: name: Base tier: Free kind: example_value identity: principalId: '500123' tenantId: '500123' type: SystemAssigned userAssignedIdentities: example_value extendedLocation: name: Example Title type: EdgeZone systemData: createdBy: example_value createdByType: User createdAt: '2026-01-15T10:30:00Z' lastModifiedBy: example_value lastModifiedByType: User lastModifiedAt: '2026-01-15T10:30:00Z' properties: provisioningState: example_value maxAgentPools: 10 kubernetesVersion: example_value currentKubernetesVersion: example_value dnsPrefix: example_value fqdnSubdomain: example_value fqdn: example_value privateFQDN: example_value azurePortalFQDN: example_value enableRBAC: true supportPlan: KubernetesOfficial disableLocalAccounts: true nodeResourceGroup: example_value agentPoolProfiles: - {} identityProfile: example_value addonProfiles: example_value diskEncryptionSetID: '500123' '201': description: Created. The create operation has succeeded. headers: Azure-AsyncOperation: description: URL to query for status of the asynchronous operation. schema: type: string Retry-After: description: Suggested delay in seconds to check on operation status. schema: type: integer content: application/json: schema: $ref: '#/components/schemas/ManagedCluster' examples: ManagedclustersCreateorupdate201Example: summary: Default ManagedClusters_CreateOrUpdate 201 response x-microcks-default: true value: id: abc123 name: Example Title type: example_value location: example_value tags: example_value sku: name: Base tier: Free kind: example_value identity: principalId: '500123' tenantId: '500123' type: SystemAssigned userAssignedIdentities: example_value extendedLocation: name: Example Title type: EdgeZone systemData: createdBy: example_value createdByType: User createdAt: '2026-01-15T10:30:00Z' lastModifiedBy: example_value lastModifiedByType: User lastModifiedAt: '2026-01-15T10:30:00Z' properties: provisioningState: example_value maxAgentPools: 10 kubernetesVersion: example_value currentKubernetesVersion: example_value dnsPrefix: example_value fqdnSubdomain: example_value fqdn: example_value privateFQDN: example_value azurePortalFQDN: example_value enableRBAC: true supportPlan: KubernetesOfficial disableLocalAccounts: true nodeResourceGroup: example_value agentPoolProfiles: - {} identityProfile: example_value addonProfiles: example_value diskEncryptionSetID: '500123' default: description: Error response describing why the operation failed. content: application/json: schema: $ref: '#/components/schemas/CloudError' examples: ManagedclustersCreateorupdatedefaultExample: summary: Default ManagedClusters_CreateOrUpdate default response x-microcks-default: true value: error: code: example_value message: example_value target: example_value details: - code: example_value message: example_value target: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: operationId: ManagedClusters_UpdateTags summary: Azure Kubernetes Service Update Managed Cluster Tags description: Updates tags on a managed cluster. tags: - Managed Clusters parameters: - $ref: '#/components/parameters/SubscriptionIdParameter' - $ref: '#/components/parameters/ResourceGroupNameParameter' - $ref: '#/components/parameters/ResourceNameParameter' - $ref: '#/components/parameters/ApiVersionParameter' requestBody: required: true description: Parameters supplied to the Update Managed Cluster Tags operation. content: application/json: schema: $ref: '#/components/schemas/TagsObject' examples: ManagedclustersUpdatetagsRequestExample: summary: Default ManagedClusters_UpdateTags request x-microcks-default: true value: tags: example_value responses: '200': description: OK. The update tags operation has succeeded. content: application/json: schema: $ref: '#/components/schemas/ManagedCluster' examples: ManagedclustersUpdatetags200Example: summary: Default ManagedClusters_UpdateTags 200 response x-microcks-default: true value: id: abc123 name: Example Title type: example_value location: example_value tags: example_value sku: name: Base tier: Free kind: example_value identity: principalId: '500123' tenantId: '500123' type: SystemAssigned userAssignedIdentities: example_value extendedLocation: name: Example Title type: EdgeZone systemData: createdBy: example_value createdByType: User createdAt: '2026-01-15T10:30:00Z' lastModifiedBy: example_value lastModifiedByType: User lastModifiedAt: '2026-01-15T10:30:00Z' properties: provisioningState: example_value maxAgentPools: 10 kubernetesVersion: example_value currentKubernetesVersion: example_value dnsPrefix: example_value fqdnSubdomain: example_value fqdn: example_value privateFQDN: example_value azurePortalFQDN: example_value enableRBAC: true supportPlan: KubernetesOfficial disableLocalAccounts: true nodeResourceGroup: example_value agentPoolProfiles: - {} identityProfile: example_value addonProfiles: example_value diskEncryptionSetID: '500123' default: description: Error response describing why the operation failed. content: application/json: schema: $ref: '#/components/schemas/CloudError' examples: ManagedclustersUpdatetagsdefaultExample: summary: Default ManagedClusters_UpdateTags default response x-microcks-default: true value: error: code: example_value message: example_value target: example_value details: - code: example_value message: example_value target: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: operationId: ManagedClusters_Delete summary: Azure Kubernetes Service Delete a Managed Cluster description: Deletes a managed cluster. tags: - Managed Clusters parameters: - $ref: '#/components/parameters/SubscriptionIdParameter' - $ref: '#/components/parameters/ResourceGroupNameParameter' - $ref: '#/components/parameters/ResourceNameParameter' - $ref: '#/components/parameters/ApiVersionParameter' responses: '202': description: Accepted. The delete operation will complete asynchronously. headers: Azure-AsyncOperation: description: URL to query for status of the asynchronous operation. schema: type: string Location: description: URL to query for the operation result. schema: type: string Retry-After: description: Suggested delay in seconds to check on operation status. schema: type: integer '204': description: No Content. The resource does not exist. default: description: Error response describing why the operation failed. content: application/json: schema: $ref: '#/components/schemas/CloudError' examples: ManagedclustersDeletedefaultExample: summary: Default ManagedClusters_Delete default response x-microcks-default: true value: error: code: example_value message: example_value target: example_value details: - code: example_value message: example_value target: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/upgradeProfiles/default : get: operationId: ManagedClusters_GetUpgradeProfile summary: Azure Kubernetes Service Get Upgrade Profile for a Managed Cluster description: Gets the upgrade profile of a managed cluster. tags: - Managed Clusters parameters: - $ref: '#/components/parameters/SubscriptionIdParameter' - $ref: '#/components/parameters/ResourceGroupNameParameter' - $ref: '#/components/parameters/ResourceNameParameter' - $ref: '#/components/parameters/ApiVersionParameter' responses: '200': description: OK. The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/ManagedClusterUpgradeProfile' examples: ManagedclustersGetupgradeprofile200Example: summary: Default ManagedClusters_GetUpgradeProfile 200 response x-microcks-default: true value: id: abc123 name: Example Title type: example_value properties: controlPlaneProfile: kubernetesVersion: example_value osType: Linux upgrades: - {} agentPoolProfiles: - kubernetesVersion: example_value osType: Linux upgrades: {} default: description: Error response describing why the operation failed. content: application/json: schema: $ref: '#/components/schemas/CloudError' examples: ManagedclustersGetupgradeprofiledefaultExample: summary: Default ManagedClusters_GetUpgradeProfile default response x-microcks-default: true value: error: code: example_value message: example_value target: example_value details: - code: example_value message: example_value target: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterAdminCredential : post: operationId: ManagedClusters_ListClusterAdminCredentials summary: Azure Kubernetes Service List Cluster Admin Credentials description: Lists the admin credentials of a managed cluster. tags: - Managed Clusters parameters: - $ref: '#/components/parameters/SubscriptionIdParameter' - $ref: '#/components/parameters/ResourceGroupNameParameter' - $ref: '#/components/parameters/ResourceNameParameter' - $ref: '#/components/parameters/ApiVersionParameter' responses: '200': description: OK. The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/CredentialResults' examples: ManagedclustersListclusteradmincredentials200Example: summary: Default ManagedClusters_ListClusterAdminCredentials 200 response x-microcks-default: true value: kubeconfigs: - name: Example Title value: example_value default: description: Error response describing why the operation failed. content: application/json: schema: $ref: '#/components/schemas/CloudError' examples: ManagedclustersListclusteradmincredentialsdefaultExample: summary: Default ManagedClusters_ListClusterAdminCredentials default response x-microcks-default: true value: error: code: example_value message: example_value target: example_value details: - code: example_value message: example_value target: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterUserCredential : post: operationId: ManagedClusters_ListClusterUserCredentials summary: Azure Kubernetes Service List Cluster User Credentials description: Lists the user credentials of a managed cluster. tags: - Managed Clusters parameters: - $ref: '#/components/parameters/SubscriptionIdParameter' - $ref: '#/components/parameters/ResourceGroupNameParameter' - $ref: '#/components/parameters/ResourceNameParameter' - $ref: '#/components/parameters/ApiVersionParameter' responses: '200': description: OK. The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/CredentialResults' examples: ManagedclustersListclusterusercredentials200Example: summary: Default ManagedClusters_ListClusterUserCredentials 200 response x-microcks-default: true value: kubeconfigs: - name: Example Title value: example_value default: description: Error response describing why the operation failed. content: application/json: schema: $ref: '#/components/schemas/CloudError' examples: ManagedclustersListclusterusercredentialsdefaultExample: summary: Default ManagedClusters_ListClusterUserCredentials default response x-microcks-default: true value: error: code: example_value message: example_value target: example_value details: - code: example_value message: example_value target: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterMonitoringUserCredential : post: operationId: ManagedClusters_ListClusterMonitoringUserCredentials summary: Azure Kubernetes Service List Cluster Monitoring User Credentials description: Lists the cluster monitoring user credentials of a managed cluster. tags: - Managed Clusters parameters: - $ref: '#/components/parameters/SubscriptionIdParameter' - $ref: '#/components/parameters/ResourceGroupNameParameter' - $ref: '#/components/parameters/ResourceNameParameter' - $ref: '#/components/parameters/ApiVersionParameter' responses: '200': description: OK. The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/CredentialResults' examples: ManagedclustersListclustermonitoringusercredentials200Example: summary: Default ManagedClusters_ListClusterMonitoringUserCredentials 200 response x-microcks-default: true value: kubeconfigs: - name: Example Title value: example_value default: description: Error response describing why the operation failed. content: application/json: schema: $ref: '#/components/schemas/CloudError' examples: ManagedclustersListclustermonitoringusercredentialsdefaultExample: summary: Default ManagedClusters_ListClusterMonitoringUserCredentials default response x-microcks-default: true value: error: code: example_value message: example_value target: example_value details: - code: example_value message: example_value target: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/rotateClusterCertificates : post: operationId: ManagedClusters_RotateClusterCertificates summary: Azure Kubernetes Service Rotate Cluster Certificates description: Rotates the certificates of a managed cluster. tags: - Managed Clusters parameters: - $ref: '#/components/parameters/SubscriptionIdParameter' - $ref: '#/components/parameters/ResourceGroupNameParameter' - $ref: '#/components/parameters/ResourceNameParameter' - $ref: '#/components/parameters/ApiVersionParameter' responses: '202': description: Accepted. The operation will complete asynchronously. headers: Azure-AsyncOperation: description: URL to query for status of the asynchronous operation. schema: type: string Location: description: URL to query for the operation result. schema: type: string Retry-After: description: Suggested delay in seconds. schema: type: integer '204': description: No Content. default: description: Error response describing why the operation failed. content: application/json: schema: $ref: '#/components/schemas/CloudError' examples: ManagedclustersRotateclustercertificatesdefaultExample: summary: Default ManagedClusters_RotateClusterCertificates default response x-microcks-default: true value: error: code: example_value message: example_value target: example_value details: - code: example_value message: example_value target: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/stop : post: operationId: ManagedClusters_Stop summary: Azure Kubernetes Service Stop a Managed Cluster description: >- Stops a previously running managed cluster. This can only be performed on Azure Virtual Machine Scale Set backed clusters. Stopping a cluster stops the control plane and agent nodes entirely while maintaining all object and cluster state. tags: - Managed Clusters parameters: - $ref: '#/components/parameters/SubscriptionIdParameter' - $ref: '#/components/parameters/ResourceGroupNameParameter' - $ref: '#/components/parameters/ResourceNameParameter' - $ref: '#/components/parameters/ApiVersionParameter' responses: '202': description: Accepted. The operation will complete asynchronously. headers: Azure-AsyncOperation: description: URL to query for status of the asynchronous operation. schema: type: string Location: description: URL to query for the operation result. schema: type: string Retry-After: description: Suggested delay in seconds. schema: type: integer '204': description: No Content. default: description: Error response describing why the operation failed. content: application/json: schema: $ref: '#/components/schemas/CloudError' examples: ManagedclustersStopdefaultExample: summary: Default ManagedClusters_Stop default response x-microcks-default: true value: error: code: example_value message: example_value target: example_value details: - code: example_value message: example_value target: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/start : post: operationId: ManagedClusters_Start summary: Azure Kubernetes Service Start a Managed Cluster description: Starts a previously stopped managed cluster. tags: - Managed Clusters parameters: - $ref: '#/components/parameters/SubscriptionIdParameter' - $ref: '#/components/parameters/ResourceGroupNameParameter' - $ref: '#/components/parameters/ResourceNameParameter' - $ref: '#/components/parameters/ApiVersionParameter' responses: '202': description: Accepted. The operation will complete asynchronously. headers: Azure-AsyncOperation: description: URL to query for status of the asynchronous operation. schema: type: string Location: description: URL to query for the operation result. schema: type: string Retry-After: description: Suggested delay in seconds. schema: type: integer '204': description: No Content. default: description: Error response describing why the operation failed. content: application/json: schema: $ref: '#/components/schemas/CloudError' examples: ManagedclustersStartdefaultExample: summary: Default ManagedClusters_Start default response x-microcks-default: true value: error: code: example_value message: example_value target: example_value details: - code: example_value message: example_value target: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/runCommand : post: operationId: ManagedClusters_RunCommand summary: Azure Kubernetes Service Run a Command on a Managed Cluster description: >- Submits a command to run against the Managed Cluster. This is useful for running kubectl commands on a private cluster. tags: - Managed Clusters parameters: - $ref: '#/components/parameters/SubscriptionIdParameter' - $ref: '#/components/parameters/ResourceGroupNameParameter' - $ref: '#/components/parameters/ResourceNameParameter' - $ref: '#/components/parameters/ApiVersionParameter' requestBody: required: true description: The run command request. content: application/json: schema: $ref: '#/components/schemas/RunCommandRequest' examples: ManagedclustersRuncommandRequestExample: summary: Default ManagedClusters_RunCommand request x-microcks-default: true value: command: example_value context: example_value clusterToken: example_value responses: '200': description: OK. Command completed synchronously. content: application/json: schema: $ref: '#/components/schemas/RunCommandResult' examples: ManagedclustersRuncommand200Example: summary: Default ManagedClusters_RunCommand 200 response x-microcks-default: true value: id: abc123 properties: provisioningState: example_value exitCode: 10 startedAt: '2026-01-15T10:30:00Z' finishedAt: '2026-01-15T10:30:00Z' logs: example_value reason: example_value '202': description: Accepted. The command will complete asynchronously. headers: Azure-AsyncOperation: description: URL to query for status of the asynchronous operation. schema: type: string Location: description: URL to query for the operation result. schema: type: string Retry-After: description: Suggested delay in seconds. schema: type: integer default: description: Error response describing why the operation failed. content: application/json: schema: $ref: '#/components/schemas/CloudError' examples: ManagedclustersRuncommanddefaultExample: summary: Default ManagedClusters_RunCommand default response x-microcks-default: true value: error: code: example_value message: example_value target: example_value details: - code: example_value message: example_value target: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/abort : post: operationId: ManagedClusters_AbortLatestOperation summary: Azure Kubernetes Service Abort the Latest Operation on a Managed Cluster description: >- Aborts the currently running operation on the managed cluster. The Managed Cluster will be moved to a Canceling state and eventually to a Canceled state when cancellation finishes. tags: - Managed Clusters parameters: - $ref: '#/components/parameters/SubscriptionIdParameter' - $ref: '#/components/parameters/ResourceGroupNameParameter' - $ref: '#/components/parameters/ResourceNameParameter' - $ref: '#/components/parameters/ApiVersionParameter' responses: '202': description: Accepted. The operation will complete asynchronously. headers: Azure-AsyncOperation: description: URL to query for status of the asynchronous operation. schema: type: string Location: description: URL to query for the operation result. schema: type: string Retry-After: description: Suggested delay in seconds. schema: type: integer '204': description: No Content. No operation running. default: description: Error response describing why the operation failed. content: application/json: schema: $ref: '#/components/schemas/CloudError' examples: ManagedclustersAbortlatestoperationdefaultExample: summary: Default ManagedClusters_AbortLatestOperation default response x-microcks-default: true value: error: code: example_value message: example_value target: example_value details: - code: example_value message: example_value target: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools : get: operationId: AgentPools_List summary: Azure Kubernetes Service List Agent Pools description: Gets a list of agent pools in the specified managed cluster. tags: - Agent Pools parameters: - $ref: '#/components/parameters/SubscriptionIdParameter' - $ref: '#/components/parameters/ResourceGroupNameParameter' - $ref: '#/components/parameters/ResourceNameParameter' - $ref: '#/components/parameters/ApiVersionParameter' responses: '200': description: OK. The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/AgentPoolListResult' examples: AgentpoolsList200Example: summary: Default AgentPools_List 200 response x-microcks-default: true value: value: - id: abc123 name: Example Title type: example_value nextLink: example_value default: description: Error response describing why the operation failed. content: application/json: schema: $ref: '#/components/schemas/CloudError' examples: AgentpoolsListdefaultExample: summary: Default AgentPools_List default response x-microcks-default: true value: error: code: example_value message: example_value target: example_value details: - code: example_value message: example_value target: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName} : get: operationId: AgentPools_Get summary: Azure Kubernetes Service Get an Agent Pool description: Gets the specified managed cluster agent pool. tags: - Agent Pools parameters: - $ref: '#/components/parameters/SubscriptionIdParameter' - $ref: '#/components/parameters/ResourceGroupNameParameter' - $ref: '#/components/parameters/ResourceNameParameter' - $ref: '#/components/parameters/AgentPoolNameParameter' - $ref: '#/components/parameters/ApiVersionParameter' responses: '200': description: OK. The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/AgentPool' examples: AgentpoolsGet200Example: summary: Default AgentPools_Get 200 response x-microcks-default: true value: id: abc123 name: Example Title type: example_value properties: provisioningState: example_value count: 10 vmSize: example_value osDiskSizeGB: 10 osDiskType: Managed kubeletDiskType: OS maxPods: 10 osType: Linux osSKU: Ubuntu type: VirtualMachineScaleSets mode: System orchestratorVersion: example_value currentOrchestratorVersion: example_value nodeImageVersion: example_value enableAutoScaling: true minCount: 10 maxCount: 10 scaleSetPriority: Spot scaleSetEvictionPolicy: Delete spotMaxPrice: 42.5 scaleDownMode: Delete vnetSubnetID: '500123' podSubnetID: '500123' enableNodePublicIP: true nodePublicIPPrefixID: '500123' enableEncryptionAtHost: true enableFIPS: true enableUltraSSD: true nodeLabels: example_value nodeTaints: - {} tags: example_value proximityPlacementGroupID: '500123' availabilityZones: - {} workloadRuntime: OCIContainer messageOfTheDay: example_value default: description: Error response describing why the operation failed. content: application/json: schema: $ref: '#/components/schemas/CloudError' examples: AgentpoolsGetdefaultExample: summary: Default AgentPools_Get default response x-microcks-default: true value: error: code: example_value message: example_value target: example_value details: - code: example_value message: example_value target: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK put: operationId: AgentPools_CreateOrUpdate summary: Azure Kubernetes Service Create or Update an Agent Pool description: Creates or updates an agent pool in the specified managed cluster. tags: - Agent Pools parameters: - $ref: '#/components/parameters/SubscriptionIdParameter' - $ref: '#/components/parameters/ResourceGroupNameParameter' - $ref: '#/components/parameters/ResourceNameParameter' - $ref: '#/components/parameters/AgentPoolNameParameter' - $ref: '#/components/parameters/ApiVersionParameter' - name: if-match in: header description: >- The request should only proceed if an entity matches this string. schema: type: string example: example_value - name: if-none-match in: header description: >- The request should only proceed if no entity matches this string. schema: type: string example: example_value requestBody: required: true description: The agent pool to create or update. content: application/json: schema: $ref: '#/components/schemas/AgentPool' examples: AgentpoolsCreateorupdateRequestExample: summary: Default AgentPools_CreateOrUpdate request x-microcks-default: true value: id: abc123 name: Example Title type: example_value properties: provisioningState: example_value count: 10 vmSize: example_value osDiskSizeGB: 10 osDiskType: Managed kubeletDiskType: OS maxPods: 10 osType: Linux osSKU: Ubuntu type: VirtualMachineScaleSets mode: System orchestratorVersion: example_value currentOrchestratorVersion: example_value nodeImageVersion: example_value enableAutoScaling: true minCount: 10 maxCount: 10 scaleSetPriority: Spot scaleSetEvictionPolicy: Delete spotMaxPrice: 42.5 scaleDownMode: Delete vnetSubnetID: '500123' podSubnetID: '500123' enableNodePublicIP: true nodePublicIPPrefixID: '500123' enableEncryptionAtHost: true enableFIPS: true enableUltraSSD: true nodeLabels: example_value nodeTaints: - {} tags: example_value proximityPlacementGroupID: '500123' availabilityZones: - {} workloadRuntime: OCIContainer messageOfTheDay: example_value responses: '200': description: OK. The update operation has succeeded. content: application/json: schema: $ref: '#/components/schemas/AgentPool' examples: AgentpoolsCreateorupdate200Example: summary: Default AgentPools_CreateOrUpdate 200 response x-microcks-default: true value: id: abc123 name: Example Title type: example_value properties: provisioningState: example_value count: 10 vmSize: example_value osDiskSizeGB: 10 osDiskType: Managed kubeletDiskType: OS maxPods: 10 osType: Linux osSKU: Ubuntu type: VirtualMachineScaleSets mode: System orchestratorVersion: example_value currentOrchestratorVersion: example_value nodeImageVersion: example_value enableAutoScaling: true minCount: 10 maxCount: 10 scaleSetPriority: Spot scaleSetEvictionPolicy: Delete spotMaxPrice: 42.5 scaleDownMode: Delete vnetSubnetID: '500123' podSubnetID: '500123' enableNodePublicIP: true nodePublicIPPrefixID: '500123' enableEncryptionAtHost: true enableFIPS: true enableUltraSSD: true nodeLabels: example_value nodeTaints: - {} tags: example_value proximityPlacementGroupID: '500123' availabilityZones: - {} workloadRuntime: OCIContainer messageOfTheDay: example_value '201': description: Created. The create operation has succeeded. headers: Azure-AsyncOperation: description: URL to query for status of the asynchronous operation. schema: type: string Retry-After: description: Suggested delay in seconds to check on operation status. schema: type: integer content: application/json: schema: $ref: '#/components/schemas/AgentPool' examples: AgentpoolsCreateorupdate201Example: summary: Default AgentPools_CreateOrUpdate 201 response x-microcks-default: true value: id: abc123 name: Example Title type: example_value properties: provisioningState: example_value count: 10 vmSize: example_value osDiskSizeGB: 10 osDiskType: Managed kubeletDiskType: OS maxPods: 10 osType: Linux osSKU: Ubuntu type: VirtualMachineScaleSets mode: System orchestratorVersion: example_value currentOrchestratorVersion: example_value nodeImageVersion: example_value enableAutoScaling: true minCount: 10 maxCount: 10 scaleSetPriority: Spot scaleSetEvictionPolicy: Delete spotMaxPrice: 42.5 scaleDownMode: Delete vnetSubnetID: '500123' podSubnetID: '500123' enableNodePublicIP: true nodePublicIPPrefixID: '500123' enableEncryptionAtHost: true enableFIPS: true enableUltraSSD: true nodeLabels: example_value nodeTaints: - {} tags: example_value proximityPlacementGroupID: '500123' availabilityZones: - {} workloadRuntime: OCIContainer messageOfTheDay: example_value default: description: Error response describing why the operation failed. content: application/json: schema: $ref: '#/components/schemas/CloudError' examples: AgentpoolsCreateorupdatedefaultExample: summary: Default AgentPools_CreateOrUpdate default response x-microcks-default: true value: error: code: example_value message: example_value target: example_value details: - code: example_value message: example_value target: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: operationId: AgentPools_Delete summary: Azure Kubernetes Service Delete an Agent Pool description: Deletes an agent pool in the specified managed cluster. tags: - Agent Pools parameters: - $ref: '#/components/parameters/SubscriptionIdParameter' - $ref: '#/components/parameters/ResourceGroupNameParameter' - $ref: '#/components/parameters/ResourceNameParameter' - $ref: '#/components/parameters/AgentPoolNameParameter' - $ref: '#/components/parameters/ApiVersionParameter' responses: '202': description: Accepted. The delete operation will complete asynchronously. headers: Azure-AsyncOperation: description: URL to query for status of the asynchronous operation. schema: type: string Location: description: URL to query for the operation result. schema: type: string Retry-After: description: Suggested delay in seconds to check on operation status. schema: type: integer '204': description: No Content. The resource does not exist. default: description: Error response describing why the operation failed. content: application/json: schema: $ref: '#/components/schemas/CloudError' examples: AgentpoolsDeletedefaultExample: summary: Default AgentPools_Delete default response x-microcks-default: true value: error: code: example_value message: example_value target: example_value details: - code: example_value message: example_value target: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/upgradeProfiles/default : get: operationId: AgentPools_GetUpgradeProfile summary: Azure Kubernetes Service Get the Upgrade Profile for an Agent Pool description: Gets the upgrade profile for an agent pool. tags: - Agent Pools parameters: - $ref: '#/components/parameters/SubscriptionIdParameter' - $ref: '#/components/parameters/ResourceGroupNameParameter' - $ref: '#/components/parameters/ResourceNameParameter' - $ref: '#/components/parameters/AgentPoolNameParameter' - $ref: '#/components/parameters/ApiVersionParameter' responses: '200': description: OK. The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/AgentPoolUpgradeProfile' examples: AgentpoolsGetupgradeprofile200Example: summary: Default AgentPools_GetUpgradeProfile 200 response x-microcks-default: true value: id: abc123 name: Example Title type: example_value properties: kubernetesVersion: example_value osType: Linux upgrades: - kubernetesVersion: example_value isPreview: true latestNodeImageVersion: example_value default: description: Error response describing why the operation failed. content: application/json: schema: $ref: '#/components/schemas/CloudError' examples: AgentpoolsGetupgradeprofiledefaultExample: summary: Default AgentPools_GetUpgradeProfile default response x-microcks-default: true value: error: code: example_value message: example_value target: example_value details: - code: example_value message: example_value target: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/availableAgentPoolVersions : get: operationId: AgentPools_GetAvailableAgentPoolVersions summary: Azure Kubernetes Service Get Available Agent Pool Versions description: Gets a list of supported Kubernetes versions for the specified agent pool. tags: - Agent Pools parameters: - $ref: '#/components/parameters/SubscriptionIdParameter' - $ref: '#/components/parameters/ResourceGroupNameParameter' - $ref: '#/components/parameters/ResourceNameParameter' - $ref: '#/components/parameters/AgentPoolNameParameter' - $ref: '#/components/parameters/ApiVersionParameter' responses: '200': description: OK. The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/AgentPoolAvailableVersions' examples: AgentpoolsGetavailableagentpoolversions200Example: summary: Default AgentPools_GetAvailableAgentPoolVersions 200 response x-microcks-default: true value: id: abc123 name: Example Title type: example_value properties: agentPoolVersions: - default: true kubernetesVersion: example_value isPreview: true default: description: Error response describing why the operation failed. content: application/json: schema: $ref: '#/components/schemas/CloudError' examples: AgentpoolsGetavailableagentpoolversionsdefaultExample: summary: Default AgentPools_GetAvailableAgentPoolVersions default response x-microcks-default: true value: error: code: example_value message: example_value target: example_value details: - code: example_value message: example_value target: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/upgradeNodeImageVersion : post: operationId: AgentPools_UpgradeNodeImageVersion summary: Azure Kubernetes Service Upgrade Node Image Version description: Upgrades the node image version of an agent pool to the latest. tags: - Agent Pools parameters: - $ref: '#/components/parameters/SubscriptionIdParameter' - $ref: '#/components/parameters/ResourceGroupNameParameter' - $ref: '#/components/parameters/ResourceNameParameter' - $ref: '#/components/parameters/AgentPoolNameParameter' - $ref: '#/components/parameters/ApiVersionParameter' responses: '200': description: OK. The agent pool node image has been upgraded. '202': description: Accepted. The operation will complete asynchronously. headers: Azure-AsyncOperation: description: URL to query for status of the asynchronous operation. schema: type: string Location: description: URL to query for the operation result. schema: type: string Retry-After: description: Suggested delay in seconds. schema: type: integer default: description: Error response describing why the operation failed. content: application/json: schema: $ref: '#/components/schemas/CloudError' examples: AgentpoolsUpgradenodeimageversiondefaultExample: summary: Default AgentPools_UpgradeNodeImageVersion default response x-microcks-default: true value: error: code: example_value message: example_value target: example_value details: - code: example_value message: example_value target: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/abort : post: operationId: AgentPools_AbortLatestOperation summary: Azure Kubernetes Service Abort Latest Operation on an Agent Pool description: Aborts the currently running operation on the agent pool. tags: - Agent Pools parameters: - $ref: '#/components/parameters/SubscriptionIdParameter' - $ref: '#/components/parameters/ResourceGroupNameParameter' - $ref: '#/components/parameters/ResourceNameParameter' - $ref: '#/components/parameters/AgentPoolNameParameter' - $ref: '#/components/parameters/ApiVersionParameter' responses: '202': description: Accepted. The operation will complete asynchronously. headers: Azure-AsyncOperation: description: URL to query for status of the asynchronous operation. schema: type: string Location: description: URL to query for the operation result. schema: type: string Retry-After: description: Suggested delay in seconds. schema: type: integer '204': description: No Content. No operation running. default: description: Error response describing why the operation failed. content: application/json: schema: $ref: '#/components/schemas/CloudError' examples: AgentpoolsAbortlatestoperationdefaultExample: summary: Default AgentPools_AbortLatestOperation default response x-microcks-default: true value: error: code: example_value message: example_value target: example_value details: - code: example_value message: example_value target: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/deleteMachines : post: operationId: AgentPools_DeleteMachines summary: Azure Kubernetes Service Delete Specific Machines in an Agent Pool description: Deletes specific machines in an agent pool. tags: - Agent Pools parameters: - $ref: '#/components/parameters/SubscriptionIdParameter' - $ref: '#/components/parameters/ResourceGroupNameParameter' - $ref: '#/components/parameters/ResourceNameParameter' - $ref: '#/components/parameters/AgentPoolNameParameter' - $ref: '#/components/parameters/ApiVersionParameter' requestBody: required: true description: The machine names to delete. content: application/json: schema: $ref: '#/components/schemas/AgentPoolDeleteMachinesParameter' examples: AgentpoolsDeletemachinesRequestExample: summary: Default AgentPools_DeleteMachines request x-microcks-default: true value: machineNames: - example_value responses: '202': description: Accepted. The operation will complete asynchronously. headers: Azure-AsyncOperation: description: URL to query for status of the asynchronous operation. schema: type: string Location: description: URL to query for the operation result. schema: type: string Retry-After: description: Suggested delay in seconds. schema: type: integer default: description: Error response describing why the operation failed. content: application/json: schema: $ref: '#/components/schemas/CloudError' examples: AgentpoolsDeletemachinesdefaultExample: summary: Default AgentPools_DeleteMachines default response x-microcks-default: true value: error: code: example_value message: example_value target: example_value details: - code: example_value message: example_value target: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK components: securitySchemes: azure_auth: type: oauth2 description: Azure Active Directory OAuth2 Flow. flows: implicit: authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize scopes: user_impersonation: Impersonate your user account parameters: SubscriptionIdParameter: name: subscriptionId in: path required: true description: The ID of the target subscription. Must be a valid UUID. schema: type: string format: uuid ResourceGroupNameParameter: name: resourceGroupName in: path required: true description: >- The name of the resource group. The name is case insensitive. schema: type: string minLength: 1 maxLength: 90 ResourceNameParameter: name: resourceName in: path required: true description: The name of the managed cluster resource. schema: type: string minLength: 1 maxLength: 63 pattern: '^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$' AgentPoolNameParameter: name: agentPoolName in: path required: true description: The name of the agent pool. schema: type: string minLength: 1 maxLength: 12 pattern: '^[a-z][a-z0-9]{0,11}$' ApiVersionParameter: name: api-version in: query required: true description: The API version to use for this operation. schema: type: string default: '2025-10-01' schemas: ManagedCluster: type: object description: Managed cluster resource representing an Azure Kubernetes Service cluster. required: - location properties: id: type: string readOnly: true description: >- Fully qualified resource ID for the resource. Example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName} example: abc123 name: type: string readOnly: true description: The name of the resource. example: Example Title type: type: string readOnly: true description: >- The type of the resource. Example: Microsoft.ContainerService/managedClusters example: example_value location: type: string description: The geo-location where the resource lives. example: example_value tags: type: object additionalProperties: type: string description: Resource tags. example: example_value sku: $ref: '#/components/schemas/ManagedClusterSKU' kind: type: string description: >- This is primarily used to expose different UI experiences in the portal for different kinds. example: example_value identity: $ref: '#/components/schemas/ManagedClusterIdentity' extendedLocation: $ref: '#/components/schemas/ExtendedLocation' systemData: $ref: '#/components/schemas/SystemData' readOnly: true properties: $ref: '#/components/schemas/ManagedClusterProperties' ManagedClusterProperties: type: object description: Properties of the managed cluster. properties: provisioningState: type: string readOnly: true description: >- The current provisioning state of the managed cluster resource. example: example_value powerState: $ref: '#/components/schemas/PowerState' readOnly: true maxAgentPools: type: integer format: int32 readOnly: true description: The max number of agent pools for the managed cluster. example: 10 kubernetesVersion: type: string description: >- The version of Kubernetes specified by the user. Both patch version (e.g. 1.20.13) and minor version (e.g. 1.20) are supported. When a minor version is specified, the latest supported patch version is chosen automatically. example: example_value currentKubernetesVersion: type: string readOnly: true description: >- The version of Kubernetes the Managed Cluster is running. example: example_value dnsPrefix: type: string description: >- This cannot be updated once the Managed Cluster has been created. example: example_value fqdnSubdomain: type: string description: >- This cannot be updated once the Managed Cluster has been created. Used only with private clusters with custom private DNS zone. example: example_value fqdn: type: string readOnly: true description: The FQDN of the master pool. example: example_value privateFQDN: type: string readOnly: true description: The FQDN of private cluster. example: example_value azurePortalFQDN: type: string readOnly: true description: >- The special FQDN used by the Azure Portal to access the Managed Cluster. It is only set for private cluster enabled clusters. example: example_value enableRBAC: type: boolean description: Whether to enable Kubernetes Role-Based Access Control. example: true supportPlan: type: string description: The support plan for the Managed Cluster. enum: - KubernetesOfficial - AKSLongTermSupport default: KubernetesOfficial example: KubernetesOfficial disableLocalAccounts: type: boolean description: >- If set to true, getting static credentials will be disabled for this cluster. example: true nodeResourceGroup: type: string description: >- The name of the resource group containing agent pool nodes. example: example_value nodeResourceGroupProfile: $ref: '#/components/schemas/ManagedClusterNodeResourceGroupProfile' agentPoolProfiles: type: array items: $ref: '#/components/schemas/ManagedClusterAgentPoolProfile' description: The agent pool properties. example: [] linuxProfile: $ref: '#/components/schemas/ContainerServiceLinuxProfile' windowsProfile: $ref: '#/components/schemas/ManagedClusterWindowsProfile' servicePrincipalProfile: $ref: '#/components/schemas/ManagedClusterServicePrincipalProfile' identityProfile: type: object additionalProperties: $ref: '#/components/schemas/UserAssignedIdentity' description: Identities associated with the cluster. example: example_value addonProfiles: type: object additionalProperties: $ref: '#/components/schemas/ManagedClusterAddonProfile' description: The profile of managed cluster add-ons. example: example_value networkProfile: $ref: '#/components/schemas/ContainerServiceNetworkProfile' aadProfile: $ref: '#/components/schemas/ManagedClusterAADProfile' autoScalerProfile: $ref: '#/components/schemas/ManagedClusterAutoScalerProfile' autoUpgradeProfile: $ref: '#/components/schemas/ManagedClusterAutoUpgradeProfile' upgradeSettings: $ref: '#/components/schemas/ClusterUpgradeSettings' apiServerAccessProfile: $ref: '#/components/schemas/ManagedClusterAPIServerAccessProfile' diskEncryptionSetID: type: string description: >- The Resource ID of the disk encryption set to use for enabling encryption at rest. example: '500123' securityProfile: $ref: '#/components/schemas/ManagedClusterSecurityProfile' storageProfile: $ref: '#/components/schemas/ManagedClusterStorageProfile' ingressProfile: $ref: '#/components/schemas/ManagedClusterIngressProfile' oidcIssuerProfile: $ref: '#/components/schemas/ManagedClusterOIDCIssuerProfile' metricsProfile: $ref: '#/components/schemas/ManagedClusterMetricsProfile' azureMonitorProfile: $ref: '#/components/schemas/ManagedClusterAzureMonitorProfile' serviceMeshProfile: $ref: '#/components/schemas/ServiceMeshProfile' workloadAutoScalerProfile: $ref: '#/components/schemas/ManagedClusterWorkloadAutoScalerProfile' ManagedClusterAgentPoolProfile: type: object description: Profile for the container service agent pool. required: - name properties: name: type: string description: >- The unique name of the agent pool profile in the context of the subscription and resource group. minLength: 1 maxLength: 12 pattern: '^[a-z][a-z0-9]{0,11}$' example: Example Title count: type: integer format: int32 description: >- Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 1000 (inclusive) for user pools and in the range of 1 to 1000 (inclusive) for system pools. example: 10 vmSize: type: string description: >- The size of the agent VMs. Example: Standard_DS2_v2 example: example_value osDiskSizeGB: type: integer format: int32 minimum: 0 maximum: 2048 description: >- OS Disk Size in GB to be used to specify the disk size for every machine in the master/agent pool. example: 10 osDiskType: type: string description: The OS disk type to be used for machines in the agent pool. enum: - Managed - Ephemeral example: Managed kubeletDiskType: type: string description: >- Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage. enum: - OS - Temporary example: OS maxPods: type: integer format: int32 description: The maximum number of pods that can run on a node. example: 10 osType: type: string description: The operating system type. enum: - Linux - Windows default: Linux example: Linux osSKU: type: string description: >- Specifies the OS SKU used by the agent pool. enum: - Ubuntu - AzureLinux - CBLMariner - Windows2019 - Windows2022 - WindowsAnnual example: Ubuntu type: type: string description: The type of Agent Pool. enum: - VirtualMachineScaleSets - AvailabilitySet - VirtualMachines example: VirtualMachineScaleSets mode: type: string description: >- The mode of an agent pool. A cluster must have at least one System agent pool at all times. enum: - System - User - Gateway example: System orchestratorVersion: type: string description: >- The version of Kubernetes running on the Agent Pool. example: example_value currentOrchestratorVersion: type: string readOnly: true description: >- The version of Kubernetes the Agent Pool is running. example: example_value nodeImageVersion: type: string readOnly: true description: The version of node image. example: example_value enableAutoScaling: type: boolean description: Whether to enable auto-scaler. example: true minCount: type: integer format: int32 description: The minimum number of nodes for auto-scaling. example: 10 maxCount: type: integer format: int32 description: The maximum number of nodes for auto-scaling. example: 10 scaleSetPriority: type: string description: The Virtual Machine Scale Set priority. enum: - Spot - Regular default: Regular example: Spot scaleSetEvictionPolicy: type: string description: The Virtual Machine Scale Set eviction policy. enum: - Delete - Deallocate default: Delete example: Delete spotMaxPrice: type: number format: float description: >- The maximum price (in US Dollars) you are willing to pay for spot instances. Possible values are any decimal value greater than zero or -1 which indicates that default price is up-to on-demand. example: 42.5 scaleDownMode: type: string description: >- Describes how VMs are added to or removed from Agent Pools. enum: - Delete - Deallocate default: Delete example: Delete vnetSubnetID: type: string description: >- The ID of the subnet which agent pool nodes and optionally pods will join on startup. example: '500123' podSubnetID: type: string description: >- The ID of the subnet which pods will join when launched. example: '500123' enableNodePublicIP: type: boolean description: >- Whether each node is allocated its own public IP. example: true nodePublicIPPrefixID: type: string description: >- The public IP prefix ID for the nodes in the agent pool. example: '500123' enableEncryptionAtHost: type: boolean description: >- Whether to enable host-based OS and data drive encryption. example: true enableFIPS: type: boolean description: >- Whether to use a FIPS-enabled OS. example: true enableUltraSSD: type: boolean description: Whether to enable UltraSSD. example: true nodeLabels: type: object additionalProperties: type: string description: >- The node labels to be persisted across all nodes in agent pool. example: example_value nodeTaints: type: array items: type: string description: >- The taints added to new nodes during node pool create and scale. example: [] tags: type: object additionalProperties: type: string description: >- The tags to be persisted on the agent pool virtual machine scale set. example: example_value proximityPlacementGroupID: type: string description: The ID for Proximity Placement Group. example: '500123' upgradeSettings: $ref: '#/components/schemas/AgentPoolUpgradeSettings' powerState: $ref: '#/components/schemas/PowerState' availabilityZones: type: array items: type: string description: >- The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is VirtualMachineScaleSets. example: [] creationData: $ref: '#/components/schemas/CreationData' workloadRuntime: type: string description: Determines the type of workload a node can run. enum: - OCIContainer - WasmWasi - KataMshvVmIsolation example: OCIContainer messageOfTheDay: type: string description: >- A base64-encoded string which will be written to /etc/motd after decoding. Applicable only for Linux nodes. example: example_value AgentPool: type: object description: Agent pool resource within a managed cluster. properties: id: type: string readOnly: true description: Resource ID. example: abc123 name: type: string readOnly: true description: >- The name of the resource that is unique within a resource group. example: Example Title type: type: string readOnly: true description: Resource type. example: example_value properties: $ref: '#/components/schemas/AgentPoolProperties' AgentPoolProperties: type: object description: Properties for the container service agent pool profile. properties: provisioningState: type: string readOnly: true description: The current deployment or provisioning state. example: example_value count: type: integer format: int32 description: >- Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 1000 (inclusive) for user pools and in the range of 1 to 1000 (inclusive) for system pools. The default value is 1. example: 10 vmSize: type: string description: The size of the agent VMs. example: example_value osDiskSizeGB: type: integer format: int32 minimum: 0 maximum: 2048 description: OS Disk Size in GB. example: 10 osDiskType: type: string enum: - Managed - Ephemeral description: The OS disk type. example: Managed kubeletDiskType: type: string enum: - OS - Temporary description: Kubelet disk type. example: OS maxPods: type: integer format: int32 description: The maximum number of pods that can run on a node. example: 10 osType: type: string enum: - Linux - Windows default: Linux description: The operating system type. example: Linux osSKU: type: string enum: - Ubuntu - AzureLinux - CBLMariner - Windows2019 - Windows2022 - WindowsAnnual description: Specifies the OS SKU used by the agent pool. example: Ubuntu type: type: string enum: - VirtualMachineScaleSets - AvailabilitySet - VirtualMachines description: The type of Agent Pool. example: VirtualMachineScaleSets mode: type: string enum: - System - User - Gateway description: A cluster must have at least one System agent pool at all times. example: System orchestratorVersion: type: string description: The version of Kubernetes running on the Agent Pool. example: example_value currentOrchestratorVersion: type: string readOnly: true description: The running Kubernetes version on the Agent Pool. example: example_value nodeImageVersion: type: string readOnly: true description: The version of node image. example: example_value enableAutoScaling: type: boolean description: Whether to enable auto-scaler. example: true minCount: type: integer format: int32 description: The minimum number of nodes for auto-scaling. example: 10 maxCount: type: integer format: int32 description: The maximum number of nodes for auto-scaling. example: 10 scaleSetPriority: type: string enum: - Spot - Regular default: Regular description: The Virtual Machine Scale Set priority. example: Spot scaleSetEvictionPolicy: type: string enum: - Delete - Deallocate default: Delete description: The Virtual Machine Scale Set eviction policy. example: Delete spotMaxPrice: type: number format: float description: The maximum price for spot instances. example: 42.5 scaleDownMode: type: string enum: - Delete - Deallocate default: Delete description: Describes how VMs are added to or removed from Agent Pools. example: Delete vnetSubnetID: type: string description: The ID of the subnet for agent pool nodes. example: '500123' podSubnetID: type: string description: The ID of the subnet for pods. example: '500123' enableNodePublicIP: type: boolean description: Whether each node gets its own public IP. example: true nodePublicIPPrefixID: type: string description: The public IP prefix ID for the nodes. example: '500123' enableEncryptionAtHost: type: boolean description: Whether to enable host-based encryption. example: true enableFIPS: type: boolean description: Whether to use FIPS-enabled OS. example: true enableUltraSSD: type: boolean description: Whether to enable UltraSSD. example: true nodeLabels: type: object additionalProperties: type: string description: The node labels to be persisted across all nodes. example: example_value nodeTaints: type: array items: type: string description: The taints added to new nodes. example: [] tags: type: object additionalProperties: type: string description: The tags to persist on the VMSS. example: example_value proximityPlacementGroupID: type: string description: The ID for Proximity Placement Group. example: '500123' upgradeSettings: $ref: '#/components/schemas/AgentPoolUpgradeSettings' powerState: $ref: '#/components/schemas/PowerState' availabilityZones: type: array items: type: string description: The list of Availability zones to use for nodes. example: [] creationData: $ref: '#/components/schemas/CreationData' workloadRuntime: type: string enum: - OCIContainer - WasmWasi - KataMshvVmIsolation description: The type of workload a node can run. example: OCIContainer messageOfTheDay: type: string description: A base64-encoded message of the day for Linux nodes. example: example_value ManagedClusterSKU: type: object description: The SKU of a Managed Cluster. properties: name: type: string description: The name of a managed cluster SKU. enum: - Base - Automatic example: Base tier: type: string description: >- If not specified, the default is Free. See AKS Pricing Tier for more details. enum: - Free - Standard - Premium example: Free ManagedClusterIdentity: type: object description: Identity for the managed cluster. properties: principalId: type: string readOnly: true description: >- The principal id of the system assigned identity associated with this resource. example: '500123' tenantId: type: string readOnly: true description: >- The tenant id of the system assigned identity associated with this resource. example: '500123' type: type: string description: >- The type of identity used for the managed cluster. enum: - SystemAssigned - UserAssigned - None example: SystemAssigned userAssignedIdentities: type: object additionalProperties: $ref: '#/components/schemas/UserAssignedIdentity' description: >- The keys must be ARM resource IDs in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. example: example_value UserAssignedIdentity: type: object description: >- Details about a user assigned identity. properties: resourceId: type: string description: The resource ID of the user assigned identity. example: '500123' clientId: type: string description: The client ID of the user assigned identity. example: '500123' objectId: type: string description: The object ID of the user assigned identity. example: '500123' ExtendedLocation: type: object description: The complex type of the extended location. properties: name: type: string description: The name of the extended location. example: Example Title type: type: string description: The type of the extended location. enum: - EdgeZone example: EdgeZone SystemData: type: object description: Metadata pertaining to creation and last modification of the resource. properties: createdBy: type: string description: The identity that created the resource. example: example_value createdByType: type: string description: The type of identity that created the resource. enum: - User - Application - ManagedIdentity - Key example: User createdAt: type: string format: date-time description: The timestamp of resource creation (UTC). example: '2026-01-15T10:30:00Z' lastModifiedBy: type: string description: The identity that last modified the resource. example: example_value lastModifiedByType: type: string description: The type of identity that last modified the resource. enum: - User - Application - ManagedIdentity - Key example: User lastModifiedAt: type: string format: date-time description: The timestamp of resource last modification (UTC). example: '2026-01-15T10:30:00Z' ContainerServiceLinuxProfile: type: object description: Profile for Linux VMs in the container service cluster. required: - adminUsername - ssh properties: adminUsername: type: string description: The administrator username to use for Linux VMs. pattern: '^[A-Za-z][-A-Za-z0-9_]*$' example: example_value ssh: type: object description: The SSH configuration for Linux-based VMs running on Azure. required: - publicKeys properties: publicKeys: type: array items: type: object required: - keyData properties: keyData: type: string description: >- Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. description: >- The list of SSH public keys used to authenticate with Linux-based VMs. example: example_value ManagedClusterWindowsProfile: type: object description: Profile for Windows VMs in the managed cluster. required: - adminUsername properties: adminUsername: type: string description: >- The administrator username to use for Windows VMs. example: example_value adminPassword: type: string format: password description: >- The administrator password to use for Windows VMs. example: example_value licenseType: type: string description: The license type to use for Windows VMs. enum: - None - Windows_Server example: None enableCSIProxy: type: boolean description: Whether to enable CSI proxy. example: true ManagedClusterServicePrincipalProfile: type: object description: >- Information about a service principal identity for the cluster to use for manipulating Azure APIs. required: - clientId properties: clientId: type: string description: The ID for the service principal. example: '500123' secret: type: string format: password description: The secret password associated with the service principal. example: example_value ManagedClusterAddonProfile: type: object description: A Kubernetes add-on profile for a managed cluster. required: - enabled properties: enabled: type: boolean description: Whether the add-on is enabled or not. example: true config: type: object additionalProperties: type: string description: Key-value pairs for configuring an add-on. example: example_value identity: $ref: '#/components/schemas/UserAssignedIdentity' readOnly: true ContainerServiceNetworkProfile: type: object description: Profile of network configuration. properties: networkPlugin: type: string description: Network plugin used for building the Kubernetes network. enum: - azure - kubenet - none default: kubenet example: azure networkPluginMode: type: string description: The mode the network plugin should use. enum: - overlay example: overlay networkPolicy: type: string description: Network policy used for building the Kubernetes network. enum: - azure - calico - cilium - none example: azure networkDataplane: type: string description: Network dataplane used in the Kubernetes cluster. enum: - azure - cilium example: azure podCidr: type: string description: A CIDR notation IP range from which to assign pod IPs. default: 10.244.0.0/16 example: example_value serviceCidr: type: string description: >- A CIDR notation IP range from which to assign service cluster IPs. default: 10.0.0.0/16 example: example_value dnsServiceIP: type: string description: >- An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range. default: 10.0.0.10 example: example_value outboundType: type: string description: The outbound (egress) routing method. enum: - loadBalancer - userDefinedRouting - managedNATGateway - userAssignedNATGateway - none default: loadBalancer example: loadBalancer loadBalancerSku: type: string description: The load balancer sku for the managed cluster. enum: - standard - basic default: standard example: standard loadBalancerProfile: $ref: '#/components/schemas/ManagedClusterLoadBalancerProfile' natGatewayProfile: $ref: '#/components/schemas/ManagedClusterNATGatewayProfile' ipFamilies: type: array items: type: string enum: - IPv4 - IPv6 description: >- IP families used to specify IP versions available to the cluster. example: [] ManagedClusterLoadBalancerProfile: type: object description: Profile of the managed cluster load balancer. properties: managedOutboundIPs: type: object properties: count: type: integer format: int32 minimum: 1 maximum: 100 default: 1 description: >- The desired number of outbound IPs created/managed by Azure for the cluster load balancer. description: Desired managed outbound IPs for the cluster load balancer. example: example_value outboundIPPrefixes: type: object properties: publicIPPrefixes: type: array items: type: object properties: id: type: string description: The fully qualified Azure resource id. description: >- Desired outbound IP Prefix resources for the cluster load balancer. example: example_value outboundIPs: type: object properties: publicIPs: type: array items: type: object properties: id: type: string description: The fully qualified Azure resource id. description: Desired outbound IP resources for the cluster load balancer. example: example_value effectiveOutboundIPs: type: array readOnly: true items: type: object properties: id: type: string description: The fully qualified Azure resource id. description: The effective outbound IP resources of the cluster load balancer. example: [] allocatedOutboundPorts: type: integer format: int32 minimum: 0 maximum: 64000 default: 0 description: The desired number of allocated SNAT ports per VM. example: 10 idleTimeoutInMinutes: type: integer format: int32 minimum: 4 maximum: 120 default: 30 description: >- Desired outbound flow idle timeout in minutes. example: 10 ManagedClusterNATGatewayProfile: type: object description: Profile of the managed cluster NAT gateway. properties: managedOutboundIPProfile: type: object properties: count: type: integer format: int32 minimum: 1 maximum: 16 default: 1 description: The desired number of outbound IPs for the NAT gateway. description: The managed outbound IP profile of the NAT gateway. example: example_value effectiveOutboundIPs: type: array readOnly: true items: type: object properties: id: type: string description: The fully qualified Azure resource id. description: The effective outbound IP resources of the NAT gateway. example: [] idleTimeoutInMinutes: type: integer format: int32 minimum: 4 maximum: 120 default: 4 description: >- Desired outbound flow idle timeout in minutes. example: 10 ManagedClusterAADProfile: type: object description: >- Azure Active Directory configuration for integration with AKS. properties: managed: type: boolean description: Whether to enable managed AAD. example: true enableAzureRBAC: type: boolean description: Whether to enable Azure RBAC for Kubernetes authorization. example: true adminGroupObjectIDs: type: array items: type: string description: >- The list of AAD group object IDs that will have admin role of the cluster. example: [] clientAppID: type: string description: >- (DEPRECATED) The client AAD application ID. Used for legacy/non-managed AAD. example: '500123' serverAppID: type: string description: >- (DEPRECATED) The server AAD application ID. Used for legacy/non-managed AAD. example: '500123' serverAppSecret: type: string description: >- (DEPRECATED) The server AAD application secret. Used for legacy/non-managed AAD. example: example_value tenantID: type: string description: >- The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription. example: '500123' ManagedClusterAutoScalerProfile: type: object description: Parameters to be applied to the cluster-autoscaler. properties: balance-similar-node-groups: type: string description: >- Detects similar node pools and balances the number of nodes between them. example: example_value daemonset-eviction-for-empty-nodes: type: boolean description: >- If set to true, all daemonset pods on empty nodes will be evicted before deletion of the node. example: true daemonset-eviction-for-occupied-nodes: type: boolean description: >- If set to true, all daemonset pods on occupied nodes will be evicted before deletion of the node. example: true expander: type: string description: The expander to use when scaling up. enum: - least-waste - most-pods - priority - random default: random example: least-waste max-empty-bulk-delete: type: string description: The maximum number of empty nodes that can be deleted at the same time. default: '10' example: example_value max-graceful-termination-sec: type: string description: >- Maximum number of seconds the cluster autoscaler waits for pod termination when trying to scale down a node. default: '600' example: example_value max-node-provision-time: type: string description: >- The maximum time the autoscaler waits for a node to be provisioned. default: 15m example: example_value max-total-unready-percentage: type: string description: >- Maximum percentage of unready nodes in the cluster. After this percentage is exceeded, the cluster autoscaler halts operations. default: '45' example: example_value new-pod-scale-up-delay: type: string description: >- For scenarios like burst/batch scale where you do not want CA to act before the kubernetes scheduler could schedule all the pods. default: 0s example: example_value ok-total-unready-count: type: string description: >- Number of allowed unready nodes, irrespective of max-total-unready-percentage. default: '3' example: example_value scan-interval: type: string description: How often the cluster is reevaluated for scale up or down. default: 10s example: example_value scale-down-delay-after-add: type: string description: >- How long after scale up that scale down evaluation resumes. default: 10m example: example_value scale-down-delay-after-delete: type: string description: >- How long after node deletion that scale down evaluation resumes. default: scan-interval example: example_value scale-down-delay-after-failure: type: string description: >- How long after scale down failure that scale down evaluation resumes. default: 3m example: example_value scale-down-unneeded-time: type: string description: >- How long a node should be unneeded before it is eligible for scale down. default: 10m example: example_value scale-down-unready-time: type: string description: >- How long an unready node should be unneeded before it is eligible for scale down. default: 20m example: example_value scale-down-utilization-threshold: type: string description: >- Node utilization level, defined as sum of requested resources divided by capacity, below which a node can be considered for scale down. default: '0.5' example: example_value skip-nodes-with-local-storage: type: string description: >- Whether the cluster autoscaler will skip deleting nodes with pods with local storage. default: 'true' example: example_value skip-nodes-with-system-pods: type: string description: >- Whether the cluster autoscaler will skip deleting nodes with pods from kube-system (except for DaemonSet or mirror pods). default: 'true' example: example_value ManagedClusterAutoUpgradeProfile: type: object description: Auto upgrade profile for a managed cluster. properties: upgradeChannel: type: string description: The upgrade channel for auto upgrade. enum: - rapid - stable - patch - node-image - none example: rapid nodeOSUpgradeChannel: type: string description: >- The node OS upgrade channel. Manner in which the OS on your nodes is updated. enum: - None - Unmanaged - SecurityPatch - NodeImage example: None ClusterUpgradeSettings: type: object description: Settings for upgrading a cluster. properties: overrideSettings: type: object description: Settings for overrides during upgrade. properties: forceUpgrade: type: boolean description: >- Whether to force upgrade the cluster. Note that this option instructs the upgrade operation to bypass upgrade protections. until: type: string format: date-time description: Until when the overrides are effective. example: example_value ManagedClusterAPIServerAccessProfile: 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. example: [] enablePrivateCluster: type: boolean description: Whether to create the cluster as a private cluster or not. example: true privateDNSZone: type: string description: The private DNS zone mode for the cluster. example: example_value enablePrivateClusterPublicFQDN: type: boolean description: Whether to create a public FQDN for private cluster or not. example: true disableRunCommand: type: boolean description: Whether to disable run command for the cluster. example: true enableVnetIntegration: type: boolean description: Whether to enable API server VNET integration for the cluster. example: true subnetId: type: string description: >- The subnet to be used when API server VNET integration is enabled. example: '500123' ManagedClusterSecurityProfile: type: object description: Security profile for the container service cluster. properties: defender: type: object description: Microsoft Defender settings for the security profile. properties: logAnalyticsWorkspaceResourceId: type: string description: Resource ID of the Log Analytics workspace. securityMonitoring: type: object properties: enabled: type: boolean description: Whether to enable Defender threat detection. example: example_value workloadIdentity: type: object description: Workload identity settings for the security profile. properties: enabled: type: boolean description: Whether to enable workload identity. example: example_value imageCleaner: type: object description: Image Cleaner settings for the security profile. properties: enabled: type: boolean description: Whether to enable Image Cleaner. intervalHours: type: integer format: int32 description: Image Cleaner scanning interval in hours. example: example_value ManagedClusterStorageProfile: type: object description: Storage profile for the container service cluster. properties: diskCSIDriver: type: object properties: enabled: type: boolean description: Whether to enable AzureDisk CSI Driver. example: example_value fileCSIDriver: type: object properties: enabled: type: boolean description: Whether to enable AzureFile CSI Driver. example: example_value snapshotController: type: object properties: enabled: type: boolean description: Whether to enable Snapshot Controller. example: example_value blobCSIDriver: type: object properties: enabled: type: boolean description: Whether to enable AzureBlob CSI Driver. example: example_value ManagedClusterIngressProfile: type: object description: Ingress profile for the managed cluster. properties: webAppRouting: type: object description: Web App Routing settings. properties: enabled: type: boolean description: Whether to enable Web App Routing. dnsZoneResourceIds: type: array items: type: string description: Resource IDs of the DNS zones. example: example_value ManagedClusterOIDCIssuerProfile: type: object description: The OIDC issuer profile of the Managed Cluster. properties: issuerURL: type: string readOnly: true description: The OIDC issuer url of the Managed Cluster. example: https://www.example.com enabled: type: boolean description: Whether the OIDC issuer is enabled. example: true ManagedClusterMetricsProfile: type: object description: The metrics profile for the ManagedCluster. properties: costAnalysis: type: object properties: enabled: type: boolean description: Whether the cost analysis add-on is enabled. example: example_value ManagedClusterAzureMonitorProfile: type: object description: Azure Monitor addon profiles for monitoring the managed cluster. properties: metrics: type: object description: Metrics profile for the Azure Monitor managed service for Prometheus addon. properties: enabled: type: boolean description: Whether to enable the Prometheus collector. example: example_value ServiceMeshProfile: type: object description: >- Service mesh profile for a managed cluster. properties: mode: type: string description: Mode of the service mesh. enum: - Istio - Disabled example: Istio istio: type: object description: Istio service mesh configuration. properties: revisions: type: array items: type: string description: The list of revisions of the Istio control plane. example: example_value ManagedClusterWorkloadAutoScalerProfile: type: object description: Workload Auto-scaler profile for the managed cluster. properties: keda: type: object description: KEDA (Kubernetes Event-driven Autoscaling) settings. properties: enabled: type: boolean description: Whether to enable KEDA. example: example_value verticalPodAutoscaler: type: object description: VPA (Vertical Pod Autoscaler) settings. properties: enabled: type: boolean description: Whether to enable VPA. controlledValues: type: string description: >- Controls which resource value autoscaler acts on. enum: - RequestsAndLimits - RequestsOnly example: example_value ManagedClusterNodeResourceGroupProfile: type: object description: Node resource group lockdown profile for a managed cluster. properties: restrictionLevel: type: string description: The restriction level applied to the cluster node resource group. enum: - Unrestricted - ReadOnly example: Unrestricted AgentPoolUpgradeSettings: type: object description: Settings for upgrading an agentpool. properties: maxSurge: type: string description: >- The maximum number or percentage of nodes that are surged during upgrade. This can either be set to an integer (e.g. 5) or a percentage (e.g. 50%). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. example: example_value drainTimeoutInMinutes: type: integer format: int32 minimum: 1 maximum: 1440 description: >- The amount of time (in minutes) to wait on eviction of pods and graceful termination per node. example: 10 nodeSoakDurationInMinutes: type: integer format: int32 minimum: 0 maximum: 30 description: >- The amount of time (in minutes) to wait after draining a node and before reimaging it and moving on to the next node. example: 10 PowerState: type: object description: Describes the Power State of the cluster. properties: code: type: string description: Tells whether the cluster is Running or Stopped. enum: - Running - Stopped example: Running CreationData: type: object description: >- Data used when creating a target resource from a source resource. properties: sourceResourceId: type: string description: >- This is the ARM ID of the source object to be used to create the target object. example: '500123' ManagedClusterListResult: type: object description: The response from the List Managed Clusters operation. properties: value: type: array items: $ref: '#/components/schemas/ManagedCluster' description: The list of managed clusters. example: [] nextLink: type: string readOnly: true description: The URL to get the next set of managed cluster results. example: example_value AgentPoolListResult: type: object description: The response from the List Agent Pools operation. properties: value: type: array items: $ref: '#/components/schemas/AgentPool' description: The list of agent pools. example: [] nextLink: type: string readOnly: true description: The URL to get the next set of agent pool results. example: example_value ManagedClusterUpgradeProfile: type: object description: The list of available upgrades for compute pools. properties: id: type: string readOnly: true description: The ID of the upgrade profile. example: abc123 name: type: string readOnly: true description: The name of the upgrade profile. example: Example Title type: type: string readOnly: true description: The type of the upgrade profile. example: example_value properties: type: object required: - controlPlaneProfile - agentPoolProfiles properties: controlPlaneProfile: type: object description: The list of available upgrade versions for the control plane. properties: kubernetesVersion: type: string description: The Kubernetes version. osType: type: string enum: - Linux - Windows default: Linux upgrades: type: array items: type: object properties: kubernetesVersion: type: string isPreview: type: boolean agentPoolProfiles: type: array items: type: object properties: kubernetesVersion: type: string osType: type: string enum: - Linux - Windows default: Linux upgrades: type: array items: type: object properties: kubernetesVersion: type: string isPreview: type: boolean description: The list of available upgrade versions for agent pools. example: example_value AgentPoolUpgradeProfile: type: object description: The list of available upgrades for an agent pool. properties: id: type: string readOnly: true description: The ID of the agent pool upgrade profile. example: abc123 name: type: string readOnly: true description: The name of the agent pool upgrade profile. example: Example Title type: type: string readOnly: true description: The type of the agent pool upgrade profile. example: example_value properties: type: object required: - kubernetesVersion - osType properties: kubernetesVersion: type: string description: The Kubernetes version. osType: type: string enum: - Linux - Windows default: Linux upgrades: type: array items: type: object properties: kubernetesVersion: type: string isPreview: type: boolean latestNodeImageVersion: type: string description: The latest node image version available for the agent pool. example: example_value AgentPoolAvailableVersions: type: object description: The available agent pool versions. properties: id: type: string readOnly: true description: The ID of the agent pool version list. example: abc123 name: type: string readOnly: true description: The name of the agent pool version list. example: Example Title type: type: string readOnly: true description: The resource type. example: example_value properties: type: object properties: agentPoolVersions: type: array items: type: object properties: default: type: boolean description: Whether this version is the default. kubernetesVersion: type: string description: The Kubernetes version. isPreview: type: boolean description: Whether this version is in preview. example: example_value CredentialResults: type: object description: The list of credential result response. properties: kubeconfigs: type: array readOnly: true items: type: object properties: name: type: string readOnly: true description: The name of the credential. value: type: string format: byte readOnly: true description: >- Base64-encoded Kubernetes configuration file. description: Base64-encoded Kubernetes configuration file. example: [] RunCommandRequest: type: object description: A run command request. required: - command properties: command: type: string description: The command to run. example: example_value context: type: string description: >- A base64 encoded zip file containing the files required by the command. example: example_value clusterToken: type: string description: AuthToken issued for AKS AAD Server App. example: example_value RunCommandResult: type: object description: Run command result. properties: id: type: string readOnly: true description: The command id. example: abc123 properties: type: object readOnly: true properties: provisioningState: type: string readOnly: true description: Provisioning state. exitCode: type: integer format: int32 readOnly: true description: The exit code of the command. startedAt: type: string format: date-time readOnly: true description: The time when the command started. finishedAt: type: string format: date-time readOnly: true description: The time when the command finished. logs: type: string readOnly: true description: The command output. reason: type: string readOnly: true description: An explanation of why provisioningState is set to failed. example: example_value AgentPoolDeleteMachinesParameter: type: object description: The parameters for deleting machines in an agent pool. required: - machineNames properties: machineNames: type: array items: type: string description: The list of machine names to delete. example: [] TagsObject: type: object description: Tags object for patch operations. properties: tags: type: object additionalProperties: type: string description: Resource tags. example: example_value CloudError: type: object description: An error response from the Container service. properties: error: type: object description: Details about the error. properties: code: type: string description: >- An identifier for the error. Codes are invariant and are intended to be consumed programmatically. message: type: string description: >- A message describing the error, intended to be suitable for display in a user interface. target: type: string description: >- The target of the particular error. For example, the name of the property in error. details: type: array items: type: object properties: code: type: string message: type: string target: type: string description: A list of additional details about the error. example: example_value externalDocs: description: Azure Kubernetes Service REST API Reference url: https://learn.microsoft.com/en-us/rest/api/aks/