az boards iteration project

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

Manage iterations for a project.

Commands

Name Description Type Status
az boards iteration project create

Create iteration.

 Extension GA
az boards iteration project delete

Delete iteration.

 Extension GA
az boards iteration project list

List iterations for a project.

 Extension GA
az boards iteration project show

Show iteration details for a project.

 Extension GA
az boards iteration project update

Update project iteration.

 Extension GA

az boards iteration project create

Create iteration.

az boards iteration project create --name
                                   [--detect {false, true}]
                                   [--finish-date]
                                   [--org]
                                   [--path]
                                   [--project]
                                   [--start-date]

Required Parameters

--name

Name of the iteration.

Optional Parameters

--detect

Automatically detect organization.

accepted values: false, true
--finish-date

Finish date of the iteration. Example : "2019-06-21".

--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 iteration. Creates an iteration at root level if --path is not specified. Example:\ProjectName\Iteration\IterationName.

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

--start-date

Start date of the iteration. Example : "2019-06-03".

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

Delete iteration.

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

Required Parameters

--path

Absolute path of an iteration. Example:\ProjectName\Iteration\IterationName.

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 iteration project list

List iterations for a project.

az boards iteration 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 iteration. Example:\ProjectName\Iteration\IterationName.

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

Show iteration details for a project.

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

Required Parameters

--id

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

Update project iteration.

Move iteration or update iteration details like name AND/OR start-date and finish-date.

az boards iteration project update --path
                                   [--child-id]
                                   [--detect {false, true}]
                                   [--finish-date]
                                   [--name]
                                   [--org]
                                   [--project]
                                   [--start-date]

Required Parameters

--path

Absolute path of an iteration. Example:\ProjectName\Iteration\IterationName.

Optional Parameters

--child-id

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

--detect

Automatically detect organization.

accepted values: false, true
--finish-date

Finish date of the iteration. Example : "2019-06-21".

--name

New name of the iteration.

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

--start-date

Start date of the iteration. Example : "2019-06-03".

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.