# Group

> Resource Group in pulumi-teamcity.

<!-- Generated from the pulumi-teamcity SDK. -->

Resource Group in pulumi-teamcity.

Pulumi type: `teamcity:index/group:Group`.

`name` is the Pulumi resource name. Nested object fields are documented under that object. They are not arguments of this resource.

## Example

Only required arguments are set. A string in angle brackets stands in for that argument. Any other value is an option or example written in the SDK description.

```ts
import * as teamcity from "pulumi-teamcity"

const resource = new teamcity.Group("group", {})
```

## Arguments

| Property       | Type                  | Required | Description                                                                                   |
| -------------- | --------------------- | -------- | --------------------------------------------------------------------------------------------- |
| `description`  | `string`              | no       | The description for the group. Changing this forces a new resource to be created.             |
| `key`          | `string`              | no       | Custom key (id) for the group. If not provided, TeamCity will generate one based on the name. |
| `name`         | `string`              | no       |                                                                                               |
| `parentGroups` | `string[]`            | no       |                                                                                               |
| `roles`        | `GroupRole (input)[]` | no       |                                                                                               |

## Outputs

Computed outputs are produced by the provider. They are not constructor arguments.

| Property       | Type                   | Computed | Description                                                                                   |
| -------------- | ---------------------- | -------- | --------------------------------------------------------------------------------------------- |
| `description`  | `string`               | no       | The description for the group. Changing this forces a new resource to be created.             |
| `key`          | `string`               | no       | Custom key (id) for the group. If not provided, TeamCity will generate one based on the name. |
| `name`         | `string`               | no       |                                                                                               |
| `parentGroups` | `string[]`             | no       |                                                                                               |
| `roles`        | `GroupRole (output)[]` | no       |                                                                                               |

## `GroupRole (input)`

Input object `GroupRole`. Fields below belong to this object, not to the parent.

| Property  | Type      | Required | Description |
| --------- | --------- | -------- | ----------- |
| `global`  | `boolean` | no       |             |
| `id`      | `string`  | yes      |             |
| `project` | `string`  | no       |             |

## `GroupRole (output)`

Output object `GroupRole`. Fields below belong to this object.

| Property  | Type      | Always present | Description |
| --------- | --------- | -------------- | ----------- |
| `global`  | `boolean` | no             |             |
| `id`      | `string`  | yes            |             |
| `project` | `string`  | no             |             |
