Share via

az boards area team

  • Reference

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 boards area team command. Learn more about extensions.

Manage areas for a team.

Commands

Name Description Type Status
az boards area team add

Add area to a team.

 Extension GA
az boards area team list

List areas for a team.

 Extension GA
az boards area team remove

Remove area from a team.

 Extension GA
az boards area team update

Update team area.

 Extension GA

az boards area team add

Add area to a team.

Every team needs to have a default area configured which can't be empty. Hence, you need to pass --set-as-default while adding first area to your team. You can later configure any other area which already added to team as default by using az boards area team update -h command.

az boards area team add --path
                        --team
                        [--detect {false, true}]
                        [--include-sub-areas {false, true}]
                        [--org]
                        [--project]
                        [--set-as-default]

Examples

Add area to a team.

az boards area team add --team 'ContosoTeam' --path '\ContosoProject\MyProjectAreaName'

Required Parameters

--path

Area path. Example:\ProjectName\AreaName.

--team

The name or id of the team.

Optional Parameters

--detect

Automatically detect organization.

Accepted values: false, true
--include-sub-areas

Include child nodes of this area.

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

--project -p

Name or ID of the project. You can configure the default project using az devops configure -d project=NAME_OR_ID. Required if not configured as default or picked up via git config.

--set-as-default

Set this area path as default area for this team. Default: False.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az boards area team list

List areas for a team.

az boards area team list --team
                         [--detect {false, true}]
                         [--org]
                         [--project]

Required Parameters

--team

The name or id of the team.

Optional Parameters

--detect

Automatically detect organization.

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

--project -p

Name or ID of the project. You can configure the default project using az devops configure -d project=NAME_OR_ID. Required if not configured as default or picked up via git config.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az boards area team remove

Remove area from a team.

az boards area team remove --path
                           --team
                           [--detect {false, true}]
                           [--org]
                           [--project]

Required Parameters

--path

Area path. Example:\ProjectName\AreaName.

--team

The name or id of the team.

Optional Parameters

--detect

Automatically detect organization.

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

--project -p

Name or ID of the project. You can configure the default project using az devops configure -d project=NAME_OR_ID. Required if not configured as default or picked up via git config.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az boards area team update

Update team area.

Update any area to include/exclude sub areas OR Set already added area as default.

az boards area team update --path
                           --team
                           [--detect {false, true}]
                           [--include-sub-areas {false, true}]
                           [--org]
                           [--project]
                           [--set-as-default]

Required Parameters

--path

Area path. Example:\ProjectName\AreaName.

--team

The name or id of the team.

Optional Parameters

--detect

Automatically detect organization.

Accepted values: false, true
--include-sub-areas

Include child nodes of this area.

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

--project -p

Name or ID of the project. You can configure the default project using az devops configure -d project=NAME_OR_ID. Required if not configured as default or picked up via git config.

--set-as-default

Set as default team area path. Default: False.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.