@itentialopensource/adapter-azure_aks
Version:
This adapter integrates with system described as: Azure AKS.
1,433 lines • 109 kB
YAML
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/sch