Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

az boards area team

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
 [--acquire-policy-token]
 [--change-reference]
 [--detect {false, true}]
 [--include-sub-areas {false, true}]
 [--org --organization]
 [--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

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--detect

Automatically detect organization.

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

Include child nodes of this area.

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

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

Property Value
Default value: False

az boards area team list

List areas for a team.

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

Required Parameters

--team

The name or id of the team.

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

az boards area team remove

Remove area from a team.

az boards area team remove --path
 --team
 [--acquire-policy-token]
 [--change-reference]
 [--detect {false, true}]
 [--org --organization]
 [--project]

Required Parameters

--path

Area path. Example:\ProjectName\AreaName.

--team

The name or id of the team.

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--detect

Automatically detect organization.

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

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

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
 [--acquire-policy-token]
 [--change-reference]
 [--detect {false, true}]
 [--include-sub-areas {false, true}]
 [--org --organization]
 [--project]
 [--set-as-default]

Required Parameters

--path

Area path. Example:\ProjectName\AreaName.

--team

The name or id of the team.

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--detect

Automatically detect organization.

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

Include child nodes of this area.

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

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

Property Value
Default value: False

Feedback

Was this page helpful?