az acs
Manage Azure Container Services.
ACS will be retired as a standalone service on January 31, 2020.
If you use the Kubernetes orchestrator, please migrate to AKS by January 31, 2020.
Commands
az acs browse |
Show the dashboard for a service container's orchestrator in a web browser. |
az acs create |
Create a new container service. |
az acs dcos |
Commands to 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 |
Download and install the DC/OS command-line tool for a cluster. |
az acs delete |
Delete a container service. |
az acs kubernetes |
Commands to 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. This command requires the same private-key used to create the cluster. |
az acs kubernetes install-cli |
Download and install the Kubernetes command-line tool for a cluster. |
az acs list |
List container services. |
az acs list-locations |
List locations where Azure Container Service is in preview and in production. |
az acs scale |
Change the private agent count of a container service. |
az acs show |
Show the details for a container service. |
az acs wait |
Wait for a container service to reach a desired state. |
az acs browse
Show the dashboard for a service container's orchestrator in a web browser.
az acs browse --name
--resource-group
[--disable-browser]
[--ssh-key-file]
[--subscription]
Examples
Show the dashboard for a service container's orchestrator in a web browser. (autogenerated)
az acs browse --name MyContainerService --resource-group MyResourceGroup
Required Parameters
Name of the container service. You can configure the default using az configure --defaults acs=<name>
.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
Do not open browser after opening a proxy to the cluster web user interface.
If set a path to an SSH key to use, only applies to DCOS.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az acs create
Create a new 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]
[--subscription]
[--tags]
[--validate]
[--windows]
Examples
Create a DCOS cluster with an existing SSH key.
az acs create --orchestrator-type DCOS -g MyResourceGroup -n MyContainerService \
--ssh-key-value /path/to/publickey
Create a DCOS cluster with two agent pools.
az acs create -g MyResourceGroup -n MyContainerService --agent-profiles '[ \
{ \
"name": "agentpool1" \
}, \
{ \
"name": "agentpool2" \
}]'
Create a DCOS cluster where the second agent pool has a vmSize specified.
az acs create -g MyResourceGroup -n MyContainerService --agent-profiles '[ \
{ \
"name": "agentpool1" \
}, \
{ \
"name": "agentpool2", \
"vmSize": "Standard_D2" \
}]'
Create a DCOS cluster with agent-profiles specified from a file.
az acs create -g MyResourceGroup -n MyContainerService --agent-profiles MyAgentProfiles.json
Required Parameters
Name of the container service. You can configure the default using az configure --defaults acs=<name>
.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
The adminstration password for Windows nodes. Only available if --windows=true.
User name for the Linux Virtual Machines.
Set the default number of agents for the agent pools.
Feature in preview, only in canadacentral, canadaeast, centralindia, koreasouth, koreacentral, southindia, uksouth, ukwest, westcentralus, westindia, westus2. Set the default disk size for agent pools vms. Unit in GB. Default: corresponding vmsize disk size.
Feature in preview, only in canadacentral, canadaeast, centralindia, koreasouth, koreacentral, southindia, uksouth, ukwest, westcentralus, westindia, westus2. Set the default ports exposed on the agent pools. Only usable for non-Kubernetes. Default: 8080,4000,80.
Feature in preview, only in canadacentral, canadaeast, centralindia, koreasouth, koreacentral, southindia, uksouth, ukwest, westcentralus, westindia, westus2. The file or dictionary representation of the agent profiles. Note it will override any agent settings once set.
Feature in preview, only in canadacentral, canadaeast, centralindia, koreasouth, koreacentral, southindia, uksouth, ukwest, westcentralus, westindia, westus2. Set default storage profile for agent pools. Default: varies based on Orchestrator.
Set the default size for agent pools vms.
Feature in preview, only in canadacentral, canadaeast, centralindia, koreasouth, koreacentral, southindia, uksouth, ukwest, westcentralus, westindia, westus2. Set the default custom vnet subnet id for agent pools. Note agent need to used the same vnet if master set. Default: "".
Feature in preview, only in canadacentral, canadaeast, centralindia, koreasouth, koreacentral, southindia, uksouth, ukwest, westcentralus, westindia, westus2. 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.
Secret associated with the service principal. This argument is required if --service-principal
is specified.
Sets the Domain name prefix for the cluster. The concatenation of the domain name and the regionalized DNS zone make up the fully qualified domain name associated with the public IP address.
Generate SSH public and private key files if missing.
Location. Values from: az account list-locations
. You can configure the default location using az configure --defaults location=<location>
.
The number of masters for the cluster.
Feature in preview, only in canadacentral, canadaeast, centralindia, koreasouth, koreacentral, southindia, uksouth, ukwest, westcentralus, westindia, westus2. The first consecutive ip used to specify static ip block.
Feature in preview, only in canadacentral, canadaeast, centralindia, koreasouth, koreacentral, southindia, uksouth, ukwest, westcentralus, westindia, westus2. The disk size for master pool vms. Unit in GB. Default: corresponding vmsize disk size.
Feature in preview, only in canadacentral, canadaeast, centralindia, koreasouth, koreacentral, southindia, uksouth, ukwest, westcentralus, westindia, westus2. The file or dictionary representation of the master profile. Note it will override any master settings once set.
Feature in preview, only in canadacentral, canadaeast, centralindia, koreasouth, koreacentral, southindia, uksouth, ukwest, westcentralus, westindia, westus2. Default: varies based on Orchestrator.
Feature in preview, only in canadacentral, canadaeast, centralindia, koreasouth, koreacentral, southindia, uksouth, ukwest, westcentralus, westindia, westus2.
Feature in preview, only in canadacentral, canadaeast, centralindia, koreasouth, koreacentral, southindia, uksouth, ukwest, westcentralus, westindia, westus2. The custom vnet subnet id. Note agent need to used the same vnet if master set. Default: "".
Do not wait for the long-running operation to finish.
The type of orchestrator used to manage the applications on the cluster.
Feature in preview, only in canadacentral, canadaeast, centralindia, koreasouth, koreacentral, southindia, uksouth, ukwest, westcentralus, westindia, westus2. Use Orchestrator Version to specify the semantic version for your choice of orchestrator.
Service principal used for authentication to Azure APIs.
Configure all linux machines with the SSH RSA public key string. Your key should include three parts, for example 'ssh-rsa AAAAB...snip...UcyupgH azureuser@linuxvm.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
Generate and validate the ARM template without creating any resources.
If true, set the default osType of agent pools to be Windows.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az acs delete
Delete a container service.
az acs delete --name
--resource-group
[--subscription]
[--yes]
Examples
Delete a container service. (autogenerated)
az acs delete --name MyContainerService --resource-group MyResourceGroup
Required Parameters
Name of the container service. You can configure the default using az configure --defaults acs=<name>
.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Do not prompt for confirmation.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az acs list
List container services.
az acs list [--query-examples]
[--resource-group]
[--subscription]
Optional Parameters
Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az acs list-locations
List locations where Azure Container Service is in preview and in production.
az acs list-locations [--subscription]
Optional Parameters
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az acs scale
Change the private agent count of a container service.
az acs scale --name
--new-agent-count
--resource-group
[--subscription]
Examples
Change the private agent count of a container service. (autogenerated)
az acs scale --name MyContainerService --new-agent-count 10 --resource-group MyResourceGroup
Required Parameters
Name of the container service. You can configure the default using az configure --defaults acs=<name>
.
The number of agents for the container service.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az acs show
Show the details for a container service.
az acs show --name
--resource-group
[--query-examples]
[--subscription]
Examples
Show the details for a container service. (autogenerated)
az acs show --name MyContainerService --resource-group MyResourceGroup
Required Parameters
Name of the container service. You can configure the default using az configure --defaults acs=<name>
.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az acs wait
Wait for a container service to reach a desired state.
If an operation on a container service was interrupted or was started with --no-wait
, use this command to wait for it to complete.
az acs wait --name
--resource-group
[--created]
[--custom]
[--deleted]
[--exists]
[--interval]
[--subscription]
[--timeout]
[--updated]
Required Parameters
Name of the container service. You can configure the default using az configure --defaults acs=<name>
.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
Polling interval in seconds.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.