openapi: 3.0.0 info: title: ContainerServiceClient description: The Container Service Client. contact: {} version: '2020-01-01' servers: - url: https://management.azure.com variables: {} - url: https://login.microsoftonline.com/common/oauth2 variables: {} paths: /providers/Microsoft.ContainerService/operations: get: tags: - managedClusters summary: Operations_List description: Gets a list of compute operations. operationId: Operations_List parameters: - name: api-version in: query description: Client Api Version. required: true style: form explode: true schema: type: string responses: '200': description: OK headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/OperationListResult' - description: The List Compute Operation operation response. default: description: Error response describing why the operation failed. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/CloudError' - description: An error response from the Container service. deprecated: false /subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/managedClusters: get: tags: - ManagedClusters summary: ManagedClusters_List description: Gets a list of managed clusters in the specified subscription. The operation returns properties of each managed cluster. operationId: ManagedClusters_List parameters: - name: api-version in: query description: Client Api Version. required: true style: form explode: true schema: type: string - name: subscriptionId in: path description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. required: true style: simple schema: type: string responses: '200': description: OK headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/ManagedClusterListResult' - description: The response from the List Managed Clusters operation. default: description: Error response describing why the operation failed. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/CloudError' - description: An error response from the Container service. deprecated: false /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters: get: tags: - ManagedClusters summary: ManagedClusters_ListByResourceGroup description: Lists managed clusters in the specified subscription and resource group. The operation returns properties of each managed cluster. operationId: ManagedClusters_ListByResourceGroup parameters: - name: api-version in: query description: Client Api Version. required: true style: form explode: true schema: type: string - name: subscriptionId in: path description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. required: true style: simple schema: type: string - name: resourceGroupName in: path description: The name of the resource group. required: true style: simple schema: minLength: 1 type: string responses: '200': description: OK headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/ManagedClusterListResult' - description: The response from the List Managed Clusters operation. default: description: Error response describing why the operation failed. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/CloudError' - description: An error response from the Container service. deprecated: false ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName} : delete: tags: - ManagedClusters summary: ManagedClusters_Delete description: Deletes the managed cluster with a specified resource group and name. operationId: ManagedClusters_Delete parameters: - name: api-version in: query description: Client Api Version. required: true style: form explode: true schema: type: string - name: subscriptionId in: path description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. required: true style: simple schema: type: string - name: resourceGroupName in: path description: The name of the resource group. required: true style: simple schema: minLength: 1 type: string - name: resourceName in: path description: The name of the managed cluster resource. required: true style: simple schema: maxLength: 63 minLength: 1 pattern: ^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$ type: string responses: '202': description: Accepted headers: {} content: {} '204': description: NoContent headers: {} content: {} default: description: Error response describing why the operation failed. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/CloudError' - description: An error response from the Container service. deprecated: false get: tags: - ManagedClusters summary: ManagedClusters_Get description: Gets the details of the managed cluster with a specified resource group and name. operationId: ManagedClusters_Get parameters: - name: api-version in: query description: Client Api Version. required: true style: form explode: true schema: type: string - name: subscriptionId in: path description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. required: true style: simple schema: type: string - name: resourceGroupName in: path description: The name of the resource group. required: true style: simple schema: minLength: 1 type: string - name: resourceName in: path description: The name of the managed cluster resource. required: true style: simple schema: maxLength: 63 minLength: 1 pattern: ^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$ type: string responses: '200': description: OK headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/ManagedCluster' - description: Managed cluster. default: description: Error response describing why the operation failed. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/CloudError' - description: An error response from the Container service. deprecated: false patch: tags: - ManagedClusters summary: ManagedClusters_UpdateTags description: Updates a managed cluster with the specified tags. operationId: ManagedClusters_UpdateTags parameters: - name: api-version in: query description: Client Api Version. required: true style: form explode: true schema: type: string - name: subscriptionId in: path description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. required: true style: simple schema: type: string - name: resourceGroupName in: path description: The name of the resource group. required: true style: simple schema: minLength: 1 type: string - name: resourceName in: path description: The name of the managed cluster resource. required: true style: simple schema: maxLength: 63 minLength: 1 pattern: ^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$ type: string requestBody: description: Parameters supplied to the Update Managed Cluster Tags operation. content: application/json: schema: allOf: - $ref: '#/components/schemas/SubscriptionsResourceGroupsProvidersMicrosoftContainerServiceManagedClustersResourceNameRequest' - description: Parameters supplied to the Update Managed Cluster Tags operation. required: true responses: '200': description: OK headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/ManagedCluster' - description: Managed cluster. default: description: Error response describing why the operation failed. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/CloudError' - description: An error response from the Container service. deprecated: false put: tags: - ManagedClusters summary: ManagedClusters_CreateOrUpdate description: Creates or updates a managed cluster with the specified configuration for agents and Kubernetes version. operationId: ManagedClusters_CreateOrUpdate parameters: - name: api-version in: query description: Client Api Version. required: true style: form explode: true schema: type: string - name: subscriptionId in: path description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. required: true style: simple schema: type: string - name: resourceGroupName in: path description: The name of the resource group. required: true style: simple schema: minLength: 1 type: string - name: resourceName in: path description: The name of the managed cluster resource. required: true style: simple schema: maxLength: 63 minLength: 1 pattern: ^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$ type: string requestBody: description: Parameters supplied to the Create or Update a Managed Cluster operation. content: application/json: schema: allOf: - $ref: '#/components/schemas/SubscriptionsResourceGroupsProvidersMicrosoftContainerServiceManagedClustersResourceNameRequest1' - description: Parameters supplied to the Create or Update a Managed Cluster operation. required: true responses: '200': description: OK headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/ManagedCluster' - description: Managed cluster. '201': description: Created headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/ManagedCluster' - description: Managed cluster. default: description: Error response describing why the operation failed. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/CloudError' - description: An error response from the Container service. deprecated: false ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/accessProfiles/{roleName}/listCredential : post: tags: - ManagedClusters summary: ManagedClusters_GetAccessProfile description: Gets the accessProfile for the specified role name of the managed cluster with a specified resource group and name. operationId: ManagedClusters_GetAccessProfile parameters: - name: api-version in: query description: Client Api Version. required: true style: form explode: true schema: type: string - name: subscriptionId in: path description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. required: true style: simple schema: type: string - name: resourceGroupName in: path description: The name of the resource group. required: true style: simple schema: minLength: 1 type: string - name: resourceName in: path description: The name of the managed cluster resource. required: true style: simple schema: maxLength: 63 minLength: 1 pattern: ^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$ type: string - name: roleName in: path description: The name of the role for managed cluster accessProfile resource. required: true style: simple schema: type: string responses: '200': description: OK headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/ManagedClusterAccessProfile' - description: Managed cluster Access Profile. default: description: Error response describing why the operation failed. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/CloudError' - description: An error response from the Container service. deprecated: false ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterAdminCredential : post: tags: - ManagedClusters summary: ManagedClusters_ListClusterAdminCredentials description: Gets cluster admin credential of the managed cluster with a specified resource group and name. operationId: ManagedClusters_ListClusterAdminCredentials parameters: - name: api-version in: query description: Client Api Version. required: true style: form explode: true schema: type: string - name: subscriptionId in: path description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. required: true style: simple schema: type: string - name: resourceGroupName in: path description: The name of the resource group. required: true style: simple schema: minLength: 1 type: string - name: resourceName in: path description: The name of the managed cluster resource. required: true style: simple schema: maxLength: 63 minLength: 1 pattern: ^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$ type: string responses: '200': description: OK headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/CredentialResults' - description: The list of credential result response. default: description: Error response describing why the operation failed. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/CloudError' - description: An error response from the Container service. deprecated: false ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterMonitoringUserCredential : post: tags: - ManagedClusters summary: ManagedClusters_ListClusterMonitoringUserCredentials description: Gets cluster monitoring user credential of the managed cluster with a specified resource group and name. operationId: ManagedClusters_ListClusterMonitoringUserCredentials parameters: - name: api-version in: query description: Client Api Version. required: true style: form explode: true schema: type: string - name: subscriptionId in: path description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. required: true style: simple schema: type: string - name: resourceGroupName in: path description: The name of the resource group. required: true style: simple schema: minLength: 1 type: string - name: resourceName in: path description: The name of the managed cluster resource. required: true style: simple schema: maxLength: 63 minLength: 1 pattern: ^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$ type: string responses: '200': description: OK headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/CredentialResults' - description: The list of credential result response. default: description: Error response describing why the operation failed. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/CloudError' - description: An error response from the Container service. deprecated: false ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterUserCredential : post: tags: - ManagedClusters summary: ManagedClusters_ListClusterUserCredentials description: Gets cluster user credential of the managed cluster with a specified resource group and name. operationId: ManagedClusters_ListClusterUserCredentials parameters: - name: api-version in: query description: Client Api Version. required: true style: form explode: true schema: type: string - name: subscriptionId in: path description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. required: true style: simple schema: type: string - name: resourceGroupName in: path description: The name of the resource group. required: true style: simple schema: minLength: 1 type: string - name: resourceName in: path description: The name of the managed cluster resource. required: true style: simple schema: maxLength: 63 minLength: 1 pattern: ^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$ type: string responses: '200': description: OK headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/CredentialResults' - description: The list of credential result response. default: description: Error response describing why the operation failed. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/CloudError' - description: An error response from the Container service. deprecated: false ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/resetAADProfile : post: tags: - ManagedClusters summary: ManagedClusters_ResetAADProfile description: Update the AAD Profile for a managed cluster. operationId: ManagedClusters_ResetAADProfile parameters: - name: api-version in: query description: Client Api Version. required: true style: form explode: true schema: type: string - name: subscriptionId in: path description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. required: true style: simple schema: type: string - name: resourceGroupName in: path description: The name of the resource group. required: true style: simple schema: minLength: 1 type: string - name: resourceName in: path description: The name of the managed cluster resource. required: true style: simple schema: maxLength: 63 minLength: 1 pattern: ^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$ type: string requestBody: description: Parameters supplied to the Reset AAD Profile operation for a Managed Cluster. content: application/json: schema: allOf: - $ref: '#/components/schemas/SubscriptionsResourceGroupsProvidersMicrosoftContainerServiceManagedClustersResourceNameResetAADProfileRequest' - description: Parameters supplied to the Reset AAD Profile operation for a Managed Cluster. required: true responses: '200': description: OK headers: {} content: {} '202': description: Accepted headers: {} content: {} default: description: Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/CloudError' - description: An error response from the Container service. deprecated: false ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/resetServicePrincipalProfile : post: tags: - ManagedClusters summary: ManagedClusters_ResetServicePrincipalProfile description: Update the service principal Profile for a managed cluster. operationId: ManagedClusters_ResetServicePrincipalProfile parameters: - name: api-version in: query description: Client Api Version. required: true style: form explode: true schema: type: string - name: subscriptionId in: path description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. required: true style: simple schema: type: string - name: resourceGroupName in: path description: The name of the resource group. required: true style: simple schema: minLength: 1 type: string - name: resourceName in: path description: The name of the managed cluster resource. required: true style: simple schema: maxLength: 63 minLength: 1 pattern: ^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$ type: string requestBody: description: Parameters supplied to the Reset Service Principal Profile operation for a Managed Cluster. content: application/json: schema: allOf: - $ref: '#/components/schemas/SubscriptionsResourceGroupsProvidersMicrosoftContainerServiceManagedClustersResourceNameResetServicePrincipalProfileRequest' - description: Parameters supplied to the Reset Service Principal Profile operation for a Managed Cluster. required: true responses: '200': description: OK headers: {} content: {} '202': description: Accepted headers: {} content: {} default: description: Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/CloudError' - description: An error response from the Container service. deprecated: false ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/rotateClusterCertificates : post: tags: - ManagedClusters summary: ManagedClusters_RotateClusterCertificates description: Rotate certificates of a managed cluster. operationId: ManagedClusters_RotateClusterCertificates parameters: - name: api-version in: query description: Client Api Version. required: true style: form explode: true schema: type: string - name: subscriptionId in: path description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. required: true style: simple schema: type: string - name: resourceGroupName in: path description: The name of the resource group. required: true style: simple schema: minLength: 1 type: string - name: resourceName in: path description: The name of the managed cluster resource. required: true style: simple schema: maxLength: 63 minLength: 1 pattern: ^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$ type: string responses: '202': description: Accepted headers: {} content: {} '204': description: NoContent headers: {} content: {} default: description: Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/CloudError' - description: An error response from the Container service. deprecated: false ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/upgradeProfiles/default : get: tags: - ManagedClusters summary: ManagedClusters_GetUpgradeProfile description: Gets the details of the upgrade profile for a managed cluster with a specified resource group and name. operationId: ManagedClusters_GetUpgradeProfile parameters: - name: api-version in: query description: Client Api Version. required: true style: form explode: true schema: type: string - name: subscriptionId in: path description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. required: true style: simple schema: type: string - name: resourceGroupName in: path description: The name of the resource group. required: true style: simple schema: minLength: 1 type: string - name: resourceName in: path description: The name of the managed cluster resource. required: true style: simple schema: maxLength: 63 minLength: 1 pattern: ^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$ type: string responses: '200': description: OK headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/ManagedClusterUpgradeProfile' - description: The list of available upgrades for compute pools. default: description: Error response describing why the operation failed. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/CloudError' - description: An error response from the Container service. deprecated: false ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools : get: tags: - AgentPools summary: AgentPools_List description: Gets a list of agent pools in the specified managed cluster. The operation returns properties of each agent pool. operationId: AgentPools_List parameters: - name: api-version in: query description: Client Api Version. required: true style: form explode: true schema: type: string - name: subscriptionId in: path description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. required: true style: simple schema: type: string - name: resourceGroupName in: path description: The name of the resource group. required: true style: simple schema: minLength: 1 type: string - name: resourceName in: path description: The name of the managed cluster resource. required: true style: simple schema: maxLength: 63 minLength: 1 pattern: ^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$ type: string responses: '200': description: OK headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/AgentPoolListResult' - description: The response from the List Agent Pools operation. default: description: Error response describing why the operation failed. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/CloudError' - description: An error response from the Container service. deprecated: false ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName} : delete: tags: - AgentPools summary: AgentPools_Delete description: Deletes the agent pool in the specified managed cluster. operationId: AgentPools_Delete parameters: - name: api-version in: query description: Client Api Version. required: true style: form explode: true schema: type: string - name: subscriptionId in: path description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. required: true style: simple schema: type: string - name: resourceGroupName in: path description: The name of the resource group. required: true style: simple schema: minLength: 1 type: string - name: resourceName in: path description: The name of the managed cluster resource. required: true style: simple schema: maxLength: 63 minLength: 1 pattern: ^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$ type: string - name: agentPoolName in: path description: The name of the agent pool. required: true style: simple schema: type: string responses: '202': description: Accepted headers: {} content: {} '204': description: NoContent headers: {} content: {} default: description: Error response describing why the operation failed. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/CloudError' - description: An error response from the Container service. deprecated: false get: tags: - AgentPools summary: AgentPools_Get description: Gets the details of the agent pool by managed cluster and resource group. operationId: AgentPools_Get parameters: - name: api-version in: query description: Client Api Version. required: true style: form explode: true schema: type: string - name: subscriptionId in: path description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. required: true style: simple schema: type: string - name: resourceGroupName in: path description: The name of the resource group. required: true style: simple schema: minLength: 1 type: string - name: resourceName in: path description: The name of the managed cluster resource. required: true style: simple schema: maxLength: 63 minLength: 1 pattern: ^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$ type: string - name: agentPoolName in: path description: The name of the agent pool. required: true style: simple schema: type: string responses: '200': description: OK headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/AgentPool' - description: Agent Pool. default: description: Error response describing why the operation failed. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/CloudError' - description: An error response from the Container service. deprecated: false put: tags: - AgentPools summary: AgentPools_CreateOrUpdate description: Creates or updates an agent pool in the specified managed cluster. operationId: AgentPools_CreateOrUpdate parameters: - name: api-version in: query description: Client Api Version. required: true style: form explode: true schema: type: string - name: subscriptionId in: path description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. required: true style: simple schema: type: string - name: resourceGroupName in: path description: The name of the resource group. required: true style: simple schema: minLength: 1 type: string - name: resourceName in: path description: The name of the managed cluster resource. required: true style: simple schema: maxLength: 63 minLength: 1 pattern: ^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$ type: string - name: agentPoolName in: path description: The name of the agent pool. required: true style: simple schema: type: string requestBody: description: Parameters supplied to the Create or Update an agent pool operation. content: application/json: schema: allOf: - $ref: '#/components/schemas/SubscriptionsResourceGroupsProvidersMicrosoftContainerServiceManagedClustersResourceNameAgentPoolsAgentPoolNameRequest' - description: Parameters supplied to the Create or Update an agent pool operation. required: true responses: '200': description: OK headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/AgentPool' - description: Agent Pool. '201': description: Created headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/AgentPool' - description: Agent Pool. default: description: Error response describing why the operation failed. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/CloudError' - description: An error response from the Container service. deprecated: false ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/upgradeProfiles/default : get: tags: - AgentPools summary: AgentPools_GetUpgradeProfile description: Gets the details of the upgrade profile for an agent pool with a specified resource group and managed cluster name. operationId: AgentPools_GetUpgradeProfile parameters: - name: api-version in: query description: Client Api Version. required: true style: form explode: true schema: type: string - name: subscriptionId in: path description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. required: true style: simple schema: type: string - name: resourceGroupName in: path description: The name of the resource group. required: true style: simple schema: minLength: 1 type: string - name: resourceName in: path description: The name of the managed cluster resource. required: true style: simple schema: maxLength: 63 minLength: 1 pattern: ^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$ type: string - name: agentPoolName in: path description: The name of the agent pool. required: true style: simple schema: type: string responses: '200': description: OK headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/AgentPoolUpgradeProfile' - description: The list of available upgrades for an agent pool. default: description: Error response describing why the operation failed. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/CloudError' - description: An error response from the Container service. deprecated: false ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/availableAgentPoolVersions : get: tags: - AgentPools summary: AgentPools_GetAvailableAgentPoolVersions description: Gets a list of supported versions for the specified agent pool. operationId: AgentPools_GetAvailableAgentPoolVersions parameters: - name: api-version in: query description: Client Api Version. required: true style: form explode: true schema: type: string - name: subscriptionId in: path description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. required: true style: simple schema: type: string - name: resourceGroupName in: path description: The name of the resource group. required: true style: simple schema: minLength: 1 type: string - name: resourceName in: path description: The name of the managed cluster resource. required: true style: simple schema: maxLength: 63 minLength: 1 pattern: ^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$ type: string responses: '200': description: OK headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/AgentPoolAvailableVersions' - description: The list of available versions for an agent pool. deprecated: false components: schemas: AccessProfile: title: AccessProfile type: object properties: kubeConfig: type: string description: Base64-encoded Kubernetes configuration file. description: Profile for enabling a user to access a managed cluster. AgentPool: title: AgentPool type: object properties: id: type: string description: Resource ID. readOnly: true name: type: string description: The name of the resource that is unique within a resource group. This name can be used to access the resource. readOnly: true type: type: string description: Resource type readOnly: true properties: $ref: '#/components/schemas/Properties' description: Agent Pool. AgentPoolAvailableVersions: title: AgentPoolAvailableVersions required: - properties type: object properties: id: type: string description: Id of the agent pool available versions. readOnly: true name: type: string description: Name of the agent pool available versions. readOnly: true properties: $ref: '#/components/schemas/Properties1' type: type: string description: Type of the agent pool available versions. readOnly: true description: The list of available versions for an agent pool. AgentPoolAvailableVersionsProperties: title: AgentPoolAvailableVersionsProperties type: object properties: agentPoolVersions: type: array items: $ref: '#/components/schemas/AgentPoolVersion' description: List of versions available for agent pool. description: The list of available agent pool versions. AgentPoolListResult: title: AgentPoolListResult type: object properties: nextLink: type: string description: The URL to get the next set of agent pool results. readOnly: true value: type: array items: $ref: '#/components/schemas/AgentPool' description: The list of agent pools. description: The response from the List Agent Pools operation. AgentPoolType: title: AgentPoolType enum: - VirtualMachineScaleSets - AvailabilitySet type: string description: AgentPoolType represents types of an agent pool. AgentPoolUpgradeProfile: title: AgentPoolUpgradeProfile required: - properties type: object properties: id: type: string description: Id of the agent pool upgrade profile. readOnly: true name: type: string description: Name of the agent pool upgrade profile. readOnly: true properties: $ref: '#/components/schemas/Properties2' type: type: string description: Type of the agent pool upgrade profile. readOnly: true description: The list of available upgrades for an agent pool. AgentPoolUpgradeProfileProperties: title: AgentPoolUpgradeProfileProperties required: - kubernetesVersion - osType type: object properties: kubernetesVersion: type: string description: Kubernetes version (major, minor, patch). osType: $ref: '#/components/schemas/OSType' upgrades: type: array items: $ref: '#/components/schemas/Upgrade' description: List of orchestrator types and versions available for upgrade. description: The list of available upgrade versions. CloudError: title: CloudError type: object properties: error: $ref: '#/components/schemas/Error' description: An error response from the Container service. CloudErrorBody: title: CloudErrorBody type: object properties: code: type: string description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. details: type: array items: $ref: '#/components/schemas/CloudErrorBody' description: A list of additional details about the error. 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. description: An error response from the Container service. ContainerServiceDiagnosticsProfile: title: ContainerServiceDiagnosticsProfile required: - vmDiagnostics type: object properties: vmDiagnostics: $ref: '#/components/schemas/VmDiagnostics' description: Profile for diagnostics on the container service cluster. ContainerServiceLinuxProfile: title: ContainerServiceLinuxProfile required: - adminUsername - ssh type: object properties: adminUsername: pattern: ^[A-Za-z][-A-Za-z0-9_]*$ type: string description: The administrator username to use for Linux VMs. ssh: $ref: '#/components/schemas/Ssh' description: Profile for Linux VMs in the container service cluster. ContainerServiceMasterProfile: title: ContainerServiceMasterProfile required: - dnsPrefix - vmSize type: object properties: count: $ref: '#/components/schemas/Count' dnsPrefix: type: string description: DNS prefix to be used to create the FQDN for the master pool. firstConsecutiveStaticIP: type: string description: FirstConsecutiveStaticIP used to specify the first static ip of masters. default: 10.240.255.5 fqdn: type: string description: FQDN for the master pool. readOnly: true osDiskSizeGB: maximum: 1023 minimum: 0 type: integer description: OS Disk Size in GB to be used to specify the disk size for every machine in this master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified. format: int32 storageProfile: $ref: '#/components/schemas/ContainerServiceStorageProfile' vmSize: $ref: '#/components/schemas/ContainerServiceVMSize' vnetSubnetID: type: string description: VNet SubnetID specifies the VNet's subnet identifier. description: Profile for the container service master. ContainerServiceNetworkProfile: title: ContainerServiceNetworkProfile type: object properties: dnsServiceIP: pattern: ^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$ type: string description: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. default: 10.0.0.10 dockerBridgeCidr: pattern: ^([0-9]{1,3}\.){3}[0-9]{1,3}(\/([0-9]|[1-2][0-9]|3[0-2]))?$ type: string description: A CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the Kubernetes service address range. default: 172.17.0.1/16 loadBalancerProfile: $ref: '#/components/schemas/LoadBalancerProfile' loadBalancerSku: $ref: '#/components/schemas/LoadBalancerSku' networkPlugin: $ref: '#/components/schemas/NetworkPlugin' networkPolicy: $ref: '#/components/schemas/NetworkPolicy' outboundType: $ref: '#/components/schemas/OutboundType' podCidr: pattern: ^([0-9]{1,3}\.){3}[0-9]{1,3}(\/([0-9]|[1-2][0-9]|3[0-2]))?$ type: string description: A CIDR notation IP range from which to assign pod IPs when kubenet is used. default: 10.244.0.0/16 serviceCidr: pattern: ^([0-9]{1,3}\.){3}[0-9]{1,3}(\/([0-9]|[1-2][0-9]|3[0-2]))?$ type: string description: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. default: 10.0.0.0/16 description: Profile of network configuration. ContainerServiceSshConfiguration: title: ContainerServiceSshConfiguration required: - publicKeys type: object properties: publicKeys: type: array items: $ref: '#/components/schemas/ContainerServiceSshPublicKey' description: The list of SSH public keys used to authenticate with Linux-based VMs. Only expect one key specified. description: SSH configuration for Linux-based VMs running on Azure. ContainerServiceSshPublicKey: title: ContainerServiceSshPublicKey required: - keyData type: object 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: Contains information about SSH certificate public key data. ContainerServiceStorageProfile: title: ContainerServiceStorageProfile enum: - StorageAccount - ManagedDisks type: string description: Storage profile specifies what kind of storage used. Choose from StorageAccount and ManagedDisks. Leave it empty, we will choose for you based on the orchestrator choice. ContainerServiceVMDiagnostics: title: ContainerServiceVMDiagnostics required: - enabled type: object properties: enabled: type: boolean description: Whether the VM diagnostic agent is provisioned on the VM. storageUri: type: string description: The URI of the storage account where diagnostics are stored. readOnly: true description: Profile for diagnostics on the container service VMs. ContainerServiceVMSize: title: ContainerServiceVMSize enum: - Standard_A1 - Standard_A10 - Standard_A11 - Standard_A1_v2 - Standard_A2 - Standard_A2_v2 - Standard_A2m_v2 - Standard_A3 - Standard_A4 - Standard_A4_v2 - Standard_A4m_v2 - Standard_A5 - Standard_A6 - Standard_A7 - Standard_A8 - Standard_A8_v2 - Standard_A8m_v2 - Standard_A9 - Standard_B2ms - Standard_B2s - Standard_B4ms - Standard_B8ms - Standard_D1 - Standard_D11 - Standard_D11_v2 - Standard_D11_v2_Promo - Standard_D12 - Standard_D12_v2 - Standard_D12_v2_Promo - Standard_D13 - Standard_D13_v2 - Standard_D13_v2_Promo - Standard_D14 - Standard_D14_v2 - Standard_D14_v2_Promo - Standard_D15_v2 - Standard_D16_v3 - Standard_D16s_v3 - Standard_D1_v2 - Standard_D2 - Standard_D2_v2 - Standard_D2_v2_Promo - Standard_D2_v3 - Standard_D2s_v3 - Standard_D3 - Standard_D32_v3 - Standard_D32s_v3 - Standard_D3_v2 - Standard_D3_v2_Promo - Standard_D4 - Standard_D4_v2 - Standard_D4_v2_Promo - Standard_D4_v3 - Standard_D4s_v3 - Standard_D5_v2 - Standard_D5_v2_Promo - Standard_D64_v3 - Standard_D64s_v3 - Standard_D8_v3 - Standard_D8s_v3 - Standard_DS1 - Standard_DS11 - Standard_DS11_v2 - Standard_DS11_v2_Promo - Standard_DS12 - Standard_DS12_v2 - Standard_DS12_v2_Promo - Standard_DS13 - Standard_DS13-2_v2 - Standard_DS13-4_v2 - Standard_DS13_v2 - Standard_DS13_v2_Promo - Standard_DS14 - Standard_DS14-4_v2 - Standard_DS14-8_v2 - Standard_DS14_v2 - Standard_DS14_v2_Promo - Standard_DS15_v2 - Standard_DS1_v2 - Standard_DS2 - Standard_DS2_v2 - Standard_DS2_v2_Promo - Standard_DS3 - Standard_DS3_v2 - Standard_DS3_v2_Promo - Standard_DS4 - Standard_DS4_v2 - Standard_DS4_v2_Promo - Standard_DS5_v2 - Standard_DS5_v2_Promo - Standard_E16_v3 - Standard_E16s_v3 - Standard_E2_v3 - Standard_E2s_v3 - Standard_E32-16s_v3 - Standard_E32-8s_v3 - Standard_E32_v3 - Standard_E32s_v3 - Standard_E4_v3 - Standard_E4s_v3 - Standard_E64-16s_v3 - Standard_E64-32s_v3 - Standard_E64_v3 - Standard_E64s_v3 - Standard_E8_v3 - Standard_E8s_v3 - Standard_F1 - Standard_F16 - Standard_F16s - Standard_F16s_v2 - Standard_F1s - Standard_F2 - Standard_F2s - Standard_F2s_v2 - Standard_F32s_v2 - Standard_F4 - Standard_F4s - Standard_F4s_v2 - Standard_F64s_v2 - Standard_F72s_v2 - Standard_F8 - Standard_F8s - Standard_F8s_v2 - Standard_G1 - Standard_G2 - Standard_G3 - Standard_G4 - Standard_G5 - Standard_GS1 - Standard_GS2 - Standard_GS3 - Standard_GS4 - Standard_GS4-4 - Standard_GS4-8 - Standard_GS5 - Standard_GS5-16 - Standard_GS5-8 - Standard_H16 - Standard_H16m - Standard_H16mr - Standard_H16r - Standard_H8 - Standard_H8m - Standard_L16s - Standard_L32s - Standard_L4s - Standard_L8s - Standard_M128-32ms - Standard_M128-64ms - Standard_M128ms - Standard_M128s - Standard_M64-16ms - Standard_M64-32ms - Standard_M64ms - Standard_M64s - Standard_NC12 - Standard_NC12s_v2 - Standard_NC12s_v3 - Standard_NC24 - Standard_NC24r - Standard_NC24rs_v2 - Standard_NC24rs_v3 - Standard_NC24s_v2 - Standard_NC24s_v3 - Standard_NC6 - Standard_NC6s_v2 - Standard_NC6s_v3 - Standard_ND12s - Standard_ND24rs - Standard_ND24s - Standard_ND6s - Standard_NV12 - Standard_NV24 - Standard_NV6 type: string description: Size of agent VMs. CredentialResult: title: CredentialResult type: object properties: name: type: string description: The name of the credential. readOnly: true value: type: string description: Base64-encoded Kubernetes configuration file. readOnly: true description: The credential result response. CredentialResults: title: CredentialResults type: object properties: kubeconfigs: type: array items: $ref: '#/components/schemas/CredentialResult' description: Base64-encoded Kubernetes configuration file. readOnly: true description: The list of credential result response. ManagedCluster: title: ManagedCluster required: - location type: object properties: id: type: string description: Resource Id readOnly: true location: type: string description: Resource location name: type: string description: Resource name readOnly: true tags: type: object additionalProperties: type: string description: Resource tags type: type: string description: Resource type readOnly: true identity: $ref: '#/components/schemas/Identity' properties: $ref: '#/components/schemas/Properties3' description: Managed cluster. ManagedClusterAADProfile: title: ManagedClusterAADProfile required: - clientAppID - serverAppID type: object properties: clientAppID: type: string description: The client AAD application ID. serverAppID: type: string description: The server AAD application ID. serverAppSecret: type: string description: The server AAD application secret. tenantID: type: string description: The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription. description: AADProfile specifies attributes for Azure Active Directory integration. ManagedClusterAPIServerAccessProfile: title: ManagedClusterAPIServerAccessProfile type: object properties: authorizedIPRanges: type: array items: type: string description: Authorized IP Ranges to kubernetes API server. enablePrivateCluster: type: boolean description: Whether to create the cluster as a private cluster or not. description: Access profile for managed cluster API server. ManagedClusterAccessProfile: title: ManagedClusterAccessProfile required: - location type: object properties: id: type: string description: Resource Id readOnly: true location: type: string description: Resource location name: type: string description: Resource name readOnly: true tags: type: object additionalProperties: type: string description: Resource tags type: type: string description: Resource type readOnly: true properties: $ref: '#/components/schemas/Properties4' description: Managed cluster Access Profile. ManagedClusterAddonProfile: title: ManagedClusterAddonProfile required: - enabled type: object properties: config: type: object additionalProperties: type: string description: Key-value pairs for configuring an add-on. enabled: type: boolean description: Whether the add-on is enabled or not. identity: allOf: - $ref: '#/components/schemas/UserAssignedIdentity' - {} readOnly: true description: A Kubernetes add-on profile for a managed cluster. ManagedClusterAgentPoolProfile: title: ManagedClusterAgentPoolProfile required: - count - vmSize - name type: object properties: availabilityZones: type: array items: type: string description: Availability zones for nodes. Must use VirtualMachineScaleSets AgentPoolType. count: maximum: 100 minimum: 1 type: integer description: Number of agents (VMs) to host docker containers. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. format: int32 enableAutoScaling: type: boolean description: Whether to enable auto-scaler enableNodePublicIP: type: boolean description: Enable public IP for nodes maxCount: type: integer description: Maximum number of nodes for auto-scaling format: int32 maxPods: type: integer description: Maximum number of pods that can run on a node. format: int32 minCount: type: integer description: Minimum number of nodes for auto-scaling format: int32 nodeLabels: type: object additionalProperties: type: string description: Agent pool node labels to be persisted across all nodes in agent pool. nodeTaints: type: array items: type: string description: Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. orchestratorVersion: type: string description: Version of orchestrator specified when creating the managed cluster. osDiskSizeGB: maximum: 1023 minimum: 0 type: integer description: OS Disk Size in GB to be used to specify the disk size for every machine in this master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified. format: int32 osType: $ref: '#/components/schemas/OSType' provisioningState: type: string description: The current deployment or provisioning state, which only appears in the response. readOnly: true scaleSetEvictionPolicy: $ref: '#/components/schemas/ScaleSetEvictionPolicy' scaleSetPriority: $ref: '#/components/schemas/ScaleSetPriority' tags: type: object additionalProperties: type: string description: Agent pool tags to be persisted on the agent pool virtual machine scale set. type: $ref: '#/components/schemas/AgentPoolType' vmSize: $ref: '#/components/schemas/ContainerServiceVMSize' vnetSubnetID: type: string description: VNet SubnetID specifies the VNet's subnet identifier. name: pattern: ^[a-z][a-z0-9]{0,11}$ type: string description: Unique name of the agent pool profile in the context of the subscription and resource group. description: Profile for the container service agent pool. ManagedClusterAgentPoolProfileProperties: title: ManagedClusterAgentPoolProfileProperties required: - count - vmSize type: object properties: availabilityZones: type: array items: type: string description: Availability zones for nodes. Must use VirtualMachineScaleSets AgentPoolType. count: maximum: 100 minimum: 1 type: integer description: Number of agents (VMs) to host docker containers. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. format: int32 enableAutoScaling: type: boolean description: Whether to enable auto-scaler enableNodePublicIP: type: boolean description: Enable public IP for nodes maxCount: type: integer description: Maximum number of nodes for auto-scaling format: int32 maxPods: type: integer description: Maximum number of pods that can run on a node. format: int32 minCount: type: integer description: Minimum number of nodes for auto-scaling format: int32 nodeLabels: type: object additionalProperties: type: string description: Agent pool node labels to be persisted across all nodes in agent pool. nodeTaints: type: array items: type: string description: Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. orchestratorVersion: type: string description: Version of orchestrator specified when creating the managed cluster. osDiskSizeGB: maximum: 1023 minimum: 0 type: integer description: OS Disk Size in GB to be used to specify the disk size for every machine in this master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified. format: int32 osType: $ref: '#/components/schemas/OSType' provisioningState: type: string description: The current deployment or provisioning state, which only appears in the response. readOnly: true scaleSetEvictionPolicy: $ref: '#/components/schemas/ScaleSetEvictionPolicy' scaleSetPriority: $ref: '#/components/schemas/ScaleSetPriority' tags: type: object additionalProperties: type: string description: Agent pool tags to be persisted on the agent pool virtual machine scale set. type: $ref: '#/components/schemas/AgentPoolType' vmSize: $ref: '#/components/schemas/ContainerServiceVMSize' vnetSubnetID: type: string description: VNet SubnetID specifies the VNet's subnet identifier. description: Properties for the container service agent pool profile. ManagedClusterIdentity: title: ManagedClusterIdentity type: object properties: principalId: type: string description: The principal id of the system assigned identity which is used by master components. readOnly: true tenantId: type: string description: The tenant id of the system assigned identity which is used by master components. readOnly: true type: $ref: '#/components/schemas/Type' description: Identity for the managed cluster. ManagedClusterListResult: title: ManagedClusterListResult type: object properties: nextLink: type: string description: The URL to get the next set of managed cluster results. readOnly: true value: type: array items: $ref: '#/components/schemas/ManagedCluster' description: The list of managed clusters. description: The response from the List Managed Clusters operation. ManagedClusterLoadBalancerProfile: title: ManagedClusterLoadBalancerProfile type: object properties: allocatedOutboundPorts: maximum: 64000 minimum: 0 type: integer description: Desired number of allocated SNAT ports per VM. Allowed values must be in the range of 0 to 64000 (inclusive). The default value is 0 which results in Azure dynamically allocating ports. format: int32 default: 0 effectiveOutboundIPs: type: array items: $ref: '#/components/schemas/ResourceReference' description: The effective outbound IP resources of the cluster load balancer. idleTimeoutInMinutes: maximum: 120 minimum: 4 type: integer description: Desired outbound flow idle timeout in minutes. Allowed values must be in the range of 4 to 120 (inclusive). The default value is 30 minutes. format: int32 default: 30 managedOutboundIPs: $ref: '#/components/schemas/ManagedOutboundIPs2' outboundIPPrefixes: $ref: '#/components/schemas/OutboundIPPrefixes2' outboundIPs: $ref: '#/components/schemas/OutboundIPs2' description: Profile of the managed cluster load balancer. ManagedClusterPoolUpgradeProfile: title: ManagedClusterPoolUpgradeProfile required: - kubernetesVersion - osType type: object properties: kubernetesVersion: type: string description: Kubernetes version (major, minor, patch). name: type: string description: Pool name. osType: $ref: '#/components/schemas/OSType' upgrades: type: array items: $ref: '#/components/schemas/Upgrade' description: List of orchestrator types and versions available for upgrade. description: The list of available upgrade versions. ManagedClusterProperties: title: ManagedClusterProperties type: object properties: aadProfile: $ref: '#/components/schemas/AadProfile' addonProfiles: type: object additionalProperties: $ref: '#/components/schemas/ManagedClusterAddonProfile' description: Profile of managed cluster add-on. agentPoolProfiles: type: array items: $ref: '#/components/schemas/ManagedClusterAgentPoolProfile' description: Properties of the agent pool. apiServerAccessProfile: $ref: '#/components/schemas/ApiServerAccessProfile' diskEncryptionSetID: type: string description: ResourceId of the disk encryption set to use for enabling encryption at rest. dnsPrefix: type: string description: DNS prefix specified when creating the managed cluster. enablePodSecurityPolicy: type: boolean description: (PREVIEW) Whether to enable Kubernetes Pod security policy. enableRBAC: type: boolean description: Whether to enable Kubernetes Role-Based Access Control. fqdn: type: string description: FQDN for the master pool. readOnly: true identityProfile: type: object additionalProperties: $ref: '#/components/schemas/UserAssignedIdentity' description: Identities associated with the cluster. kubernetesVersion: type: string description: Version of Kubernetes specified when creating the managed cluster. linuxProfile: $ref: '#/components/schemas/LinuxProfile' maxAgentPools: type: integer description: The max number of agent pools for the managed cluster. format: int32 readOnly: true networkProfile: $ref: '#/components/schemas/NetworkProfile' nodeResourceGroup: type: string description: Name of the resource group containing agent pool nodes. privateFQDN: type: string description: FQDN of private cluster. readOnly: true provisioningState: type: string description: The current deployment or provisioning state, which only appears in the response. readOnly: true servicePrincipalProfile: $ref: '#/components/schemas/ServicePrincipalProfile' windowsProfile: $ref: '#/components/schemas/WindowsProfile' description: Properties of the managed cluster. ManagedClusterServicePrincipalProfile: title: ManagedClusterServicePrincipalProfile required: - clientId type: object properties: clientId: type: string description: The ID for the service principal. secret: type: string description: The secret password associated with the service principal in plain text. description: Information about a service principal identity for the cluster to use for manipulating Azure APIs. ManagedClusterUpgradeProfile: title: ManagedClusterUpgradeProfile required: - properties type: object properties: id: type: string description: Id of upgrade profile. readOnly: true name: type: string description: Name of upgrade profile. readOnly: true properties: $ref: '#/components/schemas/Properties5' type: type: string description: Type of upgrade profile. readOnly: true description: The list of available upgrades for compute pools. ManagedClusterUpgradeProfileProperties: title: ManagedClusterUpgradeProfileProperties required: - agentPoolProfiles - controlPlaneProfile type: object properties: agentPoolProfiles: type: array items: $ref: '#/components/schemas/ManagedClusterPoolUpgradeProfile' description: The list of available upgrade versions for agent pools. controlPlaneProfile: $ref: '#/components/schemas/ControlPlaneProfile' description: Control plane and agent pool upgrade profiles. ManagedClusterWindowsProfile: title: ManagedClusterWindowsProfile required: - adminUsername type: object properties: adminPassword: pattern: ^(?=.*[a-z])(?=.*[A-Z])(?=.*[!@#$%\^&\*\(\)])[a-zA-Z\d!@#$%\^&\*\(\)]{12,123}$ type: string description: The administrator password to use for Windows VMs. adminUsername: pattern: ^[a-zA-Z0-9]+([._]?[a-zA-Z0-9]+)*$ type: string description: The administrator username to use for Windows VMs. description: Profile for Windows VMs in the container service cluster. OSType: title: OSType enum: - Linux - Windows type: string description: OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux. OperationListResult: title: OperationListResult type: object properties: value: type: array items: $ref: '#/components/schemas/OperationValue' description: The list of compute operations readOnly: true description: The List Compute Operation operation response. OperationValue: title: OperationValue type: object properties: display: $ref: '#/components/schemas/Display' name: type: string description: The name of the compute operation. readOnly: true origin: type: string description: The origin of the compute operation. readOnly: true description: Describes the properties of a Compute Operation value. OperationValueDisplay: title: OperationValueDisplay type: object properties: description: type: string description: The description of the operation. readOnly: true operation: type: string description: The display name of the compute operation. readOnly: true provider: type: string description: The resource provider for the operation. readOnly: true resource: type: string description: The display name of the resource the operation applies to. readOnly: true description: Describes the properties of a Compute Operation Value Display. Resource: title: Resource required: - location type: object properties: id: type: string description: Resource Id readOnly: true location: type: string description: Resource location name: type: string description: Resource name readOnly: true tags: type: object additionalProperties: type: string description: Resource tags type: type: string description: Resource type readOnly: true description: The Resource model definition. ResourceReference: title: ResourceReference type: object properties: id: type: string description: The fully qualified Azure resource id. description: A reference to an Azure resource. ScaleSetEvictionPolicy: title: ScaleSetEvictionPolicy enum: - Delete - Deallocate type: string description: ScaleSetEvictionPolicy to be used to specify eviction policy for low priority virtual machine scale set. Default to Delete. ScaleSetPriority: title: ScaleSetPriority enum: - Low - Regular type: string description: ScaleSetPriority to be used to specify virtual machine scale set priority. Default to regular. SubResource: title: SubResource type: object properties: id: type: string description: Resource ID. readOnly: true name: type: string description: The name of the resource that is unique within a resource group. This name can be used to access the resource. readOnly: true type: type: string description: Resource type readOnly: true description: Reference to another subresource. TagsObject: title: TagsObject type: object properties: tags: type: object additionalProperties: type: string description: Resource tags. description: Tags object for patch operations. UserAssignedIdentity: title: UserAssignedIdentity type: object properties: clientId: type: string description: The client id of the user assigned identity. objectId: type: string description: The object id of the user assigned identity. resourceId: type: string description: The resource id of the user assigned identity. AgentPoolVersion: title: AgentPoolVersion type: object properties: default: type: boolean description: Whether this version is the default agent pool version. isPreview: type: boolean description: Whether Kubernetes version is currently in preview. kubernetesVersion: type: string description: Kubernetes version (major, minor, patch). Count: title: Count enum: - 1 - 3 - 5 type: integer description: Number of masters (VMs) in the container service cluster. Allowed values are 1, 3, and 5. The default value is 1. LoadBalancerSku: title: LoadBalancerSku enum: - standard - basic type: string description: The load balancer sku for the managed cluster. ManagedOutboundIPs: title: ManagedOutboundIPs type: object properties: count: maximum: 100 minimum: 1 type: integer description: Desired number of outbound IP created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. format: int32 default: 1 description: Desired managed outbound IPs for the cluster load balancer. NetworkPlugin: title: NetworkPlugin enum: - azure - kubenet type: string description: Network plugin used for building Kubernetes network. NetworkPolicy: title: NetworkPolicy enum: - calico - azure type: string description: Network policy used for building Kubernetes network. OutboundIPPrefixes: title: OutboundIPPrefixes type: object properties: publicIPPrefixes: type: array items: $ref: '#/components/schemas/ResourceReference' description: A list of public IP prefix resources. description: Desired outbound IP Prefix resources for the cluster load balancer. OutboundIPs: title: OutboundIPs type: object properties: publicIPs: type: array items: $ref: '#/components/schemas/ResourceReference' description: A list of public IP resources. description: Desired outbound IP resources for the cluster load balancer. OutboundType: title: OutboundType enum: - loadBalancer - userDefinedRouting type: string description: The outbound (egress) routing method. Type: title: Type enum: - SystemAssigned - None type: string description: The type of identity used for the managed cluster. Type 'SystemAssigned' will use an implicitly created identity in master components and an auto-created user assigned identity in MC_ resource group in agent nodes. Type 'None' will not use MSI for the managed cluster, service principal will be used instead. Upgrade: title: Upgrade type: object properties: isPreview: type: boolean description: Whether Kubernetes version is currently in preview. kubernetesVersion: type: string description: Kubernetes version (major, minor, patch). AadProfile: title: AadProfile required: - clientAppID - serverAppID type: object properties: clientAppID: type: string description: The client AAD application ID. serverAppID: type: string description: The server AAD application ID. serverAppSecret: type: string description: The server AAD application secret. tenantID: type: string description: The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription. ApiServerAccessProfile: title: ApiServerAccessProfile type: object properties: authorizedIPRanges: type: array items: type: string description: Authorized IP Ranges to kubernetes API server. enablePrivateCluster: type: boolean description: Whether to create the cluster as a private cluster or not. ControlPlaneProfile: title: ControlPlaneProfile required: - kubernetesVersion - osType type: object properties: kubernetesVersion: type: string description: Kubernetes version (major, minor, patch). name: type: string description: Pool name. osType: $ref: '#/components/schemas/OSType' upgrades: type: array items: $ref: '#/components/schemas/Upgrade' description: List of orchestrator types and versions available for upgrade. Display: title: Display type: object properties: description: type: string description: The description of the operation. readOnly: true operation: type: string description: The display name of the compute operation. readOnly: true provider: type: string description: The resource provider for the operation. readOnly: true resource: type: string description: The display name of the resource the operation applies to. readOnly: true Error: title: Error type: object properties: code: type: string description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. details: type: array items: $ref: '#/components/schemas/CloudErrorBody' description: A list of additional details about the error. 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. Identity: title: Identity type: object properties: principalId: type: string description: The principal id of the system assigned identity which is used by master components. readOnly: true tenantId: type: string description: The tenant id of the system assigned identity which is used by master components. readOnly: true type: $ref: '#/components/schemas/Type' LinuxProfile: title: LinuxProfile required: - adminUsername - ssh type: object properties: adminUsername: pattern: ^[A-Za-z][-A-Za-z0-9_]*$ type: string description: The administrator username to use for Linux VMs. ssh: $ref: '#/components/schemas/Ssh' LoadBalancerProfile: title: LoadBalancerProfile type: object properties: allocatedOutboundPorts: maximum: 64000 minimum: 0 type: integer description: Desired number of allocated SNAT ports per VM. Allowed values must be in the range of 0 to 64000 (inclusive). The default value is 0 which results in Azure dynamically allocating ports. format: int32 default: 0 effectiveOutboundIPs: type: array items: $ref: '#/components/schemas/ResourceReference' description: The effective outbound IP resources of the cluster load balancer. idleTimeoutInMinutes: maximum: 120 minimum: 4 type: integer description: Desired outbound flow idle timeout in minutes. Allowed values must be in the range of 4 to 120 (inclusive). The default value is 30 minutes. format: int32 default: 30 managedOutboundIPs: $ref: '#/components/schemas/ManagedOutboundIPs2' outboundIPPrefixes: $ref: '#/components/schemas/OutboundIPPrefixes2' outboundIPs: $ref: '#/components/schemas/OutboundIPs2' ManagedOutboundIPs2: title: ManagedOutboundIPs2 type: object properties: count: maximum: 100 minimum: 1 type: integer description: Desired number of outbound IP created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. format: int32 default: 1 NetworkProfile: title: NetworkProfile type: object properties: dnsServiceIP: pattern: ^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$ type: string description: An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. default: 10.0.0.10 dockerBridgeCidr: pattern: ^([0-9]{1,3}\.){3}[0-9]{1,3}(\/([0-9]|[1-2][0-9]|3[0-2]))?$ type: string description: A CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the Kubernetes service address range. default: 172.17.0.1/16 loadBalancerProfile: $ref: '#/components/schemas/LoadBalancerProfile' loadBalancerSku: $ref: '#/components/schemas/LoadBalancerSku' networkPlugin: $ref: '#/components/schemas/NetworkPlugin' networkPolicy: $ref: '#/components/schemas/NetworkPolicy' outboundType: $ref: '#/components/schemas/OutboundType' podCidr: pattern: ^([0-9]{1,3}\.){3}[0-9]{1,3}(\/([0-9]|[1-2][0-9]|3[0-2]))?$ type: string description: A CIDR notation IP range from which to assign pod IPs when kubenet is used. default: 10.244.0.0/16 serviceCidr: pattern: ^([0-9]{1,3}\.){3}[0-9]{1,3}(\/([0-9]|[1-2][0-9]|3[0-2]))?$ type: string description: A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. default: 10.0.0.0/16 OutboundIPPrefixes2: title: OutboundIPPrefixes2 type: object properties: publicIPPrefixes: type: array items: $ref: '#/components/schemas/ResourceReference' description: A list of public IP prefix resources. OutboundIPs2: title: OutboundIPs2 type: object properties: publicIPs: type: array items: $ref: '#/components/schemas/ResourceReference' description: A list of public IP resources. Properties: title: Properties required: - count - vmSize type: object properties: availabilityZones: type: array items: type: string description: Availability zones for nodes. Must use VirtualMachineScaleSets AgentPoolType. count: maximum: 100 minimum: 1 type: integer description: Number of agents (VMs) to host docker containers. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. format: int32 enableAutoScaling: type: boolean description: Whether to enable auto-scaler enableNodePublicIP: type: boolean description: Enable public IP for nodes maxCount: type: integer description: Maximum number of nodes for auto-scaling format: int32 maxPods: type: integer description: Maximum number of pods that can run on a node. format: int32 minCount: type: integer description: Minimum number of nodes for auto-scaling format: int32 nodeLabels: type: object additionalProperties: type: string description: Agent pool node labels to be persisted across all nodes in agent pool. nodeTaints: type: array items: type: string description: Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. orchestratorVersion: type: string description: Version of orchestrator specified when creating the managed cluster. osDiskSizeGB: maximum: 1023 minimum: 0 type: integer description: OS Disk Size in GB to be used to specify the disk size for every machine in this master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified. format: int32 osType: $ref: '#/components/schemas/OSType' provisioningState: type: string description: The current deployment or provisioning state, which only appears in the response. readOnly: true scaleSetEvictionPolicy: $ref: '#/components/schemas/ScaleSetEvictionPolicy' scaleSetPriority: $ref: '#/components/schemas/ScaleSetPriority' tags: type: object additionalProperties: type: string description: Agent pool tags to be persisted on the agent pool virtual machine scale set. type: $ref: '#/components/schemas/AgentPoolType' vmSize: $ref: '#/components/schemas/ContainerServiceVMSize' vnetSubnetID: type: string description: VNet SubnetID specifies the VNet's subnet identifier. Properties1: title: Properties1 type: object properties: agentPoolVersions: type: array items: $ref: '#/components/schemas/AgentPoolVersion' description: List of versions available for agent pool. Properties2: title: Properties2 required: - kubernetesVersion - osType type: object properties: kubernetesVersion: type: string description: Kubernetes version (major, minor, patch). osType: $ref: '#/components/schemas/OSType' upgrades: type: array items: $ref: '#/components/schemas/Upgrade' description: List of orchestrator types and versions available for upgrade. Properties3: title: Properties3 type: object properties: aadProfile: $ref: '#/components/schemas/AadProfile' addonProfiles: type: object additionalProperties: $ref: '#/components/schemas/ManagedClusterAddonProfile' description: Profile of managed cluster add-on. agentPoolProfiles: type: array items: $ref: '#/components/schemas/ManagedClusterAgentPoolProfile' description: Properties of the agent pool. apiServerAccessProfile: $ref: '#/components/schemas/ApiServerAccessProfile' diskEncryptionSetID: type: string description: ResourceId of the disk encryption set to use for enabling encryption at rest. dnsPrefix: type: string description: DNS prefix specified when creating the managed cluster. enablePodSecurityPolicy: type: boolean description: (PREVIEW) Whether to enable Kubernetes Pod security policy. enableRBAC: type: boolean description: Whether to enable Kubernetes Role-Based Access Control. fqdn: type: string description: FQDN for the master pool. readOnly: true identityProfile: type: object additionalProperties: $ref: '#/components/schemas/UserAssignedIdentity' description: Identities associated with the cluster. kubernetesVersion: type: string description: Version of Kubernetes specified when creating the managed cluster. linuxProfile: $ref: '#/components/schemas/LinuxProfile' maxAgentPools: type: integer description: The max number of agent pools for the managed cluster. format: int32 readOnly: true networkProfile: $ref: '#/components/schemas/NetworkProfile' nodeResourceGroup: type: string description: Name of the resource group containing agent pool nodes. privateFQDN: type: string description: FQDN of private cluster. readOnly: true provisioningState: type: string description: The current deployment or provisioning state, which only appears in the response. readOnly: true servicePrincipalProfile: $ref: '#/components/schemas/ServicePrincipalProfile' windowsProfile: $ref: '#/components/schemas/WindowsProfile' Properties4: title: Properties4 type: object properties: kubeConfig: type: string description: Base64-encoded Kubernetes configuration file. Properties5: title: Properties5 required: - agentPoolProfiles - controlPlaneProfile type: object properties: agentPoolProfiles: type: array items: $ref: '#/components/schemas/ManagedClusterPoolUpgradeProfile' description: The list of available upgrade versions for agent pools. controlPlaneProfile: $ref: '#/components/schemas/ControlPlaneProfile' ServicePrincipalProfile: title: ServicePrincipalProfile required: - clientId type: object properties: clientId: type: string description: The ID for the service principal. secret: type: string description: The secret password associated with the service principal in plain text. Ssh: title: Ssh required: - publicKeys type: object properties: publicKeys: type: array items: $ref: '#/components/schemas/ContainerServiceSshPublicKey' description: The list of SSH public keys used to authenticate with Linux-based VMs. Only expect one key specified. SubscriptionsResourceGroupsProvidersMicrosoftContainerServiceManagedClustersResourceNameAgentPoolsAgentPoolNameRequest: title: SubscriptionsResourceGroupsProvidersMicrosoftContainerServiceManagedClustersResourceNameAgentPoolsAgentPoolNameRequest type: object properties: id: type: string description: Resource ID. readOnly: true name: type: string description: The name of the resource that is unique within a resource group. This name can be used to access the resource. readOnly: true type: type: string description: Resource type readOnly: true properties: $ref: '#/components/schemas/Properties' SubscriptionsResourceGroupsProvidersMicrosoftContainerServiceManagedClustersResourceNameRequest: title: SubscriptionsResourceGroupsProvidersMicrosoftContainerServiceManagedClustersResourceNameRequest type: object properties: tags: type: object additionalProperties: type: string description: Resource tags. SubscriptionsResourceGroupsProvidersMicrosoftContainerServiceManagedClustersResourceNameRequest1: title: SubscriptionsResourceGroupsProvidersMicrosoftContainerServiceManagedClustersResourceNameRequest1 required: - location type: object properties: id: type: string description: Resource Id readOnly: true location: type: string description: Resource location name: type: string description: Resource name readOnly: true tags: type: object additionalProperties: type: string description: Resource tags type: type: string description: Resource type readOnly: true identity: $ref: '#/components/schemas/Identity' properties: $ref: '#/components/schemas/Properties3' SubscriptionsResourceGroupsProvidersMicrosoftContainerServiceManagedClustersResourceNameResetAADProfileRequest: title: SubscriptionsResourceGroupsProvidersMicrosoftContainerServiceManagedClustersResourceNameResetAADProfileRequest required: - clientAppID - serverAppID type: object properties: clientAppID: type: string description: The client AAD application ID. serverAppID: type: string description: The server AAD application ID. serverAppSecret: type: string description: The server AAD application secret. tenantID: type: string description: The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription. SubscriptionsResourceGroupsProvidersMicrosoftContainerServiceManagedClustersResourceNameResetServicePrincipalProfileRequest: title: SubscriptionsResourceGroupsProvidersMicrosoftContainerServiceManagedClustersResourceNameResetServicePrincipalProfileRequest required: - clientId type: object properties: clientId: type: string description: The ID for the service principal. secret: type: string description: The secret password associated with the service principal in plain text. VmDiagnostics: title: VmDiagnostics required: - enabled type: object properties: enabled: type: boolean description: Whether the VM diagnostic agent is provisioned on the VM. storageUri: type: string description: The URI of the storage account where diagnostics are stored. readOnly: true WindowsProfile: title: WindowsProfile required: - adminUsername type: object properties: adminPassword: pattern: ^(?=.*[a-z])(?=.*[A-Z])(?=.*[!@#$%\^&\*\(\)])[a-zA-Z\d!@#$%\^&\*\(\)]{12,123}$ type: string description: The administrator password to use for Windows VMs. adminUsername: pattern: ^[a-zA-Z0-9]+([._]?[a-zA-Z0-9]+)*$ type: string description: The administrator username to use for Windows VMs. securitySchemes: azure_auth: type: oauth2 description: Azure Active Directory OAuth2 Flow flows: implicit: authorizationUrl: https://management.azure.com/authorize scopes: user_impersonation: impersonate your user account security: - azure_auth: - user_impersonation tags: - name: managedClusters description: '' - name: ManagedClusters description: '' - name: AgentPools description: ''