az boards area team

Manage areas for a team.

Commands

az boards area team add

Add area to a team.

az boards area team list

List areas for a team.

az boards area team remove

Remove area from a team.

az boards area team update

Update team area.

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

Examples

Add area to a team.

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

Required Parameters

--path

Area path. Example:ProjectNameAreaName.

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

--subscription

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

az boards area team list

List areas for a team.

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

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.

--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 boards area team remove

Remove area from a team.

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

Required Parameters

--path

Area path. Example:ProjectNameAreaName.

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

--subscription

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

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

Required Parameters

--path

Area path. Example:ProjectNameAreaName.

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

--subscription

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