Icon

Azure Container Service (AKS) (version v1.*.*)

create_update_agent_pool

Creates or updates an agent pool in the specified managed cluster.

Parameters

agentPoolName (required)

The name of the agent pool.

Type: string

api-version (required)

Client Api Version.

Type: string

resourceGroupName (required)

The name of the resource group.

Type: string

resourceName (required)

The name of the managed cluster resource.

Type: string

subscriptionId (required)

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Type: string

$body

Parameters supplied to the Create or Update an agent pool operation.

Type: object

{
"name" : "The name of the resource that is unique within a resource group. This name can be used to access the resource.",
"id" : "Resource ID.",
"type" : "Resource type",
"properties" : {
"osDiskSizeGB" : "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.",
"count" : "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.",
"spotMaxPrice" : "SpotMaxPrice to be used to specify the maximum price you are willing to pay in US Dollars. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand.",
"vnetSubnetID" : "VNet SubnetID specifies the VNet's subnet identifier.",
"availabilityZones" : [ "string" ],
"enableAutoScaling" : "Whether to enable auto-scaler",
"orchestratorVersion" : "Version of orchestrator specified when creating the managed cluster.",
"provisioningState" : "The current deployment or provisioning state, which only appears in the response.",
"type" : "AgentPoolType represents types of an agent pool.",
"maxCount" : "Maximum number of nodes for auto-scaling",
"tags" : "Agent pool tags to be persisted on the agent pool virtual machine scale set.",
"enableNodePublicIP" : "Enable public IP for nodes",
"scaleSetEvictionPolicy" : "ScaleSetEvictionPolicy to be used to specify eviction policy for Spot or low priority virtual machine scale set. Default to Delete.",
"nodeTaints" : [ "string" ],
"scaleSetPriority" : "ScaleSetPriority to be used to specify virtual machine scale set priority. Default to regular.",
"osType" : "OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux.",
"minCount" : "Minimum number of nodes for auto-scaling",
"vmSize" : "Size of agent VMs.",
"nodeLabels" : "Agent pool node labels to be persisted across all nodes in agent pool.",
"maxPods" : "Maximum number of pods that can run on a node."
}
}

create_update_managed_cluster

Creates or updates a managed cluster with the specified configuration for agents and Kubernetes version.

Parameters

api-version (required)

Client Api Version.

Type: string

resourceGroupName (required)

The name of the resource group.

Type: string

resourceName (required)

The name of the managed cluster resource.

Type: string

subscriptionId (required)

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Type: string

$body

Parameters supplied to the Create or Update a Managed Cluster operation.

Type: object

{
"name" : "Resource name",
"location" : "Resource location",
"id" : "Resource Id",
"type" : "Resource type",
"tags" : "Resource tags",
"identity" : {
"tenantId" : "The tenant id of the system assigned identity which is used by master components.",
"principalId" : "The principal id of the system assigned identity which is used by master components.",
"type" : "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."
},
"properties" : {
"agentPoolProfiles" : [ {
"osDiskSizeGB" : "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.",
"count" : "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.",
"spotMaxPrice" : "SpotMaxPrice to be used to specify the maximum price you are willing to pay in US Dollars. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand.",
"vnetSubnetID" : "VNet SubnetID specifies the VNet's subnet identifier.",
"availabilityZones" : [ "string" ],
"enableAutoScaling" : "Whether to enable auto-scaler",
"orchestratorVersion" : "Version of orchestrator specified when creating the managed cluster.",
"provisioningState" : "The current deployment or provisioning state, which only appears in the response.",
"type" : "AgentPoolType represents types of an agent pool.",
"maxCount" : "Maximum number of nodes for auto-scaling",
"tags" : "Agent pool tags to be persisted on the agent pool virtual machine scale set.",
"enableNodePublicIP" : "Enable public IP for nodes",
"scaleSetEvictionPolicy" : "ScaleSetEvictionPolicy to be used to specify eviction policy for Spot or low priority virtual machine scale set. Default to Delete.",
"nodeTaints" : [ "string" ],
"scaleSetPriority" : "ScaleSetPriority to be used to specify virtual machine scale set priority. Default to regular.",
"osType" : "OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux.",
"minCount" : "Minimum number of nodes for auto-scaling",
"vmSize" : "Size of agent VMs.",
"nodeLabels" : "Agent pool node labels to be persisted across all nodes in agent pool.",
"maxPods" : "Maximum number of pods that can run on a node.",
"name" : "Unique name of the agent pool profile in the context of the subscription and resource group."
} ],
"apiServerAccessProfile" : {
"enablePrivateCluster" : "Whether to create the cluster as a private cluster or not.",
"authorizedIPRanges" : [ "string" ]
},
"enableRBAC" : "Whether to enable Kubernetes Role-Based Access Control.",
"fqdn" : "FQDN for the master pool.",
"privateFQDN" : "FQDN of private cluster.",
"servicePrincipalProfile" : {
"clientId" : "The ID for the service principal.",
"secret" : "The secret password associated with the service principal in plain text."
},
"provisioningState" : "The current deployment or provisioning state, which only appears in the response.",
"nodeResourceGroup" : "Name of the resource group containing agent pool nodes.",
"autoScalerProfile" : {
"scale-down-delay-after-delete" : "string",
"scale-down-unready-time" : "string",
"max-graceful-termination-sec" : "string",
"scale-down-delay-after-add" : "string",
"scale-down-utilization-threshold" : "string",
"scale-down-unneeded-time" : "string",
"scan-interval" : "string",
"scale-down-delay-after-failure" : "string"
},
"windowsProfile" : {
"adminUsername" : "The administrator username to use for Windows VMs.",
"adminPassword" : "The administrator password to use for Windows VMs."
},
"identityProfile" : { },
"addonProfiles" : "Profile of managed cluster add-on.",
"dnsPrefix" : "DNS prefix specified when creating the managed cluster.",
"networkProfile" : {
"networkMode" : "Network mode used for building Kubernetes network.",
"loadBalancerSku" : "The load balancer sku for the managed cluster.",
"networkPlugin" : "Network plugin used for building Kubernetes network.",
"dockerBridgeCidr" : "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.",
"dnsServiceIP" : "An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr.",
"outboundType" : "The outbound (egress) routing method.",
"networkPolicy" : "Network policy used for building Kubernetes network.",
"podCidr" : "A CIDR notation IP range from which to assign pod IPs when kubenet is used.",
"serviceCidr" : "A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges.",
"loadBalancerProfile" : {
"managedOutboundIPs" : {
"count" : "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."
},
"allocatedOutboundPorts" : "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.",
"outboundIPPrefixes" : {
"publicIPPrefixes" : [ {
"id" : "The fully qualified Azure resource id."
} ]
},
"idleTimeoutInMinutes" : "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.",
"outboundIPs" : {
"publicIPs" : [ {
"id" : "The fully qualified Azure resource id."
} ]
},
"effectiveOutboundIPs" : [ {
"id" : "The fully qualified Azure resource id."
} ]
}
},
"maxAgentPools" : "The max number of agent pools for the managed cluster.",
"enablePodSecurityPolicy" : "(PREVIEW) Whether to enable Kubernetes Pod security policy.",
"aadProfile" : {
"serverAppSecret" : "The server AAD application secret.",
"tenantID" : "The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription.",
"serverAppID" : "The server AAD application ID.",
"clientAppID" : "The client AAD application ID."
},
"linuxProfile" : {
"adminUsername" : "The administrator username to use for Linux VMs.",
"ssh" : {
"publicKeys" : [ {
"keyData" : "Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers."
} ]
}
},
"diskEncryptionSetID" : "ResourceId of the disk encryption set to use for enabling encryption at rest.",
"kubernetesVersion" : "Version of Kubernetes specified when creating the managed cluster."
}
}

delete_agent_pool

Deletes the agent pool in the specified managed cluster.

Parameters

agentPoolName (required)

The name of the agent pool.

Type: string

api-version (required)

Client Api Version.

Type: string

resourceGroupName (required)

The name of the resource group.

Type: string

resourceName (required)

The name of the managed cluster resource.

Type: string

subscriptionId (required)

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Type: string

delete_managed_cluster

Deletes the managed cluster with a specified resource group and name.

Parameters

api-version (required)

Client Api Version.

Type: string

resourceGroupName (required)

The name of the resource group.

Type: string

resourceName (required)

The name of the managed cluster resource.

Type: string

subscriptionId (required)

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Type: string

get_access_profile_for_managed_cluster

Gets the accessProfile for the specified role name of the managed cluster with a specified resource group and name.

Parameters

api-version (required)

Client Api Version.

Type: string

resourceGroupName (required)

The name of the resource group.

Type: string

resourceName (required)

The name of the managed cluster resource.

Type: string

roleName (required)

The name of the role for managed cluster accessProfile resource.

Type: string

subscriptionId (required)

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Type: string

get_agent_pool

Gets the details of the agent pool by managed cluster and resource group.

Parameters

agentPoolName (required)

The name of the agent pool.

Type: string

api-version (required)

Client Api Version.

Type: string

resourceGroupName (required)

The name of the resource group.

Type: string

resourceName (required)

The name of the managed cluster resource.

Type: string

subscriptionId (required)

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Type: string

get_managed_cluster

Gets the details of the managed cluster with a specified resource group and name.

Parameters

api-version (required)

Client Api Version.

Type: string

resourceGroupName (required)

The name of the resource group.

Type: string

resourceName (required)

The name of the managed cluster resource.

Type: string

subscriptionId (required)

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Type: string

get_upgrade_profile

Gets the details of the upgrade profile for a managed cluster with a specified resource group and name.

Parameters

api-version (required)

Client Api Version.

Type: string

resourceGroupName (required)

The name of the resource group.

Type: string

resourceName (required)

The name of the managed cluster resource.

Type: string

subscriptionId (required)

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Type: string

get_upgrade_profile_for_agent_pool

Gets the details of the upgrade profile for an agent pool with a specified resource group and managed cluster name.

Parameters

agentPoolName (required)

The name of the agent pool.

Type: string

api-version (required)

Client Api Version.

Type: string

resourceGroupName (required)

The name of the resource group.

Type: string

resourceName (required)

The name of the managed cluster resource.

Type: string

subscriptionId (required)

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Type: string

list_admin_credentials_for_managed_cluster

Gets cluster admin credential of the managed cluster with a specified resource group and name.

Parameters

api-version (required)

Client Api Version.

Type: string

resourceGroupName (required)

The name of the resource group.

Type: string

resourceName (required)

The name of the managed cluster resource.

Type: string

subscriptionId (required)

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Type: string

list_agent_pools

Gets a list of agent pools in the specified managed cluster. The operation returns properties of each agent pool.

Parameters

api-version (required)

Client Api Version.

Type: string

resourceGroupName (required)

The name of the resource group.

Type: string

resourceName (required)

The name of the managed cluster resource.

Type: string

subscriptionId (required)

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Type: string

list_available_agent_pool_versions

Gets a list of supported versions for the specified agent pool.

Parameters

api-version (required)

Client Api Version.

Type: string

resourceGroupName (required)

The name of the resource group.

Type: string

resourceName (required)

The name of the managed cluster resource.

Type: string

subscriptionId (required)

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Type: string

list_cluster_monitoring_user_credentials

Gets cluster monitoring user credential of the managed cluster with a specified resource group and name.

Parameters

api-version (required)

Client Api Version.

Type: string

resourceGroupName (required)

The name of the resource group.

Type: string

resourceName (required)

The name of the managed cluster resource.

Type: string

subscriptionId (required)

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Type: string

list_clusters_by_resource_group

Lists managed clusters in the specified subscription and resource group. The operation returns properties of each managed cluster.

Parameters

api-version (required)

Client Api Version.

Type: string

resourceGroupName (required)

The name of the resource group.

Type: string

subscriptionId (required)

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Type: string

list_managed_clusters

Gets a list of managed clusters in the specified subscription. The operation returns properties of each managed cluster.

Parameters

api-version (required)

Client Api Version.

Type: string

subscriptionId (required)

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Type: string

list_operations

Gets a list of compute operations.

Parameters

api-version (required)

Client Api Version.

Type: string

list_user_credentials_for_managed_cluster

Gets cluster user credential of the managed cluster with a specified resource group and name.

Parameters

api-version (required)

Client Api Version.

Type: string

resourceGroupName (required)

The name of the resource group.

Type: string

resourceName (required)

The name of the managed cluster resource.

Type: string

subscriptionId (required)

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Type: string

reset_aad_profile

Update the AAD Profile for a managed cluster.

Parameters

api-version (required)

Client Api Version.

Type: string

resourceGroupName (required)

The name of the resource group.

Type: string

resourceName (required)

The name of the managed cluster resource.

Type: string

subscriptionId (required)

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Type: string

$body

Parameters supplied to the Reset AAD Profile operation for a Managed Cluster.

Type: object

{
"serverAppSecret" : "The server AAD application secret.",
"tenantID" : "The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription.",
"serverAppID" : "The server AAD application ID.",
"clientAppID" : "The client AAD application ID."
}

reset_service_principal_profile_for_cluster

Update the service principal Profile for a managed cluster.

Parameters

api-version (required)

Client Api Version.

Type: string

resourceGroupName (required)

The name of the resource group.

Type: string

resourceName (required)

The name of the managed cluster resource.

Type: string

subscriptionId (required)

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Type: string

$body

Parameters supplied to the Reset Service Principal Profile operation for a Managed Cluster.

Type: object

{
"clientId" : "The ID for the service principal.",
"secret" : "The secret password associated with the service principal in plain text."
}

rotate_certificates_for_managed_cluster

Rotate certificates of a managed cluster.

Parameters

api-version (required)

Client Api Version.

Type: string

resourceGroupName (required)

The name of the resource group.

Type: string

resourceName (required)

The name of the managed cluster resource.

Type: string

subscriptionId (required)

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Type: string

update_tags_for_managed_cluster

Updates a managed cluster with the specified tags.

Parameters

api-version (required)

Client Api Version.

Type: string

resourceGroupName (required)

The name of the resource group.

Type: string

resourceName (required)

The name of the managed cluster resource.

Type: string

subscriptionId (required)

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Type: string

$body

Parameters supplied to the Update Managed Cluster Tags operation.

Type: object

{
"tags" : "Resource tags."
}