summaryrefslogtreecommitdiff
path: root/website
diff options
context:
space:
mode:
authorMike Vink <mike1994vink@gmail.com>2023-02-05 19:13:23 +0100
committerMike Vink <mike1994vink@gmail.com>2023-02-28 10:14:28 +0100
commitafb357c9295f969765d7e4c76fbde2bb27224c15 (patch)
treeb9b0ab8b2a67e9cec46ad82a53f776e04d3de2bb /website
parent6e180aae16b3e04cedcf0b5dd33a779072954e63 (diff)
feat: resource_azuredevops_git_repository_branch
Diffstat (limited to 'website')
-rw-r--r--website/docs/r/git_repository_branch.html.markdown78
1 files changed, 78 insertions, 0 deletions
diff --git a/website/docs/r/git_repository_branch.html.markdown b/website/docs/r/git_repository_branch.html.markdown
new file mode 100644
index 00000000..dbf51c59
--- /dev/null
+++ b/website/docs/r/git_repository_branch.html.markdown
@@ -0,0 +1,78 @@
+---
+layout: "azuredevops"
+page_title: "AzureDevops: azuredevops_git_repository_branch"
+description: |-
+ Manages a Git Repository Branch.
+---
+
+# azuredevops_git_repository_branch
+
+Manages a Git Repository Branch.
+
+## Example Usage
+
+```hcl
+resource "azuredevops_project" "example" {
+ name = "Example Project"
+ visibility = "private"
+ version_control = "Git"
+ work_item_template = "Agile"
+}
+
+resource "azuredevops_git_repository" "example" {
+ project_id = azuredevops_project.example.id
+ name = "Example Git Repository"
+ initialization {
+ init_type = "Uninitialized"
+ }
+}
+
+resource "azuredevops_git_repository_branch" "example_orphan" {
+ repository_id = azuredevops_git_repository.example.id
+ name = "master"
+}
+
+resource "azuredevops_git_repository_branch" "example_from_ref" {
+ repository_id = azuredevops_git_repository.example.id
+ name = "develop"
+ source_ref = azuredevops_git_repository_branch.example_orphan.ref
+}
+
+resource "azuredevops_git_repository_branch" "example_from_sha" {
+ repository_id = azuredevops_git_repository.example.id
+ name = "somebranch"
+ source_sha = azuredevops_git_repository_branch.example_orphan.sha
+}
+```
+
+## Arguments Reference
+
+The following arguments are supported:
+
+- `name` - (Required) The name of the branch (not prefixed with `refs/heads/`).
+
+- `repository_id` - (Required) The ID of the repository the branch is created against.
+
+- `source_ref` - (Optional) The ref the branch is created from. (prefixed with `refs/heads/` or `refs/tags/`)
+
+- `source_sha` - (Optional) The commit object id the branch is created from. Set to commit object id of `source_ref` if not given. Otherwise, `source_ref` is ignored.
+
+## Attributes Reference
+
+In addition to the Arguments listed above - the following Attributes are exported:
+
+- `id` - The ID of the Git Repository Branch.
+
+- `is_default_branch` - True if the branch is the default branch of the git repository.
+
+- `ref` - The branch reference in `refs/heads/<name>` format.
+
+- `sha` - The commit SHA1 object id of the branch tip.
+
+## Import
+
+Git Repository Branches can be imported using the `resource id`, e.g.
+
+```shell
+terraform import azuredevops_git_repository_branch.example 00000000-0000-0000-0000-000000000000:master
+```