az pipelines agent

Manage agents.

Commands

az pipelines agent list

Get a list of agents in a pool.

az pipelines agent show

Show agent details.

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]
                        [--query-examples]
                        [--subscription]

Required Parameters

--pool-id

The agent pool containing the agents.

Optional Parameters

--agent-name

Filter on agent name.

--demands

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

--detect

Automatically detect organization.

accepted values: false, true
--include-assigned-request

Whether to include details about the agents' current work.

accepted values: false, true
--include-capabilities

Whether to include the agents' capabilities in the response.

accepted values: false, true
--include-last-completed-request

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

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

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

--subscription

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

az pipelines agent show

Show agent details.

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

Required Parameters

--agent-id --id

The agent ID to get information about.

--pool-id

The agent pool containing the agent.

Optional Parameters

--detect

Automatically detect organization.

accepted values: false, true
--include-assigned-request

Whether to include details about the agents' current work.

accepted values: false, true
--include-capabilities

Whether to include the agents' capabilities in the response.

accepted values: false, true
--include-last-completed-request

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

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

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

--subscription

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