az acs

Manage Azure Container Services.

Commands

az acs browse Opens a browser to the web interface for the cluster orchestrator.
az acs create Create a container service.
az acs dcos Manage a DC/OS orchestrated Azure Container Service.
az acs dcos browse Creates an SSH tunnel to the Azure container service, and opens the Mesosphere DC/OS dashboard in the browser.
az acs dcos install-cli Downloads the dcos command line from Mesosphere.
az acs delete Delete a container service.
az acs install-cli Download and install the DC/OS and Kubernetes command line for a cluster.
az acs kubernetes Manage a Kubernetes orchestrated Azure Container Service.
az acs kubernetes browse Launch a proxy and browse the Kubernetes web UI.
az acs kubernetes get-credentials Download and install credentials to access a cluster.
az acs kubernetes install-cli Install kubectl, a command-line interface for Kubernetes clusters.
az acs list List container services.
az acs list-locations
az acs scale Change the private agent count of a container service.
az acs show Get the details for a container service.
az acs wait

az acs browse

Opens a browser to the web interface for the cluster orchestrator.

az acs browse --name
--resource-group
[--disable-browser]
[--ssh-key-file]

Required Parameters

--name -n

ACS cluster name. You can configure the default using az configure --defaults acs=<name>.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--disable-browser

Do not open browser after opening a proxy to the cluster web user interface.

--ssh-key-file

If set a path to an SSH key to use, only applies to DCOS.

az acs create

Create a container service.

az acs create --name
--resource-group
[--admin-password]
[--admin-username]
[--agent-count]
[--agent-osdisk-size]
[--agent-ports]
[--agent-profiles]
[--agent-storage-profile {ManagedDisks, StorageAccount}]
[--agent-vm-size]
[--agent-vnet-subnet-id]
[--api-version]
[--client-secret]
[--dns-prefix]
[--generate-ssh-keys]
[--location]
[--master-count]
[--master-first-consecutive-static-ip]
[--master-osdisk-size]
[--master-profile]
[--master-storage-profile {ManagedDisks, StorageAccount}]
[--master-vm-size]
[--master-vnet-subnet-id]
[--no-wait]
[--orchestrator-type {Custom, DCOS, DockerCE, Kubernetes, Swarm}]
[--orchestrator-version]
[--service-principal]
[--ssh-key-value]
[--tags]
[--validate]
[--windows]

Examples

Create a Kubernetes container service and generate SSH keys to connect to it.

az acs create -g MyResourceGroup -n MyContainerService --orchestrator-type kubernetes --generate-ssh-keys

Required Parameters

--name -n

ACS cluster name. You can configure the default using az configure --defaults acs=<name>.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--admin-password

The adminstration password for Windows nodes. Only available if --windows=true.

--admin-username

User name for the Linux Virtual Machines.

default value: azureuser
--agent-count

Set default number of agents for the agent pools. Note, for DC/OS clusters you will also get 1 or 2 public agents in addition to these selected masters.

default value: 3
--agent-osdisk-size

Feature in preview, only in ukwest, uksouth, westcentralus, westus2, canadaeast, canadacentral, westindia, southindia, centralindia. Set the default disk size for agent pools vms. Unit in GB. Default: corresponding vmsize disk size.

--agent-ports

Feature in preview, only in ukwest, uksouth, westcentralus, westus2, canadaeast, canadacentral, westindia, southindia, centralindia. Set the default ports exposed on the agent pools. Only usable for non-Kubernetes. Default: 8080,4000,80.

--agent-profiles -a

Feature in preview, only in ukwest, uksouth, westcentralus, westus2, canadaeast, canadacentral, westindia, southindia, centralindia. The file or dictionary representation of the agent profiles. Note it will override any agent settings once set.

--agent-storage-profile

Feature in preview, only in ukwest, uksouth, westcentralus, westus2, canadaeast, canadacentral, westindia, southindia, centralindia. Set default storage profile for agent pools. Default: varies based on Orchestrator.

accepted values: ManagedDisks, StorageAccount
--agent-vm-size

Set the default size for agent pools vms.

default value: Standard_D2_v2
--agent-vnet-subnet-id

Feature in preview, only in ukwest, uksouth, westcentralus, westus2, canadaeast, canadacentral, westindia, southindia, centralindia. Set the default custom vnet subnet id for agent pools. Note agent need to used the same vnet if master set. Default: "".

--api-version

Feature in preview, only in ukwest, uksouth, westcentralus, westus2, canadaeast, canadacentral, westindia, southindia, centralindia. Use API version of ACS to perform az acs operations. Available options: 2017-01-31, 2017-07-01. Default: the latest version for the location.

--client-secret

Client secret to use with the service principal for making calls to Azure APIs.

--dns-prefix -d

Default use the format of --, will trim the length and replace sensitive characters if needed.

--generate-ssh-keys

Generate SSH public and private key files if missing.

--location -l

Location. You can configure the default location using az configure --defaults location=<location>.

--master-count

The number of masters for the cluster.

default value: 1
--master-first-consecutive-static-ip

Feature in preview, only in ukwest, uksouth, westcentralus, westus2, canadaeast, canadacentral, westindia, southindia, centralindia. The first consecutive ip used to specify static ip block.

default value: 10.240.255.5
--master-osdisk-size

Feature in preview, only in ukwest, uksouth, westcentralus, westus2, canadaeast, canadacentral, westindia, southindia, centralindia. The disk size for master pool vms. Unit in GB. Default: corresponding vmsize disk size.

--master-profile -m

Feature in preview, only in ukwest, uksouth, westcentralus, westus2, canadaeast, canadacentral, westindia, southindia, centralindia. The file or dictionary representation of the master profile. Note it will override any master settings once set.

--master-storage-profile

Feature in preview, only in ukwest, uksouth, westcentralus, westus2, canadaeast, canadacentral, westindia, southindia, centralindia. Default: varies based on Orchestrator.

accepted values: ManagedDisks, StorageAccount
--master-vm-size

Feature in preview, only in ukwest, uksouth, westcentralus, westus2, canadaeast, canadacentral, westindia, southindia, centralindia.

default value: Standard_D2_v2
--master-vnet-subnet-id

Feature in preview, only in ukwest, uksouth, westcentralus, westus2, canadaeast, canadacentral, westindia, southindia, centralindia. The custom vnet subnet id. Note agent need to used the same vnet if master set. Default: "".

--no-wait

Do not wait for the long running operation to finish.

--orchestrator-type -t

DockerCE - Feature in preview, only in ukwest, uksouth, westcentralus, westus2, canadaeast, canadacentral, westindia, southindia, centralindia.

accepted values: Custom, DCOS, DockerCE, Kubernetes, Swarm
default value: DCOS
--orchestrator-version

Feature in preview, only in ukwest, uksouth, westcentralus, westus2, canadaeast, canadacentral, westindia, southindia, centralindia. Use Orchestrator Version to specify the semantic version for your choice of orchestrator.

--service-principal

Service principal for making calls into Azure APIs. If not set, auto generate a new service principal of Contributor role, and save it locally for reusing.

--ssh-key-value

SSH key file value or key file path.

default value: ~.sshid_rsa.pub
--tags

Space separated tags in 'key[=value]' format. Use "" to clear existing tags.

--validate

Generate and validate the ARM template without creating any resources.

--windows

If true, set the default osType of agent pools to be Windows.

az acs delete

Delete a container service.

az acs delete --name
--resource-group

Required Parameters

--name -n

The name of the container service.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

az acs install-cli

Download and install the DC/OS and Kubernetes command line for a cluster.

az acs install-cli --name
--resource-group
[--client-version]
[--install-location]

Required Parameters

--name -n

ACS cluster name. You can configure the default using az configure --defaults acs=<name>.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--client-version
--install-location

az acs list

List container services.

az acs list [--resource-group]

Optional Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

az acs list-locations

az acs list-locations

az acs scale

Change the private agent count of a container service.

az acs scale --name
--new-agent-count
--resource-group

Required Parameters

--name -n

The name of the container service.

--new-agent-count

The number of agents for the cluster.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

az acs show

Get the details for a container service.

az acs show --name
--resource-group

Required Parameters

--name -n

The name of the container service.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

az acs wait

az acs wait --name
--resource-group
[--created]
[--custom]
[--deleted]
[--exists]
[--interval]
[--timeout]
[--updated]

Required Parameters

--name -n

The name of the container service.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--created

Wait till created with 'provisioningState' at 'Succeeded'.

--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wait till deleted.

--exists

Wait till the resource exists.

--interval

Polling interval in seconds.

default value: 30
--timeout

Maximum wait in seconds.

default value: 3600
--updated

Wait till updated with provisioningState at 'Succeeded'.