Skip to content

Latest commit

 

History

History
80 lines (49 loc) · 2.4 KB

area.html.markdown

File metadata and controls

80 lines (49 loc) · 2.4 KB
layout page_title description
azuredevops
AzureDevops: azuredevops_area
Use this data source to access information about an existing Area (Component) within Azure DevOps.

Data Source: azuredevops_area

Use this data source to access information about an existing Area (Component) within Azure DevOps.

Example Usage

resource "azuredevops_project" "example" {
  name               = "Example Project"
  work_item_template = "Agile"
  version_control    = "Git"
  visibility         = "private"
  description        = "Managed by Terraform"
}

data "azuredevops_area" "example" {
  project_id     = azuredevops_project.example.id
  path           = "/"
  fetch_children = "false"
}

Argument Reference

The following arguments are supported:

  • project_id - (Required) The project ID.

  • path - (Optional) The path to the Area; Format: URL relative; if omitted, or value "/" is used, the root Area will be returned

  • fetch_children - (Optional) Read children nodes, Depth: 1, Default: true

Attributes Reference

The following attributes are exported:

  • id - The id of the Area node

  • name - The name of the Area node

  • has_children - Indicator if an Area node has child nodes

  • children - A list of children blocks as defined below, empty if has_children == false

A children block supports the following:

  • id - The ID of the child Area node

  • name - The name of the child Area node

  • project_id - The ID of project.

  • path - The complete path (in relative URL format) of the child Area

  • has_children - Indicator if the child Area node has child nodes

Relevant Links

Timeouts

The timeouts block allows you to specify timeouts for certain actions:

  • read - (Defaults to 5 minute) Used when retrieving the Area.

PAT Permissions Required

  • Project & Team: vso.work - Grants the ability to read work items, queries, boards, area and iterations paths, and other work item tracking related metadata. Also grants the ability to execute queries, search work items and to receive notifications about work item events via service hooks.