az boards area project

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 project command. Learn more about extensions.

Manage areas for a project.

Commands

Name	Description	Type	Status
az boards area project create	Create area.	Extension	GA
az boards area project delete	Delete area.	Extension	GA
az boards area project list	List areas for a project.	Extension	GA
az boards area project show	Show area details for a project.	Extension	GA
az boards area project update	Update area.	Extension	GA

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:\ProjectName\Area\AreaName.

--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 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:\ProjectName\Area\AreaName.

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.

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 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:\ProjectName\Area\AreaName.

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

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

Update area.

Move area or update area name.

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

Required Parameters

--path

Absolute path of an area. Example:\ProjectName\Area\AreaName.

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.

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.