az acr agentpool

Manage private Tasks agent pools with Azure Container Registries.

Commands

az acr agentpool create

Create an agent pool for an Azure Container Registry.

az acr agentpool delete

Delete an agent pool.

az acr agentpool list

List the agent pools for an Azure Container Registry.

az acr agentpool show

Get the properties of a specified agent pool for an Azure Container Registry.

az acr agentpool update

Update an agent pool for an Azure Container Registry.

az acr agentpool create

Create an agent pool for an Azure Container Registry.

az acr agentpool create --name
                        --registry
                        [--count]
                        [--no-wait]
                        [--os]
                        [--resource-group]
                        [--subnet-id]
                        [--subscription]
                        [--tier]

Examples

Create the agent pool 'MyAgentName' associated with the registry 'MyRegistry'.

az acr agentpool create -n MyAgentName -r MyRegistry

Create the agent pool 'MyAgentName' with 2 agent count.

az acr agentpool create -n MyAgentName -r MyRegistry --count 2

Create the agent pool 'MyAgentName' associated with the registry 'MyRegistry' in VNET subnet.

az acr agentpool create -n MyAgentName -r MyRegistry --subnet-id /subscriptions/<SubscriptionId>/resourceGroups/<ResourceGroupName>/providers/Microsoft.ClassicNetwork/virtualNetworks/<myNetwork>/subnets/<subNet>

Required Parameters

--name -n

The name of the agent pool.

--registry -r

The name of the container registry. You can configure the default registry name using az configure --defaults acr=<registry name>.

Optional Parameters

--count -c

The count of the agent pool.

default value: 1
--no-wait

Do not wait for the Agent Pool to complete action and return immediately after queuing the request.

--os

The os of the agent pool.

default value: Linux
--resource-group -g

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

--subnet-id

The Virtual Network Subnet Resource Id of the agent machine.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--tier

Sets the VM your agent pool will run on. Valid values are: S1(2 vCPUs, 3 GiB RAM), S2(4 vCPUs, 8 GiB RAM), S3(8 vCPUs, 16 GiB RAM) or I6(64 vCPUs, 216 GiB RAM, Isolated).

default value: S1

az acr agentpool delete

Delete an agent pool.

az acr agentpool delete --name
                        --registry
                        [--no-wait]
                        [--resource-group]
                        [--subscription]
                        [--yes]

Examples

Delete the agent pool 'MyAgentName'.

az acr agentpool delete -n MyAgentName -r MyRegistry

Required Parameters

--name -n

The name of the agent pool.

--registry -r

The name of the container registry. You can configure the default registry name using az configure --defaults acr=<registry name>.

Optional Parameters

--no-wait

Do not wait for the Agent Pool to complete action and return immediately after queuing the request.

--resource-group -g

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--yes -y

Do not prompt for confirmation.

az acr agentpool list

List the agent pools for an Azure Container Registry.

az acr agentpool list --registry
                      [--query-examples]
                      [--resource-group]
                      [--subscription]

Examples

List agent pools and show the result in a table.

az acr agentpool list -r MyRegistry -o table

Required Parameters

--registry -r

The name of the container registry. You can configure the default registry name using az configure --defaults acr=<registry name>.

Optional Parameters

--query-examples

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.

--resource-group -g

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az acr agentpool show

Get the properties of a specified agent pool for an Azure Container Registry.

az acr agentpool show --name
                      --registry
                      [--query-examples]
                      [--queue-count]
                      [--resource-group]
                      [--subscription]

Examples

Get the properties of an agent pool, displaying the results in a table.

az acr agentpool show -n MyAgentName -r MyRegistry -o table

Required Parameters

--name -n

The name of the agent pool.

--registry -r

The name of the container registry. You can configure the default registry name using az configure --defaults acr=<registry name>.

Optional Parameters

--query-examples

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.

--queue-count

Get only the queue count.

--resource-group -g

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az acr agentpool update

Update an agent pool for an Azure Container Registry.

az acr agentpool update --name
                        --registry
                        [--count]
                        [--no-wait]
                        [--resource-group]
                        [--subscription]

Examples

Update the agent pool 'MyAgentName' count to 5

az acr agentpool update -n MyAgentName -r MyRegistry --count 5

Required Parameters

--name -n

The name of the agent pool.

--registry -r

The name of the container registry. You can configure the default registry name using az configure --defaults acr=<registry name>.

Optional Parameters

--count -c

The count of the agent pool.

--no-wait

Do not wait for the Agent Pool to complete action and return immediately after queuing the request.

--resource-group -g

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.