az pipelines agent

Note

This reference is part of the azure-devops extension for the Azure CLI (version 2.30.0 or higher). The extension will automatically install the first time you run an az pipelines agent command. Learn more about extensions.

Manage agents.

Commands

Name	Description	Type	Status
az pipelines agent list	Get a list of agents in a pool.	Extension	GA
az pipelines agent show	Show agent details.	Extension	GA

az pipelines agent list

Get a list of agents in a pool.

az pipelines agent list --pool-id
                        [--agent-name]
                        [--demands]
                        [--detect {false, true}]
                        [--include-assigned-request {false, true}]
                        [--include-capabilities {false, true}]
                        [--include-last-completed-request {false, true}]
                        [--org --organization]

Required Parameters

--pool-id

The agent pool containing the agents.

Optional Parameters

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

--agent-name

Filter on agent name.

--demands

Filter by demands the agents can satisfy. Comma separated list.

--detect

Automatically detect organization.

Property	Value
Accepted values:	false, true

--include-assigned-request

Whether to include details about the agents' current work.

Property	Value
Accepted values:	false, true

--include-capabilities

Whether to include the agents' capabilities in the response.

Property	Value
Accepted values:	false, true

--include-last-completed-request

Whether to include details about the agents' most recent completed work.

Property	Value
Accepted values:	false, true

--org --organization

Azure DevOps organization URL. You can configure the default organization using az devops configure -d organization=ORG_URL. Required if not configured as default or picked up via git config. Example: https://dev.azure.com/MyOrganizationName/.

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 pipelines agent show

Show agent details.

az pipelines agent show --agent-id --id
                        --pool-id
                        [--detect {false, true}]
                        [--include-assigned-request {false, true}]
                        [--include-capabilities {false, true}]
                        [--include-last-completed-request {false, true}]
                        [--org --organization]

Required Parameters

--agent-id --id

The agent ID to get information about.

--pool-id

The agent pool containing the agent.

Optional Parameters

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

--detect

Automatically detect organization.

Property	Value
Accepted values:	false, true

--include-assigned-request

Whether to include details about the agents' current work.

Property	Value
Accepted values:	false, true

--include-capabilities

Whether to include the agents' capabilities in the response.

Property	Value
Accepted values:	false, true

--include-last-completed-request

Whether to include details about the agents' most recent completed work.

Property	Value
Accepted values:	false, true

--org --organization

Azure DevOps organization URL. You can configure the default organization using az devops configure -d organization=ORG_URL. Required if not configured as default or picked up via git config. Example: https://dev.azure.com/MyOrganizationName/.

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