agent.yml

### YamlMime:AzureCLIGroup
uid: az_pipelines_agent
name: az pipelines agent
extensionInformation: |-
  > [!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](https://learn.microsoft.com/cli/azure/azure-cli-extensions-overview) about extensions.
summary: |-
  Manage agents.
status: GA
sourceType: Extension
directCommands:
- uid: az_pipelines_agent_list
  name: az pipelines agent list
  summary: |-
    Get a list of agents in a pool.
  status: GA
  sourceType: Extension
  syntax: >-
    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]
  requiredParameters:
  - isRequired: true
    name: --pool-id
    summary: |-
      The agent pool containing the agents.
  optionalParameters:
  - name: --agent-name
    summary: |-
      Filter on agent name.
  - name: --demands
    summary: |-
      Filter by demands the agents can satisfy. Comma separated list.
  - name: --detect
    acceptedValues: false, true
    summary: |-
      Automatically detect organization.
  - name: --include-assigned-request
    acceptedValues: false, true
    summary: |-
      Whether to include details about the agents' current work.
  - name: --include-capabilities
    acceptedValues: false, true
    summary: |-
      Whether to include the agents' capabilities in the response.
  - name: --include-last-completed-request
    acceptedValues: false, true
    summary: |-
      Whether to include details about the agents' most recent completed work.
  - name: --org --organization
    summary: |-
      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/`.
  globalParameters:
  - name: --debug
    defaultValue: "False"
    summary: |-
      Increase logging verbosity to show all debug logs.
  - name: --help -h
    summary: |-
      Show this help message and exit.
  - name: --only-show-errors
    defaultValue: "False"
    summary: |-
      Only show errors, suppressing warnings.
  - name: --output -o
    defaultValue: json
    acceptedValues: json, jsonc, none, table, tsv, yaml, yamlc
    summary: |-
      Output format.
  - name: --query
    summary: |-
      JMESPath query string. See http://jmespath.org/ for more information and examples.
  - name: --subscription
    summary: |-
      Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
  - name: --verbose
    defaultValue: "False"
    summary: |-
      Increase logging verbosity. Use --debug for full debug logs.
- uid: az_pipelines_agent_show
  name: az pipelines agent show
  summary: |-
    Show agent details.
  status: GA
  sourceType: Extension
  syntax: >-
    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]
  requiredParameters:
  - isRequired: true
    name: --agent-id --id
    summary: |-
      The agent ID to get information about.
  - isRequired: true
    name: --pool-id
    summary: |-
      The agent pool containing the agent.
  optionalParameters:
  - name: --detect
    acceptedValues: false, true
    summary: |-
      Automatically detect organization.
  - name: --include-assigned-request
    acceptedValues: false, true
    summary: |-
      Whether to include details about the agents' current work.
  - name: --include-capabilities
    acceptedValues: false, true
    summary: |-
      Whether to include the agents' capabilities in the response.
  - name: --include-last-completed-request
    acceptedValues: false, true
    summary: |-
      Whether to include details about the agents' most recent completed work.
  - name: --org --organization
    summary: |-
      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/`.
  globalParameters:
  - name: --debug
    defaultValue: "False"
    summary: |-
      Increase logging verbosity to show all debug logs.
  - name: --help -h
    summary: |-
      Show this help message and exit.
  - name: --only-show-errors
    defaultValue: "False"
    summary: |-
      Only show errors, suppressing warnings.
  - name: --output -o
    defaultValue: json
    acceptedValues: json, jsonc, none, table, tsv, yaml, yamlc
    summary: |-
      Output format.
  - name: --query
    summary: |-
      JMESPath query string. See http://jmespath.org/ for more information and examples.
  - name: --subscription
    summary: |-
      Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
  - name: --verbose
    defaultValue: "False"
    summary: |-
      Increase logging verbosity. Use --debug for full debug logs.
commands:
- az_pipelines_agent_list
- az_pipelines_agent_show
metadata:
  description: Manage agents.