Files
terraform-provider-bitbucke…/docusaurus/docs/data_project_hooks.md
2019-10-15 12:00:51 -07:00

58 lines
2.0 KiB
Markdown

---
id: data_bitbucketserver_project_hooks
title: bitbucketserver_project_hooks
---
Retrieve a list of project hooks and their status' for the specified project.
## Example Usage
```hcl
data "bitbucketserver_project_hooks" "main" {
project = "TEST"
}
# data.bitbucketserver_project_hooks.main.hooks = [{
# "key" = "com.atlassian.bitbucket.server.bitbucket-bundled-hooks:force-push-hook",
# "name" = "Reject Force Push",
# "type" = "PRE_RECEIVE",
# "description" = "Reject all force pushes (git push --force) to this repository",
# "version" = "6.7.0",
# "scope_types" = ["PROJECT", "REPOSITORY"],
# "enabled" = "false",
# "configured" = "false",
# "scope_type" = "PROJECT",
# }]
```
### Applying a Custom Filter
Find specific types of project hooks.
```hcl
data "bitbucketserver_project_hooks" "main" {
project = "TEST"
type = "PRE_RECEIVE"
}
```
## Argument Reference
* `project` - Required. Project Key to lookup hooks for.
* `type` - Optional. Type of hook to find. Must be one of `PRE_RECEIVE`, `POST_RECEIVE`
## Attribute Reference
* `hooks` - List of maps containing:
* `key` - Unique key identifying the hook e.g. `com.atlassian.bitbucket.server.bitbucket-bundled-hooks:force-push-hook`
* `name` - Name of the hook e.g. `Reject Force Push`
* `type` - Type of the hook e.g. `PRE_RECEIVE`
* `description` - Detailed description e.g. `Reject all force pushes (git push --force) to this repository`
* `version` - Version of the hook, for system hooks this is the bitbucket version e.g. `6.7.0`
* `scope_types` - List of strings containing the scopes available for this hook, e.g. `["PROJECT", "REPOSITORY"]`
* `enabled` - Set if this hook is enabled for this project
* `configured` - Set if the hook is configured for this project
* `scope_type` - Type of scope applied for this hook, e.g. `PROJECT`
* `scope_resource_id` - Reference ID of the applied scope, e.g. `1`