Microsoft.ContainerService containerServices template reference

Template format

To create a Microsoft.ContainerService/containerServices resource, add the following JSON to the resources section of your template.

{
  "name": "string",
  "type": "Microsoft.ContainerService/containerServices",
  "apiVersion": "2017-01-31",
  "location": "string",
  "tags": {},
  "properties": {
    "orchestratorProfile": {
      "orchestratorType": "string"
    },
    "customProfile": {
      "orchestrator": "string"
    },
    "servicePrincipalProfile": {
      "clientId": "string",
      "secret": "string"
    },
    "masterProfile": {
      "count": "integer",
      "dnsPrefix": "string"
    },
    "agentPoolProfiles": [
      {
        "name": "string",
        "count": "integer",
        "vmSize": "string",
        "dnsPrefix": "string"
      }
    ],
    "windowsProfile": {
      "adminUsername": "string",
      "adminPassword": "string"
    },
    "linuxProfile": {
      "adminUsername": "string",
      "ssh": {
        "publicKeys": [
          {
            "keyData": "string"
          }
        ]
      }
    },
    "diagnosticsProfile": {
      "vmDiagnostics": {
        "enabled": boolean
      }
    }
  }
}

Property values

The following tables describe the values you need to set in the schema.

Microsoft.ContainerService/containerServices object

Name Type Required Value
name string Yes
type enum Yes Microsoft.ContainerService/containerServices
apiVersion enum Yes 2017-01-31
location string Yes Resource location
tags object No Resource tags
properties object Yes ContainerServiceProperties object

ContainerServiceProperties object

Name Type Required Value
orchestratorProfile object No Properties of the orchestrator. - ContainerServiceOrchestratorProfile object
customProfile object No Properties for custom clusters. - ContainerServiceCustomProfile object
servicePrincipalProfile object No Properties for cluster service principals. - ContainerServiceServicePrincipalProfile object
masterProfile object Yes Properties of master agents. - ContainerServiceMasterProfile object
agentPoolProfiles array Yes Properties of the agent pool. - ContainerServiceAgentPoolProfile object
windowsProfile object No Properties of Windows VMs. - ContainerServiceWindowsProfile object
linuxProfile object Yes Properties of Linux VMs. - ContainerServiceLinuxProfile object
diagnosticsProfile object No Properties of the diagnostic agent. - ContainerServiceDiagnosticsProfile object

ContainerServiceOrchestratorProfile object

Name Type Required Value
orchestratorType enum Yes The orchestrator to use to manage container service cluster resources. Valid values are Swarm, DCOS, and Custom. - Swarm, DCOS, Custom, Kubernetes

ContainerServiceCustomProfile object

Name Type Required Value
orchestrator string Yes The name of the custom orchestrator to use.

ContainerServiceServicePrincipalProfile object

Name Type Required Value
clientId string Yes The ID for the service principal.
secret string Yes The secret password associated with the service principal.

ContainerServiceMasterProfile object

Name Type Required Value
count integer No Number of masters (VMs) in the container service cluster. Allowed values are 1, 3, and 5. The default value is 1.
dnsPrefix string Yes DNS prefix to be used to create the FQDN for master.

ContainerServiceAgentPoolProfile object

Name Type Required Value
name string Yes Unique name of the agent pool profile in the context of the subscription and resource group.
count integer Yes 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.
vmSize enum Yes Size of agent VMs. - Standard_A0, Standard_A1, Standard_A2, Standard_A3, Standard_A4, Standard_A5, Standard_A6, Standard_A7, Standard_A8, Standard_A9, Standard_A10, Standard_A11, Standard_D1, Standard_D2, Standard_D3, Standard_D4, Standard_D11, Standard_D12, Standard_D13, Standard_D14, Standard_D1_v2, Standard_D2_v2, Standard_D3_v2, Standard_D4_v2, Standard_D5_v2, Standard_D11_v2, Standard_D12_v2, Standard_D13_v2, Standard_D14_v2, Standard_G1, Standard_G2, Standard_G3, Standard_G4, Standard_G5, Standard_DS1, Standard_DS2, Standard_DS3, Standard_DS4, Standard_DS11, Standard_DS12, Standard_DS13, Standard_DS14, Standard_GS1, Standard_GS2, Standard_GS3, Standard_GS4, Standard_GS5
dnsPrefix string Yes DNS prefix to be used to create the FQDN for the agent pool.

ContainerServiceWindowsProfile object

Name Type Required Value
adminUsername string Yes The administrator username to use for Windows VMs.
adminPassword string Yes The administrator password to use for Windows VMs.

ContainerServiceLinuxProfile object

Name Type Required Value
adminUsername string Yes The administrator username to use for Linux VMs.
ssh object Yes The ssh key configuration for Linux VMs. - ContainerServiceSshConfiguration object

ContainerServiceDiagnosticsProfile object

Name Type Required Value
vmDiagnostics object Yes Profile for the container service VM diagnostic agent. - ContainerServiceVMDiagnostics object

ContainerServiceSshConfiguration object

Name Type Required Value
publicKeys array Yes the list of SSH public keys used to authenticate with Linux-based VMs. - ContainerServiceSshPublicKey object

ContainerServiceVMDiagnostics object

Name Type Required Value
enabled boolean Yes Whether the VM diagnostic agent is provisioned on the VM.

ContainerServiceSshPublicKey object

Name Type Required Value
keyData string Yes Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers.

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Azure Container Service - DC/OS (DEPRECATED)

Deploy to Azure
Deploy an Azure Container Service instance for the hosting and management of Docker Containers. Azure Container Service optimizes the configuration of popular open source tools and technologies specifically for Azure. You get an open solution (either DCOS, powered by Apache Mesos, Kubernetes, or Docker Swarm) that offers portability for both your containers and your application configuration. You select the size, the number of hosts, and choice of orchestrator tools, and Container Service handles everything else.
We work closely with the open source community and, by exposing the standard API endpoints for our orchestration engine, we ensure that the most popular open source tools are not only compatible with Azure Container Service, but in most cases will work out of the box. This includes current tools such as visualizers, monitoring, continuous integration, and command line tools, as well as future tools and features as they become available.
Azure Container Service - Kubernetes (DEPRECATED)

Deploy to Azure
Deploy an Azure Container Service instance for the hosting and management of Docker Containers. Azure Container Service optimizes the configuration of popular open source tools and technologies specifically for Azure. You get an open solution (either DCOS, powered by Apache Mesos, Kubernetes, or Docker Swarm) that offers portability for both your containers and your application configuration. You select the size, the number of hosts, and choice of orchestrator tools, and Container Service handles everything else.
We work closely with the open source community and, by exposing the standard API endpoints for our orchestration engine, we ensure that the most popular open source tools are not only compatible with Azure Container Service, but in most cases will work out of the box. This includes current tools such as visualizers, monitoring, continuous integration, and command line tools, as well as future tools and features as they become available.
Azure Container Service - Swarm (DEPRECATED)

Deploy to Azure
Deploy an Azure Container Service instance for the hosting and management of Docker Containers. Azure Container Service optimizes the configuration of popular open source tools and technologies specifically for Azure. You get an open solution (either DCOS, powered by Apache Mesos, Kubernetes, or Docker Swarm) that offers portability for both your containers and your application configuration. You select the size, the number of hosts, and choice of orchestrator tools, and Container Service handles everything else.
We work closely with the open source community and, by exposing the standard API endpoints for our orchestration engine, we ensure that the most popular open source tools are not only compatible with Azure Container Service, but in most cases will work out of the box. This includes current tools such as visualizers, monitoring, continuous integration, and command line tools, as well as future tools and features as they become available.
Azure Spinnaker to Kubernetes

Deploy to Azure
[DEPRECATED] Please use the 'Azure Spinnaker' or 'Continuous Deployment to Kubernetes' template instead.
Continuous Deployment to Kubernetes

Deploy to Azure
This template allows you to deploy and configure a DevOps pipeline from an Azure Container Registry to a Kubernetes cluster. It deploys an instance of Jenkins on a Linux Ubuntu 14.04 LTS VM and an instance of Spinnaker on the same Kubernetes cluster that your pipeline will target. The Jenkins instance will include a basic pipeline that checks out a user-provided git repository, builds the Docker container based on the Dockerfile at the root of the repo, and pushes the image to the provisioned Azure Container Registry. The Spinnaker instance will include a basic pipeline that is triggered by any new tag in the registry and deploys the image to the provisioned Kubernetes cluster.