mirror of
https://github.com/ysoftdevs/terraform-provider-bitbucketserver.git
synced 2026-03-28 12:11:49 +01:00
Added docs for data sources
This commit is contained in:
Gavin Bunney
203
README.md
203
README.md
@@ -409,209 +409,6 @@ $ terraform import bitbucketserver_mail_server.mail mail.example.com
|
||||
|
||||
---
|
||||
|
||||
## Data Sources
|
||||
|
||||
|
||||
### Application Properties
|
||||
|
||||
Retrieve version information and other application properties.
|
||||
|
||||
```hcl
|
||||
data "bitbucketserver_application_properties" "main" {}
|
||||
```
|
||||
|
||||
#### Attributes
|
||||
|
||||
* `version` - Version of Bitbucket.
|
||||
* `build_number` - Build number of the Bitbucket instance.
|
||||
* `build_date` - Date the Bitbucket build was made,
|
||||
* `display_name` - Name of the Bitbucket instance.
|
||||
|
||||
|
||||
### Groups
|
||||
|
||||
Retrieve a list of groups, optionally matching the supplied `filter`.
|
||||
|
||||
```hcl
|
||||
data "bitbucketserver_groups" "all" {}
|
||||
```
|
||||
|
||||
* `filter` - Optional. If specified only group names containing the supplied string will be returned.
|
||||
|
||||
#### Attributes
|
||||
|
||||
* `groups` - List of maps containing a `name` key.
|
||||
|
||||
|
||||
### Users
|
||||
|
||||
Retrieve a list of users for a group,optionally matching the supplied `filter`.
|
||||
|
||||
```hcl
|
||||
data "bitbucketserver_group_users" "stash-users" {
|
||||
group = "stash-users"
|
||||
}
|
||||
```
|
||||
|
||||
* `group` - Required. Group to find the users for.
|
||||
* `filter` - Optional. If specified only group names containing the supplied string will be returned.
|
||||
|
||||
#### Attributes
|
||||
|
||||
* `users` - List of users containing `name`, `email_address`, `display_name` and `active` keys.
|
||||
|
||||
|
||||
### Global Permissions - Groups
|
||||
|
||||
Retrieve a list of groups that have been granted at least one global permission.
|
||||
|
||||
```hcl
|
||||
data "bitbucketserver_global_permissions_groups" "all" { }
|
||||
```
|
||||
|
||||
* `filter` - Optional. If specified only group names containing the supplied string will be returned.
|
||||
|
||||
#### Attributes
|
||||
|
||||
* `groups` - List of maps containing `name` and `permission` keys. Available permissions are: `LICENSED_USER`, `PROJECT_CREATE`, `ADMIN`, `SYS_ADMIN`
|
||||
|
||||
|
||||
### Global Permissions - Users
|
||||
|
||||
Retrieve a list of users that have been granted at least one global permission.
|
||||
|
||||
```hcl
|
||||
data "bitbucketserver_global_permissions_users" "proj" { }
|
||||
```
|
||||
|
||||
* `filter` - Optional. If specified only user names containing the supplied string will be returned.
|
||||
|
||||
#### Attributes
|
||||
|
||||
* `users` - List of maps containing `name`, `email_address`, `display_name`, `active` and `permission` keys. Available permissions are: `LICENSED_USER`, `PROJECT_CREATE`, `ADMIN`, `SYS_ADMIN`
|
||||
|
||||
|
||||
### Project Permissions - Groups
|
||||
|
||||
Retrieve a list of groups that have been granted at least one permission for the specified project.
|
||||
|
||||
```hcl
|
||||
data "bitbucketserver_project_permissions_groups" "proj" {
|
||||
project = "TEST"
|
||||
}
|
||||
```
|
||||
|
||||
* `project` - Required. Project Key to lookup permissions for.
|
||||
* `filter` - Optional. If specified only group names containing the supplied string will be returned.
|
||||
|
||||
#### Attributes
|
||||
|
||||
* `groups` - List of maps containing `name` and `permission` keys. Available permissions are: `PROJECT_READ`, `PROJECT_WRITE`, `PROJECT_ADMIN`
|
||||
|
||||
|
||||
### Project Permissions - Users
|
||||
|
||||
Retrieve a list of users that have been granted at least one permission for the specified project.
|
||||
|
||||
```hcl
|
||||
data "bitbucketserver_project_permissions_users" "proj" {
|
||||
project = "TEST"
|
||||
}
|
||||
```
|
||||
|
||||
* `project` - Required. Project Key to lookup permissions for.
|
||||
* `filter` - Optional. If specified only user names containing the supplied string will be returned.
|
||||
|
||||
#### Attributes
|
||||
|
||||
* `users` - List of maps containing `name`, `email_address`, `display_name`, `active` and `permission` keys. Available permissions are: `PROJECT_READ`, `PROJECT_WRITE`, `PROJECT_ADMIN`
|
||||
|
||||
|
||||
### Repository Permissions - Groups
|
||||
|
||||
Retrieve a list of groups that have been granted at least one permission for the specified repository.
|
||||
|
||||
```hcl
|
||||
data "bitbucketserver_project_permissions_groups" "proj" {
|
||||
project = "TEST"
|
||||
repository = "my-repo"
|
||||
}
|
||||
```
|
||||
|
||||
* `project` - Required. Project Key to lookup permissions for.
|
||||
* `repository` - Required. Repository slug to lookup permissions for.
|
||||
* `filter` - Optional. If specified only group names containing the supplied string will be returned.
|
||||
|
||||
#### Attributes
|
||||
|
||||
* `groups` - List of maps containing `name` and `permission` keys. Available permissions are: `REPO_READ`, `REPO_WRITE`, `REPO_ADMIN`
|
||||
|
||||
|
||||
### Repository Permissions - Users
|
||||
|
||||
Retrieve a list of users that have been granted at least one permission for the specified repository.
|
||||
|
||||
```hcl
|
||||
data "bitbucketserver_project_permissions_users" "proj" {
|
||||
project = "TEST"
|
||||
repository = "my-repo"
|
||||
}
|
||||
```
|
||||
|
||||
* `project` - Required. Project Key to lookup permissions for.
|
||||
* `repository` - Required. Repository slug to lookup permissions for.
|
||||
* `filter` - Optional. If specified only user names containing the supplied string will be returned.
|
||||
|
||||
#### Attributes
|
||||
|
||||
* `users` - List of maps containing `name`, `email_address`, `display_name`, `active` and `permission` keys. Available permissions are: `REPO_READ`, `REPO_WRITE`, `REPO_ADMIN`
|
||||
|
||||
|
||||
### Plugin Details
|
||||
|
||||
Retrieve details of an installed plugin.
|
||||
|
||||
```hcl
|
||||
data "bitbucketserver_plugin" "myplugin" {
|
||||
key = "com.atlassian.upm.atlassian-universal-plugin-manager-plugin"
|
||||
}
|
||||
```
|
||||
|
||||
* `key` - Unique key of the plugin.
|
||||
|
||||
#### Attributes
|
||||
|
||||
* `enabled` - Set to `true` if the plugin is enabled.
|
||||
* `enabled_by_default` - Set to `true` if the plugin is enabled by default (for system plugins).
|
||||
* `version` - Installed version of the plugin.
|
||||
* `name` - Name of the plugin.
|
||||
* `description` - Plugin description.
|
||||
* `user_installed` - Set to `true` if this is a user installed plugin vs a system bundled plugin.
|
||||
* `optional` - Set to `true` if this is an optional plugin.
|
||||
* `vendor.name` - Name of the vendor.
|
||||
* `vendor.link` - Vendor homepage.
|
||||
* `vendor.marketplace_link` - Plugin marketplace link.
|
||||
* `applied_license.0.valid` - Is the license valid. true/false.
|
||||
* `applied_license.0.evaluation` - Is the license an evaluation. true/false.
|
||||
* `applied_license.0.nearly_expired` - Is the license nearly expired. true/false.
|
||||
* `applied_license.0.maintenance_expiry_date` - Date of maintenance expiry.
|
||||
* `applied_license.0.maintenance_expired` - Is the maintenance expired. true/false.
|
||||
* `applied_license.0.license_type` - Type of license.
|
||||
* `applied_license.0.expiry_date` - Expiry date of the license.
|
||||
* `applied_license.0.raw_license` - The raw license information.
|
||||
* `applied_license.0.renewable` - Is the license renewabl. true/false.
|
||||
* `applied_license.0.organization_name` - Name of the organization the license is for.
|
||||
* `applied_license.0.enterprise` - Is the license for enterprise. true/false.
|
||||
* `applied_license.0.data_center` - Is the license for data center. true/false.
|
||||
* `applied_license.0.subscription` - Is the license a subscription. true/false.
|
||||
* `applied_license.0.active` - Is the license active. true/false.
|
||||
* `applied_license.0.auto_renewal` - Is the license renewed automatically. true/false.
|
||||
* `applied_license.0.upgradable` - Is the license able to be upgraded. true/false.
|
||||
* `applied_license.0.crossgradeable` - Can the license be crossgraded. true/false.
|
||||
* `applied_license.0.purchase_past_server_cutoff_date` - The purchase date past the server cutoff date. true/false.
|
||||
|
||||
---
|
||||
|
||||
## Development Guide
|
||||
|
||||
### Requirements
|
||||
|
||||
Reference in New Issue
Block a user