Share via

az acr agentpool

  • Preview

This command group is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage private Tasks agent pools with Azure Container Registries.

Commands

Name Description Type Status
az acr agentpool create

Create an agent pool for an Azure Container Registry.

 Core Preview
az acr agentpool delete

Delete an agent pool.

 Core Preview
az acr agentpool list

List the agent pools for an Azure Container Registry.

 Core Preview
az acr agentpool show

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

 Core Preview
az acr agentpool update

Update an agent pool for an Azure Container Registry.

 Core Preview

az acr agentpool create

Edit
Preview

Command group 'acr agentpool' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create an agent pool for an Azure Container Registry.

az acr agentpool create --name
                        --registry
                        [--count]
                        [--no-wait]
                        [--resource-group]
                        [--subnet-id]
                        [--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. It should be specified in lower case. You can configure the default registry name using az configure --defaults acr=<registry name>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--count -c

The count of the agent pool.

Property Value
Default value: 1
--no-wait

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

Property Value
Default value: False
--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.

--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).

Property Value
Default value: S1
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az acr agentpool delete

Edit
Preview

Command group 'acr agentpool' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete an agent pool.

az acr agentpool delete --name
                        --registry
                        [--no-wait]
                        [--resource-group]
                        [--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. It should be specified in lower case. You can configure the default registry name using az configure --defaults acr=<registry name>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--no-wait

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

Property Value
Default value: False
--resource-group -g

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

--yes -y

Do not prompt for confirmation.

Property Value
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az acr agentpool list

Edit
Preview

Command group 'acr agentpool' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List the agent pools for an Azure Container Registry.

az acr agentpool list --registry
                      [--resource-group]

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. It should be specified in lower case. You can configure the default registry name using az configure --defaults acr=<registry name>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--resource-group -g

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az acr agentpool show

Edit
Preview

Command group 'acr agentpool' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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

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

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. It should be specified in lower case. You can configure the default registry name using az configure --defaults acr=<registry name>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--queue-count

Get only the queue count.

Property Value
Default value: False
--resource-group -g

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az acr agentpool update

Edit
Preview

Command group 'acr agentpool' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update an agent pool for an Azure Container Registry.

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

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. It should be specified in lower case. You can configure the default registry name using az configure --defaults acr=<registry name>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--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.

Property Value
Default value: False
--resource-group -g

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False