{ "swagger": "2.0", "info": { "title": "ContainerServiceClient", "description": "The Container Service Client.", "version": "2017-07-01" }, "host": "management.azure.com", "schemes": [ "https" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "securityDefinitions": { "azure_auth": { "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", "description": "Azure Active Directory OAuth2 Flow", "scopes": { "user_impersonation": "impersonate your user account" } } }, "paths": { "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/containerServices": { "get": { "deprecated": true, "tags": [ "ContainerServices" ], "operationId": "ContainerServices_List", "summary": "Gets a list of container services in the specified subscription.", "description": "Gets a list of container services in the specified subscription. The operation returns properties of each container service including state, orchestrator, number of masters and agents, and FQDNs of masters and agents.", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ContainerServiceListResult" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, "x-ms-examples": { "List Container Services": { "$ref": "./examples/ContainerServicesList.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/containerServices/{containerServiceName}": { "put": { "deprecated": true, "tags": [ "ContainerService" ], "operationId": "ContainerServices_CreateOrUpdate", "summary": "Creates or updates a container service.", "description": "Creates or updates a container service with the specified configuration of orchestrator, masters, and agents.", "parameters": [ { "$ref": "#/parameters/ResourceGroupParameter" }, { "name": "containerServiceName", "in": "path", "required": true, "type": "string", "description": "The name of the container service in the specified subscription and resource group." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ContainerService" }, "description": "Parameters supplied to the Create or Update a Container Service operation." }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ContainerService" } }, "201": { "description": "Created", "schema": { "$ref": "#/definitions/ContainerService" } }, "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/ContainerService" } } }, "x-ms-long-running-operation": true, "x-ms-examples": { "Create/Update Container Service": { "$ref": "./examples/ContainerServiceCreate_Update.json" } } }, "get": { "deprecated": true, "tags": [ "ContainerService" ], "operationId": "ContainerServices_Get", "summary": "Gets the properties of the specified container service.", "description": "Gets the properties of the specified container service in the specified subscription and resource group. The operation returns the properties including state, orchestrator, number of masters and agents, and FQDNs of masters and agents. ", "parameters": [ { "$ref": "#/parameters/ResourceGroupParameter" }, { "name": "containerServiceName", "in": "path", "required": true, "type": "string", "description": "The name of the container service in the specified subscription and resource group." }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ContainerService" } } }, "x-ms-examples": { "Get Container Service": { "$ref": "./examples/ContainerServicesGet.json" } } }, "delete": { "deprecated": true, "tags": [ "ContainerService" ], "operationId": "ContainerServices_Delete", "summary": "Deletes the specified container service.", "description": "Deletes the specified container service in the specified subscription and resource group. The operation does not delete other resources created as part of creating a container service, including storage accounts, VMs, and availability sets. All the other resources created with the container service are part of the same resource group and can be deleted individually.", "parameters": [ { "$ref": "#/parameters/ResourceGroupParameter" }, { "name": "containerServiceName", "in": "path", "required": true, "type": "string", "description": "The name of the container service in the specified subscription and resource group." }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "202": { "description": "Accepted" }, "204": { "description": "Not found" } }, "x-ms-long-running-operation": true, "x-ms-examples": { "Delete Container Service": { "$ref": "./examples/ContainerServiceDelete.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/containerServices": { "get": { "deprecated": true, "tags": [ "ContainerServices" ], "operationId": "ContainerServices_ListByResourceGroup", "summary": "Gets a list of container services in the specified resource group.", "description": "Gets a list of container services in the specified subscription and resource group. The operation returns properties of each container service including state, orchestrator, number of masters and agents, and FQDNs of masters and agents.", "parameters": [ { "$ref": "#/parameters/ResourceGroupParameter" }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ContainerServiceListResult" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, "x-ms-examples": { "List Container Services by Resource Group": { "$ref": "./examples/ContainerServicesListByResourceGroup.json" } } } } }, "definitions": { "Resource": { "description": "The Resource model definition.", "properties": { "id": { "readOnly": true, "type": "string", "description": "Resource Id" }, "name": { "readOnly": true, "type": "string", "description": "Resource name" }, "type": { "readOnly": true, "type": "string", "description": "Resource type" }, "location": { "type": "string", "description": "Resource location", "x-ms-mutability": [ "read", "create" ] }, "tags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Resource tags" } }, "required": [ "location" ], "x-ms-azure-resource": true }, "ContainerServiceOSDisk": { "type": "integer", "format": "int32", "maximum": 1023, "minimum": 0, "description": "OS Disk Size in GB to be used to specify the disk size for every machine in this master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified." }, "ContainerServiceStorageProfile": { "type": "string", "x-ms-enum": { "name": "ContainerServiceStorageProfileTypes", "modelAsString": true }, "enum": [ "StorageAccount", "ManagedDisks" ], "description": "Storage profile specifies what kind of storage used. Choose from StorageAccount and ManagedDisks. Leave it empty, we will choose for you based on the orchestrator choice." }, "ContainerServiceVnetSubnetID": { "type": "string", "description": "VNet SubnetID specifies the VNet's subnet identifier." }, "ContainerServiceVMSize": { "type": "string", "x-ms-enum": { "name": "ContainerServiceVMSizeTypes", "modelAsString": true }, "description": "Size of agent VMs.", "enum": [ "Standard_A1", "Standard_A10", "Standard_A11", "Standard_A1_v2", "Standard_A2", "Standard_A2_v2", "Standard_A2m_v2", "Standard_A3", "Standard_A4", "Standard_A4_v2", "Standard_A4m_v2", "Standard_A5", "Standard_A6", "Standard_A7", "Standard_A8", "Standard_A8_v2", "Standard_A8m_v2", "Standard_A9", "Standard_B2ms", "Standard_B2s", "Standard_B4ms", "Standard_B8ms", "Standard_D1", "Standard_D11", "Standard_D11_v2", "Standard_D11_v2_Promo", "Standard_D12", "Standard_D12_v2", "Standard_D12_v2_Promo", "Standard_D13", "Standard_D13_v2", "Standard_D13_v2_Promo", "Standard_D14", "Standard_D14_v2", "Standard_D14_v2_Promo", "Standard_D15_v2", "Standard_D16_v3", "Standard_D16s_v3", "Standard_D1_v2", "Standard_D2", "Standard_D2_v2", "Standard_D2_v2_Promo", "Standard_D2_v3", "Standard_D2s_v3", "Standard_D3", "Standard_D32_v3", "Standard_D32s_v3", "Standard_D3_v2", "Standard_D3_v2_Promo", "Standard_D4", "Standard_D4_v2", "Standard_D4_v2_Promo", "Standard_D4_v3", "Standard_D4s_v3", "Standard_D5_v2", "Standard_D5_v2_Promo", "Standard_D64_v3", "Standard_D64s_v3", "Standard_D8_v3", "Standard_D8s_v3", "Standard_DS1", "Standard_DS11", "Standard_DS11_v2", "Standard_DS11_v2_Promo", "Standard_DS12", "Standard_DS12_v2", "Standard_DS12_v2_Promo", "Standard_DS13", "Standard_DS13-2_v2", "Standard_DS13-4_v2", "Standard_DS13_v2", "Standard_DS13_v2_Promo", "Standard_DS14", "Standard_DS14-4_v2", "Standard_DS14-8_v2", "Standard_DS14_v2", "Standard_DS14_v2_Promo", "Standard_DS15_v2", "Standard_DS1_v2", "Standard_DS2", "Standard_DS2_v2", "Standard_DS2_v2_Promo", "Standard_DS3", "Standard_DS3_v2", "Standard_DS3_v2_Promo", "Standard_DS4", "Standard_DS4_v2", "Standard_DS4_v2_Promo", "Standard_DS5_v2", "Standard_DS5_v2_Promo", "Standard_E16_v3", "Standard_E16s_v3", "Standard_E2_v3", "Standard_E2s_v3", "Standard_E32-16s_v3", "Standard_E32-8s_v3", "Standard_E32_v3", "Standard_E32s_v3", "Standard_E4_v3", "Standard_E4s_v3", "Standard_E64-16s_v3", "Standard_E64-32s_v3", "Standard_E64_v3", "Standard_E64s_v3", "Standard_E8_v3", "Standard_E8s_v3", "Standard_F1", "Standard_F16", "Standard_F16s", "Standard_F16s_v2", "Standard_F1s", "Standard_F2", "Standard_F2s", "Standard_F2s_v2", "Standard_F32s_v2", "Standard_F4", "Standard_F4s", "Standard_F4s_v2", "Standard_F64s_v2", "Standard_F72s_v2", "Standard_F8", "Standard_F8s", "Standard_F8s_v2", "Standard_G1", "Standard_G2", "Standard_G3", "Standard_G4", "Standard_G5", "Standard_GS1", "Standard_GS2", "Standard_GS3", "Standard_GS4", "Standard_GS4-4", "Standard_GS4-8", "Standard_GS5", "Standard_GS5-16", "Standard_GS5-8", "Standard_H16", "Standard_H16m", "Standard_H16mr", "Standard_H16r", "Standard_H8", "Standard_H8m", "Standard_L16s", "Standard_L32s", "Standard_L4s", "Standard_L8s", "Standard_M128-32ms", "Standard_M128-64ms", "Standard_M128ms", "Standard_M128s", "Standard_M64-16ms", "Standard_M64-32ms", "Standard_M64ms", "Standard_M64s", "Standard_NC12", "Standard_NC12s_v2", "Standard_NC12s_v3", "Standard_NC24", "Standard_NC24r", "Standard_NC24rs_v2", "Standard_NC24rs_v3", "Standard_NC24s_v2", "Standard_NC24s_v3", "Standard_NC6", "Standard_NC6s_v2", "Standard_NC6s_v3", "Standard_ND12s", "Standard_ND24rs", "Standard_ND24s", "Standard_ND6s", "Standard_NV12", "Standard_NV24", "Standard_NV6" ] }, "ContainerServiceCustomProfile": { "properties": { "orchestrator": { "type": "string", "description": "The name of the custom orchestrator to use." } }, "description": "Properties to configure a custom container service cluster.", "required": [ "orchestrator" ] }, "KeyVaultSecretRef": { "properties": { "vaultID": { "type": "string", "description": "Key vault identifier." }, "secretName": { "type": "string", "description": "The secret name." }, "version": { "type": "string", "description": "The secret version." } }, "description": "Reference to a secret stored in Azure Key Vault.", "required": [ "vaultID", "secretName" ] }, "ContainerServiceServicePrincipalProfile": { "properties": { "clientId": { "type": "string", "description": "The ID for the service principal." }, "secret": { "type": "string", "description": "The secret password associated with the service principal in plain text." }, "keyVaultSecretRef": { "$ref": "#/definitions/KeyVaultSecretRef", "description": "Reference to a secret stored in Azure Key Vault." } }, "description": "Information about a service principal identity for the cluster to use for manipulating Azure APIs. Either secret or keyVaultSecretRef must be specified.", "required": [ "clientId" ] }, "ContainerServiceOrchestratorProfile": { "properties": { "orchestratorType": { "type": "string", "enum": [ "Kubernetes", "Swarm", "DCOS", "DockerCE", "Custom" ], "x-ms-enum": { "name": "ContainerServiceOrchestratorTypes", "modelAsString": true }, "description": "The orchestrator to use to manage container service cluster resources. Valid values are Kubernetes, Swarm, DCOS, DockerCE and Custom." }, "orchestratorVersion": { "type": "string", "description": "The version of the orchestrator to use. You can specify the major.minor.patch part of the actual version.For example, you can specify version as \"1.6.11\"." } }, "description": "Profile for the container service orchestrator.", "required": [ "orchestratorType" ] }, "ContainerServiceMasterProfile": { "properties": { "count": { "type": "integer", "format": "int32", "enum": [ 1, 3, 5 ], "x-ms-enum": { "name": "Count", "modelAsString": false }, "description": "Number of masters (VMs) in the container service cluster. Allowed values are 1, 3, and 5. The default value is 1.", "default": 1 }, "dnsPrefix": { "type": "string", "description": "DNS prefix to be used to create the FQDN for the master pool." }, "vmSize": { "$ref": "#/definitions/ContainerServiceVMSize", "description": "Size of agent VMs." }, "osDiskSizeGB": { "$ref": "#/definitions/ContainerServiceOSDisk", "description": "OS Disk Size in GB to be used to specify the disk size for every machine in this master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified." }, "vnetSubnetID": { "$ref": "#/definitions/ContainerServiceVnetSubnetID", "description": "VNet SubnetID specifies the VNet's subnet identifier." }, "firstConsecutiveStaticIP": { "type": "string", "description": "FirstConsecutiveStaticIP used to specify the first static ip of masters.", "default": "10.240.255.5" }, "storageProfile": { "$ref": "#/definitions/ContainerServiceStorageProfile", "description": "Storage profile specifies what kind of storage used. Choose from StorageAccount and ManagedDisks. Leave it empty, we will choose for you based on the orchestrator choice." }, "fqdn": { "readOnly": true, "type": "string", "description": "FQDN for the master pool." } }, "required": [ "dnsPrefix", "vmSize" ], "description": "Profile for the container service master." }, "ContainerServiceAgentPoolProfile": { "properties": { "name": { "type": "string", "description": "Unique name of the agent pool profile in the context of the subscription and resource group." }, "count": { "type": "integer", "format": "int32", "maximum": 100, "minimum": 1, "description": "Number of agents (VMs) to host docker containers. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. ", "default": 1 }, "vmSize": { "$ref": "#/definitions/ContainerServiceVMSize", "description": "Size of agent VMs." }, "osDiskSizeGB": { "$ref": "#/definitions/ContainerServiceOSDisk", "description": "OS Disk Size in GB to be used to specify the disk size for every machine in this master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified." }, "dnsPrefix": { "type": "string", "description": "DNS prefix to be used to create the FQDN for the agent pool." }, "fqdn": { "readOnly": true, "type": "string", "description": "FQDN for the agent pool." }, "ports": { "type": "array", "items": { "type": "integer", "minimum": 1, "maximum": 65535 }, "description": "Ports number array used to expose on this agent pool. The default opened ports are different based on your choice of orchestrator." }, "storageProfile": { "$ref": "#/definitions/ContainerServiceStorageProfile", "description": "Storage profile specifies what kind of storage used. Choose from StorageAccount and ManagedDisks. Leave it empty, we will choose for you based on the orchestrator choice." }, "vnetSubnetID": { "$ref": "#/definitions/ContainerServiceVnetSubnetID", "description": "VNet SubnetID specifies the VNet's subnet identifier." }, "osType": { "$ref": "#/definitions/OSType", "description": "OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux." } }, "required": [ "name", "vmSize" ], "description": "Profile for the container service agent pool." }, "ContainerServiceWindowsProfile": { "properties": { "adminUsername": { "type": "string", "description": "The administrator username to use for Windows VMs.", "pattern": "^[a-zA-Z0-9]+([._]?[a-zA-Z0-9]+)*$" }, "adminPassword": { "type": "string", "description": "The administrator password to use for Windows VMs.", "pattern": "^(?=.*[a-z])(?=.*[A-Z])(?=.*[!@#$%\\^&\\*\\(\\)])[a-zA-Z\\d!@#$%\\^&\\*\\(\\)]{12,123}$" } }, "required": [ "adminUsername", "adminPassword" ], "description": "Profile for Windows VMs in the container service cluster." }, "ContainerServiceLinuxProfile": { "properties": { "adminUsername": { "type": "string", "description": "The administrator username to use for Linux VMs.", "pattern": "^[A-Za-z][-A-Za-z0-9_]*$" }, "ssh": { "$ref": "#/definitions/ContainerServiceSshConfiguration", "description": "SSH configuration for Linux-based VMs running on Azure." } }, "required": [ "adminUsername", "ssh" ], "description": "Profile for Linux VMs in the container service cluster." }, "ContainerServiceSshConfiguration": { "properties": { "publicKeys": { "type": "array", "items": { "$ref": "#/definitions/ContainerServiceSshPublicKey" }, "description": "The list of SSH public keys used to authenticate with Linux-based VMs. Only expect one key specified." } }, "description": "SSH configuration for Linux-based VMs running on Azure.", "required": [ "publicKeys" ] }, "ContainerServiceSshPublicKey": { "properties": { "keyData": { "type": "string", "description": "Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers." } }, "required": [ "keyData" ], "description": "Contains information about SSH certificate public key data." }, "ContainerServiceDiagnosticsProfile": { "properties": { "vmDiagnostics": { "$ref": "#/definitions/ContainerServiceVMDiagnostics", "description": "Profile for diagnostics on the container service VMs." } }, "description": "Profile for diagnostics on the container service cluster.", "required": [ "vmDiagnostics" ] }, "ContainerServiceVMDiagnostics": { "properties": { "enabled": { "type": "boolean", "description": "Whether the VM diagnostic agent is provisioned on the VM." }, "storageUri": { "readOnly": true, "type": "string", "description": "The URI of the storage account where diagnostics are stored." } }, "description": "Profile for diagnostics on the container service VMs.", "required": [ "enabled" ] }, "ContainerService": { "allOf": [ { "$ref": "#/definitions/Resource" }, { "properties": { "properties": { "description": "Properties of the container service.", "$ref": "#/definitions/ContainerServiceProperties", "x-ms-client-flatten": true } } } ], "description": "Container service." }, "ContainerServiceListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/ContainerService" }, "description": "The list of container services." }, "nextLink": { "type": "string", "description": "The URL to get the next set of container service results.", "readOnly": true } }, "description": "The response from the List Container Services operation." }, "ContainerServiceProperties": { "properties": { "provisioningState": { "readOnly": true, "type": "string", "description": "The current deployment or provisioning state, which only appears in the response." }, "orchestratorProfile": { "$ref": "#/definitions/ContainerServiceOrchestratorProfile", "description": "Profile for the container service orchestrator." }, "customProfile": { "$ref": "#/definitions/ContainerServiceCustomProfile", "description": "Properties to configure a custom container service cluster." }, "servicePrincipalProfile": { "$ref": "#/definitions/ContainerServiceServicePrincipalProfile", "description": "Information about a service principal identity for the cluster to use for manipulating Azure APIs. Exact one of secret or keyVaultSecretRef need to be specified." }, "masterProfile": { "$ref": "#/definitions/ContainerServiceMasterProfile", "description": "Profile for the container service master." }, "agentPoolProfiles": { "type": "array", "items": { "$ref": "#/definitions/ContainerServiceAgentPoolProfile" }, "description": "Properties of the agent pool." }, "windowsProfile": { "$ref": "#/definitions/ContainerServiceWindowsProfile", "description": "Profile for Windows VMs in the container service cluster." }, "linuxProfile": { "$ref": "#/definitions/ContainerServiceLinuxProfile", "description": "Profile for Linux VMs in the container service cluster." }, "diagnosticsProfile": { "$ref": "#/definitions/ContainerServiceDiagnosticsProfile", "description": "Profile for diagnostics in the container service cluster." } }, "required": [ "orchestratorProfile", "masterProfile", "linuxProfile" ], "description": "Properties of the container service." }, "OSType": { "type": "string", "default": "Linux", "enum": [ "Linux", "Windows" ], "x-ms-enum": { "name": "OSType", "modelAsString": true }, "description": "OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux." } }, "parameters": { "SubscriptionIdParameter": { "name": "subscriptionId", "in": "path", "required": true, "type": "string", "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.", "x-ms-parameter-location": "client" }, "ApiVersionParameter": { "name": "api-version", "in": "query", "required": true, "type": "string", "description": "Client Api Version.", "x-ms-parameter-location": "client" }, "ResourceGroupParameter": { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group.", "x-ms-parameter-location": "method" } } }