az boards area project

Manage areas for a project.

Commands

az boards area project create Create area.
az boards area project delete Delete area.
az boards area project list List areas for a project.
az boards area project show Show area details for a project.
az boards area project update Update area.

az boards area project create

Create area.

az boards area project create --name
[--detect {false, true}]
[--org]
[--path]
[--project]

Required Parameters

--name

Name of the area.

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

--path

Absolute path of an area. Creates an area at root level if --path is not specified. Example:ProjectNameAreaAreaName.

--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 project delete

Delete area.

az boards area project delete --path
[--detect {false, true}]
[--org]
[--project]
[--yes]

Required Parameters

--path

Absolute path of an area. Example:ProjectNameAreaAreaName.

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.

--yes -y

Do not prompt for confirmation.

az boards area project list

List areas for a project.

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

Optional Parameters

--depth

Depth of child nodes to be fetched. Example: --depth 3.

default value: 1
--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/.

--path

Absolute path of an area. Example:ProjectNameAreaAreaName.

--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 project show

Show area details for a project.

az boards area project show --id
[--detect {false, true}]
[--org]
[--project]

Required Parameters

--id

Area ID.

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.

az boards area project update

Update area.

az boards area project update --path
[--child-id]
[--detect {false, true}]
[--name]
[--org]
[--project]

Required Parameters

--path

Absolute path of an area. Example:ProjectNameAreaAreaName.

Optional Parameters

--child-id

Move an existing area and add as child node for this area.

--detect

Automatically detect organization.

accepted values: false, true
--name

New name of the area.

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