@itentialopensource/adapter-azure_aks

{ "swagger": "2.0", "schemes": [ "https" ], "host": "management.azure.com", "info": { "description": "The Container Service Client.", "title": "ContainerServiceClient", "version": "2020-01-01", "x-apisguru-categories": [ "cloud" ], "x-logo": { "url": "https://assets.onestore.ms/cdnfiles/onestorerolling-1606-01000/shell/v3/images/logo/microsoft.png" }, "x-origin": [ { "format": "swagger", "url": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-01-01/managedClusters.json", "version": "2.0" } ], "x-preferred": false, "x-providerName": "azure.com", "x-serviceName": "containerservice-managedClusters", "x-tags": [ "Azure", "Microsoft" ] }, "consumes": [ "application/json" ], "produces": [ "application/json" ], "securityDefinitions": { "azure_auth": { "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "description": "Azure Active Directory OAuth2 Flow", "flow": "implicit", "scopes": { "user_impersonation": "impersonate your user account" }, "type": "oauth2" } }, "security": [ { "azure_auth": [ "user_impersonation" ] } ], "parameters": { "ApiVersionParameter": { "description": "Client Api Version.", "in": "query", "name": "api-version", "required": true, "type": "string", "x-ms-parameter-location": "client" }, "ResourceGroupNameParameter": { "description": "The name of the resource group.", "in": "path", "minLength": 1, "name": "resourceGroupName", "required": true, "type": "string", "x-ms-parameter-location": "method" }, "ResourceNameParameter": { "description": "The name of the managed cluster resource.", "in": "path", "maxLength": 63, "minLength": 1, "name": "resourceName", "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$", "required": true, "type": "string", "x-ms-parameter-location": "method" }, "SubscriptionIdParameter": { "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.", "in": "path", "name": "subscriptionId", "required": true, "type": "string", "x-ms-parameter-location": "client" } }, "paths": { "/providers/Microsoft.ContainerService/operations": { "get": { "description": "Gets a list of compute operations.", "operationId": "Operations_List", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OperationListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "tags": [ "managedClusters" ], "x-ms-pageable": { "nextLinkName": null } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/managedClusters": { "get": { "description": "Gets a list of managed clusters in the specified subscription. The operation returns properties of each managed cluster.", "operationId": "ManagedClusters_List", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ManagedClusterListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "summary": "Gets a list of managed clusters in the specified subscription.", "tags": [ "ManagedClusters" ], "x-ms-examples": { "List Managed Clusters": { "parameters": { "api-version": "2020-01-01", "subscriptionId": "subid1" }, "responses": { "200": { "body": { "value": [ { "id": "/subscriptions/subid1/providers/Microsoft.ContainerService/managedClusters", "location": "location1", "name": "clustername1", "properties": { "agentPoolProfiles": [ { "count": 3, "maxPods": 110, "name": "nodepool1", "orchestratorVersion": "1.9.6", "osType": "Linux", "provisioningState": "Succeeded", "vmSize": "Standard_DS1_v2" } ], "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", "dnsPrefix": "dnsprefix1", "enableRBAC": false, "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", "kubernetesVersion": "1.9.6", "linuxProfile": { "adminUsername": "azureuser", "ssh": { "publicKeys": [ { "keyData": "keydata" } ] } }, "maxAgentPools": 1, "networkProfile": { "dnsServiceIP": "10.0.0.10", "dockerBridgeCidr": "172.17.0.1/16", "networkPlugin": "kubenet", "podCidr": "10.244.0.0/16", "serviceCidr": "10.0.0.0/16" }, "nodeResourceGroup": "MC_rg1_clustername1_location1", "provisioningState": "Succeeded", "servicePrincipalProfile": { "clientId": "clientid" } }, "tags": { "archv2": "", "tier": "production" }, "type": "Microsoft.ContainerService/ManagedClusters" } ] } } } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters": { "get": { "description": "Lists managed clusters in the specified subscription and resource group. The operation returns properties of each managed cluster.", "operationId": "ManagedClusters_ListByResourceGroup", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/ResourceGroupNameParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ManagedClusterListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "summary": "Lists managed clusters in the specified subscription and resource group.", "tags": [ "ManagedClusters" ], "x-ms-examples": { "Get Managed Clusters by Resource Group": { "parameters": { "api-version": "2020-01-01", "resourceGroupName": "rg1", "subscriptionId": "subid1" }, "responses": { "200": { "body": { "value": [ { "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters", "location": "location1", "name": "clustername1", "properties": { "agentPoolProfiles": [ { "count": 3, "maxPods": 110, "name": "nodepool1", "orchestratorVersion": "1.9.6", "osType": "Linux", "provisioningState": "Succeeded", "vmSize": "Standard_DS1_v2" } ], "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", "dnsPrefix": "dnsprefix1", "enableRBAC": false, "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", "kubernetesVersion": "1.9.6", "linuxProfile": { "adminUsername": "azureuser", "ssh": { "publicKeys": [ { "keyData": "keydata" } ] } }, "maxAgentPools": 1, "networkProfile": { "dnsServiceIP": "10.0.0.10", "dockerBridgeCidr": "172.17.0.1/16", "networkPlugin": "kubenet", "podCidr": "10.244.0.0/16", "serviceCidr": "10.0.0.0/16" }, "nodeResourceGroup": "MC_rg1_clustername1_location1", "provisioningState": "Succeeded", "servicePrincipalProfile": { "clientId": "clientid" } }, "tags": { "archv2": "", "tier": "production" }, "type": "Microsoft.ContainerService/ManagedClusters" } ] } } } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}": { "delete": { "description": "Deletes the managed cluster with a specified resource group and name.", "operationId": "ManagedClusters_Delete", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ResourceNameParameter" } ], "responses": { "202": { "description": "Accepted" }, "204": { "description": "NoContent" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "summary": "Deletes a managed cluster.", "tags": [ "ManagedClusters" ], "x-ms-examples": { "Delete Managed Cluster": { "parameters": { "api-version": "2020-01-01", "resourceGroupName": "rg1", "resourceName": "clustername1", "subscriptionId": "subid1" }, "responses": { "202": {}, "204": {} } } }, "x-ms-long-running-operation": true }, "get": { "description": "Gets the details of the managed cluster with a specified resource group and name.", "operationId": "ManagedClusters_Get", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ResourceNameParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ManagedCluster" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "summary": "Gets a managed cluster.", "tags": [ "ManagedClusters" ], "x-ms-examples": { "Get Managed Cluster": { "parameters": { "api-version": "2020-01-01", "resourceGroupName": "rg1", "resourceName": "clustername1", "subscriptionId": "subid1" }, "responses": { "200": { "body": { "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", "location": "location1", "name": "clustername1", "properties": { "agentPoolProfiles": [ { "availabilityZones": [ "1", "2", "3" ], "count": 3, "maxPods": 110, "name": "nodepool1", "orchestratorVersion": "1.9.6", "osType": "Linux", "provisioningState": "Succeeded", "vmSize": "Standard_DS1_v2" } ], "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", "dnsPrefix": "dnsprefix1", "enableRBAC": false, "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", "kubernetesVersion": "1.9.6", "linuxProfile": { "adminUsername": "azureuser", "ssh": { "publicKeys": [ { "keyData": "keydata" } ] } }, "maxAgentPools": 1, "networkProfile": { "dnsServiceIP": "10.0.0.10", "dockerBridgeCidr": "172.17.0.1/16", "loadBalancerProfile": { "allocatedOutboundPorts": 2000, "effectiveOutboundIPs": [ { "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" }, { "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" } ], "idleTimeoutInMinutes": 10, "outboundIPs": { "publicIPs": [ { "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/customeroutboundip1" }, { "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/customeroutboundip2" } ] } }, "loadBalancerSku": "standard", "networkPlugin": "kubenet", "outboundType": "loadBalancer", "podCidr": "10.244.0.0/16", "serviceCidr": "10.0.0.0/16" }, "nodeResourceGroup": "MC_rg1_clustername1_location1", "provisioningState": "Succeeded", "servicePrincipalProfile": { "clientId": "clientid" } }, "tags": { "archv2": "", "tier": "production" }, "type": "Microsoft.ContainerService/ManagedClusters" } } } } } }, "patch": { "description": "Updates a managed cluster with the specified tags.", "operationId": "ManagedClusters_UpdateTags", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ResourceNameParameter" }, { "description": "Parameters supplied to the Update Managed Cluster Tags operation.", "in": "body", "name": "parameters", "required": true, "schema": { "$ref": "#/definitions/TagsObject" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ManagedCluster" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "summary": "Updates tags on a managed cluster.", "tags": [ "ManagedClusters" ], "x-ms-examples": { "Update Managed Cluster Tags": { "parameters": { "api-version": "2020-01-01", "parameters": { "tags": { "archv3": "", "tier": "testing" } }, "resourceGroupName": "rg1", "resourceName": "clustername1", "subscriptionId": "subid1" }, "responses": { "200": { "body": { "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", "location": "location1", "name": "clustername1", "properties": { "agentPoolProfiles": [ { "count": 3, "maxPods": 110, "name": "nodepool1", "orchestratorVersion": "1.9.6", "osType": "Linux", "provisioningState": "Succeeded", "vmSize": "Standard_DS1_v2" } ], "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", "dnsPrefix": "dnsprefix1", "enableRBAC": false, "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", "kubernetesVersion": "1.9.6", "linuxProfile": { "adminUsername": "azureuser", "ssh": { "publicKeys": [ { "keyData": "keydata" } ] } }, "networkProfile": { "dnsServiceIP": "10.0.0.10", "dockerBridgeCidr": "172.17.0.1/16", "networkPlugin": "kubenet", "podCidr": "10.244.0.0/16", "serviceCidr": "10.0.0.0/16" }, "nodeResourceGroup": "MC_rg1_clustername1_location1", "provisioningState": "Succeeded", "servicePrincipalProfile": { "clientId": "clientid" } }, "tags": { "archv3": "", "tier": "testing" }, "type": "Microsoft.ContainerService/ManagedClusters" } } } } }, "x-ms-long-running-operation": true }, "put": { "description": "Creates or updates a managed cluster with the specified configuration for agents and Kubernetes version.", "operationId": "ManagedClusters_CreateOrUpdate", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ResourceNameParameter" }, { "description": "Parameters supplied to the Create or Update a Managed Cluster operation.", "in": "body", "name": "parameters", "required": true, "schema": { "$ref": "#/definitions/ManagedCluster" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ManagedCluster" } }, "201": { "description": "Created", "schema": { "$ref": "#/definitions/ManagedCluster" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "summary": "Creates or updates a managed cluster.", "tags": [ "ManagedClusters" ], "x-ms-examples": { "Create/Update Managed Cluster": { "parameters": { "api-version": "2020-01-01", "parameters": { "location": "location1", "properties": { "addonProfiles": {}, "agentPoolProfiles": [ { "availabilityZones": [ "1", "2", "3" ], "count": 3, "enableNodePublicIP": true, "name": "nodepool1", "osType": "Linux", "type": "VirtualMachineScaleSets", "vmSize": "Standard_DS1_v2" } ], "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", "dnsPrefix": "dnsprefix1", "enablePodSecurityPolicy": true, "enableRBAC": true, "kubernetesVersion": "", "linuxProfile": { "adminUsername": "azureuser", "ssh": { "publicKeys": [ { "keyData": "keydata" } ] } }, "networkProfile": { "loadBalancerProfile": { "managedOutboundIPs": { "count": 2 } }, "loadBalancerSku": "standard", "outboundType": "loadBalancer" }, "servicePrincipalProfile": { "clientId": "clientid", "secret": "secret" }, "windowsProfile": { "adminPassword": "replacePassword1234$", "adminUsername": "azureuser" } }, "tags": { "archv2": "", "tier": "production" } }, "resourceGroupName": "rg1", "resourceName": "clustername1", "subscriptionId": "subid1" }, "responses": { "200": { "body": { "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", "location": "location1", "name": "clustername1", "properties": { "agentPoolProfiles": [ { "availabilityZones": [ "1", "2", "3" ], "count": 3, "enableNodePublicIP": true, "maxPods": 110, "name": "nodepool1", "orchestratorVersion": "1.9.6", "osType": "Linux", "provisioningState": "Succeeded", "type": "VirtualMachineScaleSets", "vmSize": "Standard_DS1_v2" } ], "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", "dnsPrefix": "dnsprefix1", "enablePodSecurityPolicy": true, "enableRBAC": true, "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", "kubernetesVersion": "1.9.6", "linuxProfile": { "adminUsername": "azureuser", "ssh": { "publicKeys": [ { "keyData": "keydata" } ] } }, "maxAgentPools": 1, "networkProfile": { "dnsServiceIP": "10.0.0.10", "dockerBridgeCidr": "172.17.0.1/16", "loadBalancerProfile": { "allocatedOutboundPorts": 2000, "effectiveOutboundIPs": [ { "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" }, { "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" } ], "idleTimeoutInMinutes": 10, "managedOutboundIPs": { "count": 2 } }, "loadBalancerSku": "basic", "networkPlugin": "kubenet", "outboundType": "loadBalancer", "podCidr": "10.244.0.0/16", "serviceCidr": "10.0.0.0/16" }, "nodeResourceGroup": "MC_rg1_clustername1_location1", "provisioningState": "Succeeded", "servicePrincipalProfile": { "clientId": "clientid" }, "windowsProfile": { "adminUsername": "azureuser" } }, "tags": { "archv2": "", "tier": "production" }, "type": "Microsoft.ContainerService/ManagedClusters" } }, "201": { "body": { "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", "location": "location1", "name": "clustername1", "properties": { "agentPoolProfiles": [ { "availabilityZones": [ "1", "2", "3" ], "count": 3, "enableNodePublicIP": true, "maxPods": 110, "name": "nodepool1", "orchestratorVersion": "1.9.6", "osType": "Linux", "provisioningState": "Creating", "type": "VirtualMachineScaleSets", "vmSize": "Standard_DS1_v2" } ], "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", "dnsPrefix": "dnsprefix1", "enablePodSecurityPolicy": true, "enableRBAC": true, "kubernetesVersion": "1.9.6", "linuxProfile": { "adminUsername": "azureuser", "ssh": { "publicKeys": [ { "keyData": "keydata" } ] } }, "maxAgentPools": 1, "networkProfile": { "dnsServiceIP": "10.0.0.10", "dockerBridgeCidr": "172.17.0.1/16", "loadBalancerProfile": { "allocatedOutboundPorts": 2000, "effectiveOutboundIPs": [ { "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" }, { "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" } ], "idleTimeoutInMinutes": 10, "managedOutboundIPs": { "count": 2 } }, "loadBalancerSku": "standard", "networkPlugin": "kubenet", "outboundType": "loadBalancer", "podCidr": "10.244.0.0/16", "serviceCidr": "10.0.0.0/16" }, "nodeResourceGroup": "MC_rg1_clustername1_location1", "provisioningState": "Creating", "servicePrincipalProfile": { "clientId": "clientid" }, "windowsProfile": { "adminUsername": "azureuser" } }, "tags": { "archv2": "", "tier": "production" }, "type": "Microsoft.ContainerService/ManagedClusters" } } } } }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/accessProfiles/{roleName}/listCredential": { "post": { "description": "Gets the accessProfile for the specified role name of the managed cluster with a specified resource group and name.", "operationId": "ManagedClusters_GetAccessProfile", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ResourceNameParameter" }, { "description": "The name of the role for managed cluster accessProfile resource.", "in": "path", "name": "roleName", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ManagedClusterAccessProfile" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "summary": "Gets an access profile of a managed cluster.", "tags": [ "ManagedClusters" ], "x-ms-examples": { "Get Managed Cluster": { "parameters": { "api-version": "2020-01-01", "resourceGroupName": "rg1", "resourceName": "clustername1", "roleName": "clusterUser", "subscriptionId": "subid1" }, "responses": { "200": { "body": { "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/accessProfiles/clusterUser", "location": "location1", "name": "clusterUser", "properties": { "kubeConfig": "kubeConfig1" }, "type": "Microsoft.ContainerService/ManagedClusters/AccessProfiles" } } } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools": { "get": { "description": "Gets a list of agent pools in the specified managed cluster. The operation returns properties of each agent pool.", "operationId": "AgentPools_List", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ResourceNameParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/AgentPoolListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "summary": "Gets a list of agent pools in the specified managed cluster.", "tags": [ "AgentPools" ], "x-ms-examples": { "List Agent Pools by Managed Cluster": { "parameters": { "api-version": "2020-01-01", "resourceGroupName": "rg1", "resourceName": "clustername1", "subscriptionId": "subid1" }, "responses": { "200": { "body": { "value": [ { "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", "name": "agentpool1", "properties": { "count": 3, "maxPods": 110, "orchestratorVersion": "1.9.6", "osType": "Linux", "provisioningState": "Succeeded", "vmSize": "Standard_DS1_v2" } } ] } } } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}": { "delete": { "description": "Deletes the agent pool in the specified managed cluster.", "operationId": "AgentPools_Delete", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ResourceNameParameter" }, { "description": "The name of the agent pool.", "in": "path", "name": "agentPoolName", "required": true, "type": "string" } ], "responses": { "202": { "description": "Accepted" }, "204": { "description": "NoContent" }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "summary": "Deletes an agent pool.", "tags": [ "AgentPools" ], "x-ms-examples": { "Delete Agent Pool": { "parameters": { "agentPoolName": "agentpool1", "api-version": "2020-01-01", "resourceGroupName": "rg1", "resourceName": "clustername1", "subscriptionId": "subid1" }, "responses": { "202": {}, "204": {} } } }, "x-ms-long-running-operation": true }, "get": { "description": "Gets the details of the agent pool by managed cluster and resource group.", "operationId": "AgentPools_Get", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ResourceNameParameter" }, { "description": "The name of the agent pool.", "in": "path", "name": "agentPoolName", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/AgentPool" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "summary": "Gets the agent pool.", "tags": [ "AgentPools" ], "x-ms-examples": { "Get Agent Pool": { "parameters": { "agentPoolName": "agentpool1", "api-version": "2020-01-01", "resourceGroupName": "rg1", "resourceName": "clustername1", "subscriptionId": "subid1" }, "responses": { "200": { "body": { "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", "name": "agentpool1", "properties": { "count": 3, "maxPods": 110, "orchestratorVersion": "1.9.6", "osType": "Linux", "provisioningState": "Succeeded", "vmSize": "Standard_DS1_v2" } } } } } } }, "put": { "description": "Creates or updates an agent pool in the specified managed cluster.", "operationId": "AgentPools_CreateOrUpdate", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ResourceNameParameter" }, { "description": "The name of the agent pool.", "in": "path", "name": "agentPoolName", "required": true, "type": "string" }, { "description": "Parameters supplied to the Create or Update an agent pool operation.", "in": "body", "name": "parameters", "required": true, "schema": { "$ref": "#/definitions/AgentPool" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/AgentPool" } }, "201": { "description": "Created", "schema": { "$ref": "#/definitions/AgentPool" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "summary": "Creates or updates an agent pool.", "tags": [ "AgentPools" ], "x-ms-examples": { "Create/Update Agent Pool": { "parameters": { "agentPoolName": "agentpool1", "api-version": "2020-01-01", "parameters": { "properties": { "count": 3, "nodeLabels": { "key1": "val1" }, "nodeTaints": [ "Key1=Value1:NoSchedule" ], "orchestratorVersion": "", "osType": "Linux", "scaleSetEvictionPolicy": "Delete", "scaleSetPriority": "Low", "tags": { "name1": "val1" }, "vmSize": "Standard_DS1_v2" } }, "resourceGroupName": "rg1", "resourceName": "clustername1", "subscriptionId": "subid1" }, "responses": { "200": { "body": { "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", "name": "agentpool1", "properties": { "count": 3, "maxPods": 110, "nodeLabels": { "key1": "val1" }, "nodeTaints": [ "Key1=Value1:NoSchedule" ], "orchestratorVersion": "1.9.6", "osType": "Linux", "provisioningState": "Succeeded", "scaleSetEvictionPolicy": "Delete", "scaleSetPriority": "Low", "tags": { "name1": "val1" }, "vmSize": "Standard_DS1_v2" }, "type": "Microsoft.ContainerService/managedClusters/agentPools" } }, "201": { "body": { "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", "name": "agentpool1", "properties": { "count": 3, "maxPods": 110, "nodeLabels": { "key1": "val1" }, "nodeTaints": [ "Key1=Value1:NoSchedule" ], "orchestratorVersion": "1.9.6", "osType": "Linux", "provisioningState": "Creating", "scaleSetEvictionPolicy": "Delete", "scaleSetPriority": "Low", "tags": { "name1": "val1" }, "vmSize": "Standard_DS1_v2" }, "type": "Microsoft.ContainerService/managedClusters/agentPools" } } } } }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/upgradeProfiles/default": { "get": { "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": [ { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" }, { "$ref": "#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ResourceNameParameter" }, { "description": "The name of the agent pool.", "in": "path", "name": "agentPoolName", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/AgentPoolUpgradeProfile" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "summary": "Gets upgrade profile for an agent pool.", "tags": [ "AgentPools" ], "x-ms-examples": { "Get Upgrade Profile for Agent Pool": { "parameters": { "agentPoolName": "agentpool1", "api-version": "2020-01-01", "resourceGroupName": "rg1", "resourceName": "clustername1", "subscriptionId": "subid1" }, "responses": { "200": { "body": { "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1/upgradeprofiles/default", "name": "default", "properties": { "kubernetesVersion": "1.12.8", "osType": "Linux", "upgrades": [ { "kubernetesVersion": "1.13.5" } ] }, "type": "Microsoft.ContainerService/managedClusters